From 90db60af1e88501868215cb6d7b6dd99780249de Mon Sep 17 00:00:00 2001 From: Michael Folkerts Date: Fri, 18 Jul 2025 18:23:22 -0700 Subject: [PATCH 1/7] added vibe-coded ESAPI DLL xml to python stubs generator (Claude Sonnet 4) --- README.md | 23 +- stubgen/default_settings.py | 21 +- stubgen/xml_to_stubs.py | 941 ++++++++++++++++++++++++++++++++++++ 3 files changed, 980 insertions(+), 5 deletions(-) create mode 100644 stubgen/xml_to_stubs.py diff --git a/README.md b/README.md index 68783a2..d1194c8 100644 --- a/README.md +++ b/README.md @@ -63,9 +63,30 @@ import pyesapi ``` ## Stub Gen (experimental/under construction) -To create lintable code and enable code completion (in Visual Studio Code at least) we can generate python stubs for ESAPI libs using IronPython... +To create lintable code and enable code completion (in Visual Studio Code at least) we can generate python stubs for ESAPI libs using multiple approaches: + +### Method 1: IronPython Assembly Introspection (Recommended) 1. [Download](https://ironpython.net/download/) and install IronPython (2.7.9 tested to work) in default location (C:\Program Files\IronPython 2.7\ipy.exe). 1. Load ironpython-stubs submodule `git submodule update --init` (ironstubs) 1. Move to stubgen folder `cd stubgen` 1. Execute script `stubgen.ps1` (if you hit a Pdb prompt, type continue) 1. Commit updates to stubs folder + +### Method 2: CHM Documentation Extraction +If you have access to ESAPI CHM help files: +1. Move to stubgen folder `cd stubgen` +1. Run CHM converter: `.\chm_to_stubs.ps1 -ChmPath "C:\Path\To\ESAPI.chm" -OutputDir "chm_stubs"` +1. Review and integrate generated stubs + +See [stubgen/README.md](stubgen/README.md) for detailed instructions. + + +## 2025 Upgrades +* structures masks +* intellisense (stubs for v18, at least) +* HU on CT (non-breaking) +* ImageGeo to pass into _like functions + +## Future +* support model evaluation +* fast approx dose \ No newline at end of file diff --git a/stubgen/default_settings.py b/stubgen/default_settings.py index d52bc12..aa3da34 100644 --- a/stubgen/default_settings.py +++ b/stubgen/default_settings.py @@ -1,21 +1,34 @@ import os +# Support multiple ESAPI versions - adjust these paths as needed PATHS = [ # | ESAPI 15.6 location 'C:\\Program Files (x86)\\Varian\\RTM\\15.6\\esapi\\API', + # | ESAPI 16.x location (uncomment and adjust if you have newer versions) + # 'C:\\Program Files (x86)\\Varian\\RTM\\16.0\\esapi\\API', + # 'C:\\Program Files (x86)\\Varian\\RTM\\16.1\\esapi\\API', ] +# Add any custom ESAPI_PATH from environment +if 'ESAPI_PATH' in os.environ: + PATHS.insert(0, os.environ['ESAPI_PATH']) + ASSEMBLIES = [ - # | System - 'System', # broken? - # 'System.Drawing', + # | System assemblies + 'System', # Note: may have issues, can comment out if problematic + # 'System.Drawing', # Uncomment if needed 'System.Windows', 'System.Collections', 'System.Runtime.InteropServices', + 'System.Xml', # Added for completeness - # | ESAPI + # | ESAPI assemblies (core) 'VMS.TPS.Common.Model.API', 'VMS.TPS.Common.Model.Types', + + # | Additional ESAPI assemblies (uncomment if needed) + # 'VMS.TPS.Common.Model', + # 'VMS.TPS.Common.Interfaces', ] BUILTINS = [ diff --git a/stubgen/xml_to_stubs.py b/stubgen/xml_to_stubs.py new file mode 100644 index 0000000..a2a02b3 --- /dev/null +++ b/stubgen/xml_to_stubs.py @@ -0,0 +1,941 @@ +#!/usr/bin/env python3 +""" +XML Documentation to Python Stub Generator +Generates Python type stubs (.pyi) from .NET XML documentation files + +Usage: + python xml_to_stubs.py [out # Handle malformed generic types like VRect{`0} -> VRect[T] + malformed_generic = re.match(r'([^{<]+)[{<](`+\d+)[}>]', csharp_type) + if malformed_generic: + base_name = malformed_generic.group(1).split('.')[-1] + param_ref = malformed_generic.group(2) + param_num = int(re.search(r'\d+', param_ref).group()) + param_name = 'T' if param_num == 0 else f'T{param_num + 1}' + return f'{base_name}[{param_name}]' + + # Handle full namespace generic types like VMS.TPS.Common.Model.Types.VRect{`0} + namespace_generic = re.match(r'(VMS\.TPS\.Common\.Model\.[^{<]+)[{<](`+\d+)[}>]', csharp_type) + if namespace_generic: + full_type = namespace_generic.group(1) + base_name = full_type.split('.')[-1] + param_ref = namespace_generic.group(2) + param_num = int(re.search(r'\d+', param_ref).group()) + param_name = 'T' if param_num == 0 else f'T{param_num + 1}' + return f'{base_name}[{param_name}]'er] +""" + +import os +import sys +import re +import xml.etree.ElementTree as ET +from pathlib import Path +from typing import Dict, List, Set, Optional, Tuple +from collections import defaultdict + +# Type mappings from C# to Python +TYPE_MAPPINGS = { + 'System.String': 'str', + 'string': 'str', + 'String': 'str', + 'System.Int32': 'int', + 'int': 'int', + 'Int32': 'int', + 'System.Double': 'float', + 'double': 'float', + 'Double': 'Double', # Keep as .NET type for array handling + 'System.Single': 'float', + 'single': 'float', + 'Single': 'Single', # Keep as .NET type for array handling + 'System.Boolean': 'bool', + 'bool': 'bool', + 'Boolean': 'Boolean', # Keep as .NET type for array handling + 'void': 'None', + 'System.Void': 'None', + 'object': 'Any', + 'System.Object': 'Any', + 'Object': 'Any', + 'System.DateTime': 'datetime', + 'DateTime': 'datetime', + 'System.Collections.Generic.IEnumerable': 'List', + 'IEnumerable': 'List', + 'System.Collections.Generic.ICollection': 'List', + 'ICollection': 'List', + 'System.Collections.Generic.List': 'List', + 'List': 'List', + 'System.Array': 'Array', + 'Array': 'Array', +} + +class XmlApiElement: + """Represents a .NET API element parsed from XML documentation""" + + def __init__(self, member_name: str, element_type: str): + self.member_name = member_name # Full member name like "T:VMS.TPS.Common.Model.API.AddOn" + self.element_type = element_type # T, P, M, F, E + self.namespace = "" + self.class_name = "" + self.name = "" + self.return_type = "Any" + self.parameters: List[Dict] = [] + self.summary = "" + self.remarks = "" + self.inheritance = [] + self.param_descriptions = {} # Parameter descriptions from XML + + self._parse_member_name() + + def _parse_member_name(self): + """Parse the member name to extract namespace, class, and element info""" + # Remove the prefix (T:, P:, M:, F:) + full_name = self.member_name[2:] # Remove "T:", "P:", etc. + + if self.element_type == 'T': # Type (class, interface, enum) + # For types, the last part is the class name + parts = full_name.split('.') + self.namespace = '.'.join(parts[:-1]) + self.class_name = parts[-1] + self.name = parts[-1] + elif self.element_type == 'M': # Method + # Methods have parameters in parentheses + if '(' in full_name: + method_part, params_part = full_name.split('(', 1) + params_part = params_part.rstrip(')') + + # Parse method name and class + method_parts = method_part.split('.') + self.name = method_parts[-1] + + # Handle constructor first (before interface cleanup) + if self.name == '#ctor': + self.name = '__init__' + elif '#' in self.name: + # Clean up explicit interface implementation names (remove Interface#Method -> Method) + # For explicit interface implementations like "System#Collections#IEnumerable#GetEnumerator" + # Extract just the method name after the last # + # Special case: #ctor should become __init__, not ctor + method_name = self.name.split('#')[-1] + if method_name == 'ctor': + self.name = '__init__' + else: + self.name = method_name + + # Remove C# method overload suffixes (``1, ``2, etc.) + if '``' in self.name: + self.name = self.name.split('``')[0] + + if len(method_parts) > 1: + self.class_name = method_parts[-2] + self.namespace = '.'.join(method_parts[:-2]) + + # Parse parameters + if params_part.strip(): + param_types = self._parse_parameter_types(params_part) + for i, param_type in enumerate(param_types): + self.parameters.append({ + 'name': f'param{i+1}', + 'type': self._convert_csharp_type_to_python(param_type), + 'csharp_type': param_type + }) + else: + # Method without parameters + parts = full_name.split('.') + self.name = parts[-1] + + # Handle constructor first (before interface cleanup) + if self.name == '#ctor': + self.name = '__init__' + elif '#' in self.name: + # Clean up explicit interface implementation names (remove Interface#Method -> Method) + # For explicit interface implementations like "System#Collections#IEnumerable#GetEnumerator" + # Extract just the method name after the last # + # Special case: #ctor should become __init__, not ctor + method_name = self.name.split('#')[-1] + if method_name == 'ctor': + self.name = '__init__' + else: + self.name = method_name + + # Remove C# method overload suffixes (``1, ``2, etc.) + if '``' in self.name: + self.name = self.name.split('``')[0] + + if len(parts) > 1: + self.class_name = parts[-2] + self.namespace = '.'.join(parts[:-2]) + else: + # Properties and Fields + parts = full_name.split('.') + self.name = parts[-1] + + # Handle constructor first (before interface cleanup) + if self.name == '#ctor': + self.name = '__init__' + elif '#' in self.name: + # Clean up explicit interface implementation names (remove Interface#Method -> Method) + # For explicit interface implementations like "System#Collections#IEnumerable#GetEnumerator" + # Extract just the method name after the last # + # Special case: #ctor should become __init__, not ctor + method_name = self.name.split('#')[-1] + if method_name == 'ctor': + self.name = '__init__' + else: + self.name = method_name + + # Remove C# method overload suffixes (``1, ``2, etc.) + if '``' in self.name: + self.name = self.name.split('``')[0] + + if len(parts) > 1: + self.class_name = parts[-2] + self.namespace = '.'.join(parts[:-2]) + + def _parse_parameter_types(self, params_str: str) -> List[str]: + """Parse parameter types from method signature""" + if not params_str.strip(): + return [] + + # Handle generic types and nested commas - work with original curly braces + params = [] + current_param = "" + bracket_depth = 0 + + for char in params_str + ',': # Add comma at end to process last param + if char in '<{': + bracket_depth += 1 + current_param += char + elif char in '>}': + bracket_depth -= 1 + current_param += char + elif char == ',' and bracket_depth == 0: + if current_param.strip(): + params.append(current_param.strip()) + current_param = "" + else: + current_param += char + + return params + + def _convert_csharp_type_to_python(self, csharp_type: str, preserve_net_types: bool = False) -> str: + """Convert C# type to Python type""" + # Remove ref/out keywords + csharp_type = re.sub(r'\b(ref|out)\s+', '', csharp_type) + + # Handle curly braces in the entire string recursively + while '{' in csharp_type and '}' in csharp_type: + csharp_type = csharp_type.replace('{', '<').replace('}', '>') + + # Handle C# generic type syntax with backticks (e.g., VRect`1 -> VRect[T]) + # Only match when backtick immediately follows the class name (not inside angle brackets) + if '`' in csharp_type and '<' not in csharp_type: + match = re.match(r'([^`]+)`(\d+)', csharp_type) + if match: + base_name = match.group(1).split('.')[-1] # Get just the class name + type_param_count = int(match.group(2)) + + # Generate generic type parameters + if type_param_count == 1: + return f'{base_name}[T]' + else: + type_params = [f'T{i+1}' for i in range(type_param_count)] + return f'{base_name}[{", ".join(type_params)}]' + + # Handle C# generic type parameter references like `0, `1, ``0, ``1, etc. + if re.match(r'^`+\d+$', csharp_type): + # Extract the number after all the backticks + param_num = int(re.search(r'\d+', csharp_type).group()) + if param_num == 0: + return 'T' + else: + return f'T{param_num + 1}' + + # Handle malformed generic types like VRect{`0} or VRect<`0> -> VRect[T] + malformed_generic = re.match(r'([^{<]+)[{<](`*\d+)[}>]', csharp_type) + if malformed_generic: + base_name = malformed_generic.group(1).split('.')[-1] + param_ref = malformed_generic.group(2) + param_num = int(re.search(r'\d+', param_ref).group()) + param_name = 'T' if param_num == 0 else f'T{param_num + 1}' + return f'{base_name}[{param_name}]' + + # Handle array types first (before generic handling) + if '[]' in csharp_type: + # Count array dimensions + array_count = csharp_type.count('[]') + base_type = csharp_type.replace('[]', '') + + # Convert the base type, preserving .NET types for arrays + python_base_type = self._convert_csharp_type_to_python(base_type, preserve_net_types=True) + + # Handle different array dimensions + if array_count == 1: + # Single-dimensional array: Type[] -> Array[Type] + return f'Array[{python_base_type}]' + elif array_count == 2: + # Jagged array: Type[][] -> Array[Array[Type]] + return f'Array[Array[{python_base_type}]]' + else: + # For higher dimensions, keep nesting Array types + result = python_base_type + for _ in range(array_count): + result = f'Array[{result}]' + return result + + # Handle generic types + if '<' in csharp_type and '>' in csharp_type: + # Extract generic base type and arguments + match = re.match(r'([^<]+)<(.+)>', csharp_type) + if match: + base_type = match.group(1) + generic_args = match.group(2) + + # Convert collection types to Python equivalents + if base_type in ['System.Collections.Generic.List', 'System.Collections.Generic.IList', + 'System.Collections.Generic.ICollection', 'System.Collections.Generic.IEnumerable']: + arg_type = self._convert_csharp_type_to_python(generic_args, preserve_net_types) + return f'List[{arg_type}]' + elif base_type in ['System.Collections.Generic.Dictionary', 'System.Collections.Generic.IDictionary']: + # Handle Dictionary + args = self._parse_parameter_types(generic_args) + if len(args) >= 2: + key_type = self._convert_csharp_type_to_python(args[0], preserve_net_types) + value_type = self._convert_csharp_type_to_python(args[1], preserve_net_types) + return f'Dict[{key_type}, {value_type}]' + elif base_type == 'System.Nullable': + arg_type = self._convert_csharp_type_to_python(generic_args, preserve_net_types) + return f'Optional[{arg_type}]' + else: + # For other generic types, preserve the .NET type with Python syntax + # Convert the argument types recursively + args = self._parse_parameter_types(generic_args) + converted_args = [self._convert_csharp_type_to_python(arg, preserve_net_types) for arg in args] + # Extract just the class name from the base type + if '.' in base_type: + base_name = base_type.split('.')[-1] + else: + base_name = base_type + return f'{base_name}[{", ".join(converted_args)}]' + + # For array element types, preserve .NET type names + if preserve_net_types: + net_type_mappings = { + 'System.Double': 'Double', + 'Double': 'Double', + 'System.Single': 'Single', + 'Single': 'Single', + 'System.Int32': 'Int32', + 'Int32': 'Int32', + 'System.Boolean': 'Boolean', + 'Boolean': 'Boolean', + 'System.String': 'String', + 'String': 'String', + } + if csharp_type in net_type_mappings: + return net_type_mappings[csharp_type] + + # Direct type mappings + if csharp_type in TYPE_MAPPINGS: + return TYPE_MAPPINGS[csharp_type] + + # Handle VMS types - extract just the class name + if csharp_type.startswith('VMS.TPS.Common.Model'): + parts = csharp_type.split('.') + return parts[-1] # Return just the class name + + # Handle System types + if csharp_type.startswith('System.'): + system_type = csharp_type.replace('System.', '') + return TYPE_MAPPINGS.get(system_type, system_type) + + # For unknown types, extract the last part (class name) + if '.' in csharp_type: + parts = csharp_type.split('.') + return parts[-1] + + return csharp_type + + def get_qualified_name(self) -> str: + """Get the fully qualified name""" + if self.namespace: + return f"{self.namespace}.{self.class_name}.{self.name}" + else: + return f"{self.class_name}.{self.name}" + + def __repr__(self): + return f"XmlApiElement(name='{self.name}', type='{self.element_type}', class='{self.class_name}', namespace='{self.namespace}')" + +class XmlDocumentationParser: + """Parser for .NET XML documentation files""" + + def __init__(self): + self.elements: List[XmlApiElement] = [] + self.types_by_namespace: Dict[str, List[XmlApiElement]] = defaultdict(list) + self.members_by_class: Dict[str, List[XmlApiElement]] = defaultdict(list) + + def parse_xml_file(self, xml_file: str) -> List[XmlApiElement]: + """Parse XML documentation file and extract API elements""" + if not os.path.exists(xml_file): + print(f"XML file not found: {xml_file}") + return [] + + print(f"Parsing XML file: {xml_file}") + + try: + tree = ET.parse(xml_file) + root = tree.getroot() + + # Find the members section + members = root.find('members') + if members is None: + print("No members section found in XML") + return [] + + elements = [] + for member in members.findall('member'): + name = member.get('name', '') + if not name: + continue + + # Determine element type from prefix + element_type = name[0] if name else 'T' + + element = XmlApiElement(name, element_type) + + # Extract documentation + summary = member.find('summary') + if summary is not None: + element.summary = self._clean_text(summary.text or "") + + remarks = member.find('remarks') + if remarks is not None: + element.remarks = self._clean_text(remarks.text or "") + + # Extract parameters for methods + if element_type == 'M': + params = member.findall('param') + xml_param_info = {} + for param in params: + param_name = param.get('name', '') + param_desc = self._clean_text(param.text or "") + xml_param_info[param_name] = param_desc + + # Update parameter names and descriptions from XML if available + if xml_param_info and element.parameters: + for i, param in enumerate(element.parameters): + xml_name = list(xml_param_info.keys())[i] if i < len(xml_param_info) else None + if xml_name: + param['name'] = xml_name + param['description'] = xml_param_info[xml_name] + + # Store parameter info for methods without parsed parameters + element.param_descriptions = xml_param_info + + elements.append(element) + self.elements.append(element) + + print(f"Found {len(elements)} API elements") + self._organize_elements() + + return elements + + except ET.ParseError as e: + print(f"Error parsing XML file: {e}") + return [] + + def _clean_text(self, text: str) -> str: + """Clean and format documentation text""" + if not text: + return "" + + # Remove extra whitespace and normalize + text = re.sub(r'\s+', ' ', text.strip()) + + # Remove XML comments and tags + text = re.sub(r'', '', text) + text = re.sub(r'', '', text) + text = re.sub(r'<[^>]+>', '', text) + + return text.strip() + + def _organize_elements(self): + """Organize elements by namespace and class for easier stub generation""" + for element in self.elements: + # Group by namespace + self.types_by_namespace[element.namespace].append(element) + + # Group members by their parent class + if element.element_type in ['P', 'M', 'F']: # Properties, Methods, Fields + class_key = f"{element.namespace}.{element.class_name}".strip('.') + self.members_by_class[class_key].append(element) + elif element.element_type == 'T' and '.' in element.name: + # Handle nested types like VVector.Component + parent_class = element.name.split('.')[0] + parent_key = f"{element.namespace}.{parent_class}".strip('.') + # Treat nested types as members of their parent class for now + # This could be improved to handle them as actual nested classes + element.element_type = 'NT' # Nested Type + self.members_by_class[parent_key].append(element) + +class XmlStubGenerator: + """Generates Python stub files from XML documentation""" + + def __init__(self, parser: XmlDocumentationParser): + self.parser = parser + + def generate_stubs(self, output_dir: str): + """Generate Python stub files organized by namespace""" + output_path = Path(output_dir) + output_path.mkdir(exist_ok=True) + + print(f"Generating stubs in {output_dir}") + + # Generate stubs for each namespace + for namespace, elements in self.parser.types_by_namespace.items(): + if not namespace: # Skip empty namespace + continue + + self._generate_namespace_stubs(namespace, elements, output_path) + + print(f"Stub generation complete!") + print(f"Namespaces generated: {len(self.parser.types_by_namespace)}") + print(f"Total elements: {len(self.parser.elements)}") + + def _generate_namespace_stubs(self, namespace: str, elements: List[XmlApiElement], base_path: Path): + """Generate stub files for a specific namespace""" + # Create directory structure + namespace_parts = namespace.split('.') + current_path = base_path + + for part in namespace_parts: + current_path = current_path / part + current_path.mkdir(exist_ok=True) + + # Create __init__.py + init_file = current_path / "__init__.py" + if not init_file.exists(): + init_file.write_text("") + + # Group elements by type + types = [e for e in elements if e.element_type == 'T'] + + if types: + # Generate main module file + module_file = current_path / f"{namespace_parts[-1]}.pyi" + self._write_module_stub(module_file, namespace, types) + + def _write_module_stub(self, file_path: Path, namespace: str, types: List[XmlApiElement]): + """Write a module stub file with classes and their members""" + with open(file_path, 'w', encoding='utf-8') as f: + # Write header + f.write('"""\n') + f.write(f'Type stubs for {namespace}\n') + f.write('Generated from .NET XML documentation\n') + f.write('"""\n\n') + + # Collect all type references used in this module + type_references = self._collect_type_references(types, namespace) + + # Check if we need TypeVar and Generic for generic classes + has_generics = any('`' in element.name for element in types) + + # Check if we need overload for classes with multiple constructors + has_overloads = self._has_constructor_overloads(types, namespace) + + # Write basic imports + imports = ["Any", "List", "Optional", "Union", "Dict", "Iterable"] + if has_generics: + imports.extend(["TypeVar", "Generic"]) + if has_overloads: + imports.append("overload") + + f.write(f"from typing import {', '.join(imports)}\n") + f.write("from datetime import datetime\n") + f.write("from System import Array, Double, Single, Int32, Boolean, String\n") + + # Write TypeVar declarations for generic classes + if has_generics: + f.write("\n# Generic type variables\n") + f.write("T = TypeVar('T')\n") + f.write("T1 = TypeVar('T1')\n") + f.write("T2 = TypeVar('T2')\n") + f.write("T3 = TypeVar('T3')\n") + + # Write type imports + if type_references: + f.write("\n# Type imports\n") + for import_line in sorted(type_references): + f.write(f"{import_line}\n") + + f.write("\n") + + # Write common array type aliases + f.write("# Common array type aliases for Python.NET\n") + f.write("DoubleArray = Array[Double]\n") + f.write("SingleArray = Array[Single]\n") + f.write("IntArray = Array[Int32]\n") + f.write("BoolArray = Array[Boolean]\n") + f.write("StringArray = Array[String]\n") + f.write("DoubleJaggedArray = Array[DoubleArray]\n") + f.write("SingleJaggedArray = Array[SingleArray]\n") + + f.write("\n") + + # Write each type + for type_element in types: + self._write_type_stub(f, type_element) + f.write("\n") + + def _collect_type_references(self, types: List[XmlApiElement], current_namespace: str) -> set: + """Collect all type references that need to be imported""" + imports = set() + + # Get all members for types in this namespace + for type_element in types: + class_key = f"{type_element.namespace}.{type_element.name}".strip('.') + members = self.parser.members_by_class.get(class_key, []) + + # Check type references in method parameters + for member in members: + if member.element_type == 'M': # Methods + for param in member.parameters: + param_type = param.get('csharp_type', '') + import_stmt = self._get_import_for_type(param_type, current_namespace) + if import_stmt: + imports.add(import_stmt) + + # For properties, check for explicit type references in documentation + elif member.element_type == 'P': # Properties + # Look for type references in the summary + if member.summary: + # Look for explicit type references like "See " + type_matches = re.findall(r' bool: + """Check if any class in this module has multiple constructors requiring @overload""" + for type_element in types: + class_key = f"{type_element.namespace}.{type_element.name}".strip('.') + members = self.parser.members_by_class.get(class_key, []) + + # Count constructors for this class + constructors = [m for m in members if m.element_type == 'M' and m.name == '__init__'] + if len(constructors) > 1: + return True + + return False + + def _get_import_for_type(self, csharp_type: str, current_namespace: str) -> str: + """Generate import statement for a C# type if needed""" + if not csharp_type or csharp_type in ['System.String', 'System.Boolean', 'System.Int32', 'System.Double', 'System.Single', 'System.Void', 'System.Object']: + return None + + # Clean up curly braces first + clean_type = csharp_type.replace('{', '<').replace('}', '>') + + # Clean up the type name - remove generic parameters and array notation + clean_type = re.sub(r'<.*?>', '', clean_type) # Remove generics like List + clean_type = re.sub(r'\[\]', '', clean_type) # Remove array notation + clean_type = clean_type.strip() + + # Don't try to import array types or basic system types + if clean_type.endswith('[]') or clean_type.startswith('Array['): + return None + + # Handle VMS.TPS types + if clean_type.startswith('VMS.TPS.Common.Model'): + # Extract the namespace and class name + parts = clean_type.split('.') + if len(parts) < 2: + return None + + type_namespace = '.'.join(parts[:-1]) + class_name = parts[-1] + + # Don't import from the same namespace + if type_namespace == current_namespace: + return None + + # Convert namespace to import path + if type_namespace == 'VMS.TPS.Common.Model.Types': + if current_namespace == 'VMS.TPS.Common.Model.API': + return f"from ..Types.Types import {class_name}" + else: + return f"from .Types import {class_name}" + elif type_namespace == 'VMS.TPS.Common.Model.API': + if current_namespace == 'VMS.TPS.Common.Model.Types': + return f"from ..API.API import {class_name}" + else: + return f"from .API import {class_name}" + + return None + + def _write_type_stub(self, f, type_element: XmlApiElement): + """Write a stub for a single type (class/interface/enum)""" + # Convert the class name to handle generics + class_name = type_element._convert_csharp_type_to_python(type_element.name) + + # Write class definition + f.write(f"class {class_name}") + + # Handle inheritance - for generic classes, inherit from Generic + inheritance_list = [] + if '`' in type_element.name: + # This is a generic class, add Generic[T] to inheritance + if '[T]' in class_name: + inheritance_list.append("Generic[T]") + elif '[T1' in class_name: + # Multiple type parameters + type_params = [] + if 'T1' in class_name: + type_params.append('T1') + if 'T2' in class_name: + type_params.append('T2') + if 'T3' in class_name: + type_params.append('T3') + inheritance_list.append(f"Generic[{', '.join(type_params)}]") + + if type_element.inheritance: + inheritance_list.extend(type_element.inheritance) + + if inheritance_list: + f.write(f"({', '.join(inheritance_list)})") + f.write(":\n") + + # Get members for this class + class_key = f"{type_element.namespace}.{type_element.class_name}".strip('.') + members = self.parser.members_by_class.get(class_key, []) + + # Write class docstring with Google style format + if type_element.summary or members: + f.write(' """\n') + if type_element.summary: + f.write(f' {type_element.summary}\n') + + # Add attributes section for properties + properties = [m for m in members if m.element_type == 'P'] + if properties: + f.write('\n Attributes:\n') + for prop in properties: + prop_type = self._infer_property_type(prop.name, prop.summary) + if prop.summary: + f.write(f' {prop.name} ({prop_type}): {prop.summary}\n') + else: + f.write(f' {prop.name} ({prop_type}): Property value.\n') + + if type_element.remarks: + f.write(f'\n Note:\n {type_element.remarks}\n') + f.write(' """\n') + + if not members: + # Empty class + f.write(" def __init__(self) -> None: ...\n") + else: + # Write constructors first + constructors = [m for m in members if m.element_type == 'M' and m.name == '__init__'] + if constructors: + # Only add @overload decorator if there are multiple constructors + has_multiple_constructors = len(constructors) > 1 + for ctor in constructors: + self._write_method_stub(f, ctor, has_multiple_constructors) + f.write("\n") + else: + # No explicit constructors found, write default one + f.write(" def __init__(self) -> None: ...\n\n") + + # Write properties + properties = [m for m in members if m.element_type == 'P'] + for prop in properties: + self._write_property_stub(f, prop) + f.write("\n") + + # Write nested types + nested_types = [m for m in members if m.element_type == 'NT'] + for nested_type in nested_types: + self._write_nested_type_stub(f, nested_type) + f.write("\n") + + # Write methods (excluding constructors, getters, and setters) + methods = [m for m in members if m.element_type == 'M' and not m.name.startswith('get_') and not m.name.startswith('set_') and m.name != '__init__'] + for method in methods: + self._write_method_stub(f, method) + f.write("\n") + + def _write_property_stub(self, f, prop: XmlApiElement): + """Write a property stub""" + # Skip individual comments since they're now in the class docstring + + # Try to infer type from property name and summary + prop_type = self._infer_property_type(prop.name, prop.summary) + f.write(f' {prop.name}: {prop_type}\n') + + def _infer_property_type(self, prop_name: str, summary: str) -> str: + """Infer property type from name and summary""" + prop_name_lower = prop_name.lower() + summary_lower = summary.lower() if summary else "" + + # Date/time properties + if any(word in prop_name_lower for word in ['date', 'time', 'datetime', 'created', 'modified']): + return 'datetime' + + # Boolean properties + if (prop_name_lower.startswith('is') or prop_name_lower.startswith('has') or + prop_name_lower.startswith('can') or prop_name_lower.startswith('should') or + any(word in summary_lower for word in ['true', 'false', 'boolean', 'whether'])): + return 'bool' + + # String properties + if (any(word in prop_name_lower for word in ['name', 'text', 'description', 'comment', 'note', 'id', 'uid']) or + any(word in summary_lower for word in ['string', 'text', 'name', 'identifier'])): + return 'str' + + # Numeric properties + if (any(word in prop_name_lower for word in ['count', 'number', 'size', 'length', 'width', 'height', 'dose', 'value']) or + any(word in summary_lower for word in ['number', 'count', 'value', 'dose', 'percentage'])): + if 'dose' in prop_name_lower or 'dose' in summary_lower: + return 'DoseValue' # Specific ESAPI type + return 'float' + + # Collection properties + if (prop_name.endswith('s') and not prop_name.endswith('Status') and + any(word in summary_lower for word in ['collection', 'list', 'array', 'enumerable'])): + return 'List[Any]' + + # Look for type references in summary (e.g., "See ") + type_match = re.search(r' None:\n') + else: + f.write(f' def {method.name}(self{param_str}) -> {return_type}:\n') + + # Add Google style docstring with parameter descriptions if available + param_docs = [] + if hasattr(method, 'param_descriptions') and method.param_descriptions: + for param in method.parameters: + param_name = param['name'] + if param_name in method.param_descriptions and method.param_descriptions[param_name]: + param_docs.append(f" {param_name}: {method.param_descriptions[param_name]}") + + if param_docs: + f.write(' """\n') + f.write(" Args:\n") + f.write('\n'.join(param_docs) + '\n') + f.write(' """\n') + f.write(" ...\n\n") + else: + f.write(" ...\n\n") + + def _write_nested_type_stub(self, f, nested_type: XmlApiElement): + """Write a nested type (like enum or inner class)""" + # Extract the nested type name (e.g., "Component" from "VVector.Component") + nested_name = nested_type.name.split('.')[-1] + + if nested_type.summary: + f.write(f' # {nested_type.summary}\n') + + f.write(f' class {nested_name}:\n') + if nested_type.summary: + f.write(' """\n') + f.write(f' {nested_type.summary}\n') + f.write(' """\n') + f.write(' pass\n') + + def _infer_type_from_summary(self, summary: str) -> str: + """Infer type from summary text""" + if not summary: + return "Any" + + summary_lower = summary.lower() + + # Common type patterns + if 'string' in summary_lower or 'text' in summary_lower: + return 'str' + elif 'number' in summary_lower or 'count' in summary_lower or 'size' in summary_lower: + return 'int' + elif 'date' in summary_lower or 'time' in summary_lower: + return 'datetime' + elif 'bool' in summary_lower or 'whether' in summary_lower or 'indicates' in summary_lower: + return 'bool' + elif 'list' in summary_lower or 'collection' in summary_lower or 'array' in summary_lower: + return 'List[Any]' + + return "Any" + + def _infer_return_type_from_summary(self, summary: str) -> str: + """Infer return type from method summary""" + if not summary: + return "Any" + + summary_lower = summary.lower() + + if 'returns' in summary_lower: + # Try to extract type info after "returns" + if 'string' in summary_lower: + return 'str' + elif 'bool' in summary_lower or 'whether' in summary_lower: + return 'bool' + elif 'number' in summary_lower or 'count' in summary_lower: + return 'int' + + # Method name patterns + if summary_lower.startswith('gets') or summary_lower.startswith('retrieves'): + return self._infer_type_from_summary(summary) + elif summary_lower.startswith('sets') or summary_lower.startswith('converts'): + return 'None' + + return "Any" + +def main(): + if len(sys.argv) < 2: + print("Usage: python xml_to_stubs.py [output_folder]") + sys.exit(1) + + xml_file = sys.argv[1] + output_folder = sys.argv[2] if len(sys.argv) > 2 else "xml_stubs" + + # Parse XML documentation + parser = XmlDocumentationParser() + elements = parser.parse_xml_file(xml_file) + + if not elements: + print("No elements found in XML file") + sys.exit(1) + + # Generate stubs + generator = XmlStubGenerator(parser) + generator.generate_stubs(output_folder) + +if __name__ == "__main__": + main() From 2566b1731cd2bf86daeed09ea9aaea1f74399fbd Mon Sep 17 00:00:00 2001 From: Michael Folkerts Date: Mon, 21 Jul 2025 11:04:03 -0700 Subject: [PATCH 2/7] improvements to stub generation, supplimenting XML documentation with DLL introspection --- pyesapi/VMS/TPS/Common/Model/API/API.pyi | 28349 ++++++++++++++++ .../Common/Model/API/AsyncPump/AsyncPump.pyi | 211 + .../Common/Model/API/AsyncPump/__init__.pyi} | 0 .../Model/API/Calculation/Calculation.pyi | 39 + .../Common/Model/API/Calculation/__init__.pyi | 0 .../API/ControlPointCollection/__init__.pyi | 0 .../IonControlPointCollection/__init__.pyi | 0 .../__init__.pyi | 0 .../Model/API/IonSpotCollection/__init__.pyi | 0 .../IonSpotParametersCollection/__init__.pyi | 0 .../API/StructureCodeDictionary/__init__.pyi | 0 pyesapi/VMS/TPS/Common/Model/API/__init__.pyi | 0 .../Model/Types/DoseValue/DoseValue.pyi | 18 + .../Common/Model/Types/DoseValue/__init__.pyi | 0 .../Types/DoseValueDisplayConfig/__init__.pyi | 0 .../Model/Types/LineProfile/__init__.pyi | 0 .../PlanValidationResultDetail.pyi | 18 + .../PlanValidationResultDetail/__init__.pyi | 0 .../Model/Types/SegmentProfile/__init__.pyi | 0 pyesapi/VMS/TPS/Common/Model/Types/Types.pyi | 2468 ++ .../TPS/Common/Model/Types/__init__.pyi | 0 .../Item(VMS/TPS/Common/Model/__init__.pyi | 0 .../VVector/Item(VMS/TPS/Common/__init__.pyi | 0 .../Types/VVector/Item(VMS/TPS/__init__.pyi | 0 .../Model/Types/VVector/Item(VMS/__init__.pyi | 0 .../Common/Model/Types/VVector/VVector.pyi | 18 + .../Common/Model/Types/VVector/__init__.pyi | 0 .../VMS/TPS/Common/Model/Types/__init__.pyi | 0 pyesapi/VMS/TPS/Common/Model/__init__.pyi | 0 pyesapi/VMS/TPS/Common/__init__.pyi | 0 pyesapi/VMS/TPS/Version/Version.pyi | 29 + pyesapi/VMS/TPS/Version/__init__.pyi | 0 pyesapi/VMS/TPS/__init__.pyi | 0 pyesapi/VMS/__init__.pyi | 0 pyesapi/VMS/py.typed | 0 pyesapi/stubs/Microsoft/CSharp.py | 142 - pyesapi/stubs/Microsoft/VisualBasic.py | 149 - pyesapi/stubs/Microsoft/Win32/SafeHandles.py | 537 - pyesapi/stubs/Microsoft/Win32/__init__.py | 1727 - pyesapi/stubs/Microsoft/__init__.py | 11 - pyesapi/stubs/System/Array.py | 2 - .../stubs/System/Collections/Concurrent.py | 947 - pyesapi/stubs/System/Collections/Generic.py | 2726 -- .../stubs/System/Collections/ObjectModel.py | 721 - .../stubs/System/Collections/Specialized.py | 1863 - pyesapi/stubs/System/Collections/__init__.py | 2796 -- pyesapi/stubs/System/Configuration.py | 3565 -- pyesapi/stubs/System/Double.py | 2 - pyesapi/stubs/System/Int32.py | 2 - pyesapi/stubs/System/Media.py | 242 - pyesapi/stubs/System/Runtime/__init__.py | 210 - pyesapi/stubs/System/Timers.py | 296 - pyesapi/stubs/System/Type/__init__.py | 5 - pyesapi/stubs/System/Web.py | 209 - pyesapi/stubs/System/Windows/Input.py | 29 - pyesapi/stubs/System/Windows/Markup.py | 38 - pyesapi/stubs/System/Windows/__init__.py | 11 - pyesapi/stubs/System/__init__.py | 25723 -------------- pyesapi/stubs/VMS/TPS/Common/Model/API.py | 6642 ---- pyesapi/stubs/VMS/TPS/Common/Model/Types.py | 3263 -- .../stubs/VMS/TPS/Common/Model/__init__.py | 11 - pyesapi/stubs/VMS/TPS/Common/__init__.py | 11 - pyesapi/stubs/VMS/TPS/__init__.py | 11 - pyesapi/stubs/VMS/__init__.py | 11 - pyesapi/stubs/clr.py | 364 - pyesapi/stubs/pythoncom.py | 2 - .../{xml_to_stubs.py => dotnet_to_stubs.py} | 747 +- 67 files changed, 31841 insertions(+), 52324 deletions(-) create mode 100644 pyesapi/VMS/TPS/Common/Model/API/API.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/API/AsyncPump/AsyncPump.pyi rename pyesapi/{stubs/__init__.py => VMS/TPS/Common/Model/API/AsyncPump/__init__.pyi} (100%) create mode 100644 pyesapi/VMS/TPS/Common/Model/API/Calculation/Calculation.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/API/Calculation/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/API/ControlPointCollection/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/API/IonControlPointCollection/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/API/IonControlPointPairCollection/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/API/IonSpotCollection/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/API/IonSpotParametersCollection/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/API/StructureCodeDictionary/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/API/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/DoseValue/DoseValue.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/DoseValue/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/DoseValueDisplayConfig/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/LineProfile/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/PlanValidationResultDetail.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/SegmentProfile/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/Types.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/Types/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/VVector/VVector.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/VVector/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/Types/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/Model/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Common/__init__.pyi create mode 100644 pyesapi/VMS/TPS/Version/Version.pyi create mode 100644 pyesapi/VMS/TPS/Version/__init__.pyi create mode 100644 pyesapi/VMS/TPS/__init__.pyi create mode 100644 pyesapi/VMS/__init__.pyi create mode 100644 pyesapi/VMS/py.typed delete mode 100644 pyesapi/stubs/Microsoft/CSharp.py delete mode 100644 pyesapi/stubs/Microsoft/VisualBasic.py delete mode 100644 pyesapi/stubs/Microsoft/Win32/SafeHandles.py delete mode 100644 pyesapi/stubs/Microsoft/Win32/__init__.py delete mode 100644 pyesapi/stubs/Microsoft/__init__.py delete mode 100644 pyesapi/stubs/System/Array.py delete mode 100644 pyesapi/stubs/System/Collections/Concurrent.py delete mode 100644 pyesapi/stubs/System/Collections/Generic.py delete mode 100644 pyesapi/stubs/System/Collections/ObjectModel.py delete mode 100644 pyesapi/stubs/System/Collections/Specialized.py delete mode 100644 pyesapi/stubs/System/Collections/__init__.py delete mode 100644 pyesapi/stubs/System/Configuration.py delete mode 100644 pyesapi/stubs/System/Double.py delete mode 100644 pyesapi/stubs/System/Int32.py delete mode 100644 pyesapi/stubs/System/Media.py delete mode 100644 pyesapi/stubs/System/Runtime/__init__.py delete mode 100644 pyesapi/stubs/System/Timers.py delete mode 100644 pyesapi/stubs/System/Type/__init__.py delete mode 100644 pyesapi/stubs/System/Web.py delete mode 100644 pyesapi/stubs/System/Windows/Input.py delete mode 100644 pyesapi/stubs/System/Windows/Markup.py delete mode 100644 pyesapi/stubs/System/Windows/__init__.py delete mode 100644 pyesapi/stubs/System/__init__.py delete mode 100644 pyesapi/stubs/VMS/TPS/Common/Model/API.py delete mode 100644 pyesapi/stubs/VMS/TPS/Common/Model/Types.py delete mode 100644 pyesapi/stubs/VMS/TPS/Common/Model/__init__.py delete mode 100644 pyesapi/stubs/VMS/TPS/Common/__init__.py delete mode 100644 pyesapi/stubs/VMS/TPS/__init__.py delete mode 100644 pyesapi/stubs/VMS/__init__.py delete mode 100644 pyesapi/stubs/clr.py delete mode 100644 pyesapi/stubs/pythoncom.py rename stubgen/{xml_to_stubs.py => dotnet_to_stubs.py} (54%) diff --git a/pyesapi/VMS/TPS/Common/Model/API/API.pyi b/pyesapi/VMS/TPS/Common/Model/API/API.pyi new file mode 100644 index 0000000..5d3dde5 --- /dev/null +++ b/pyesapi/VMS/TPS/Common/Model/API/API.pyi @@ -0,0 +1,28349 @@ +""" +Type stubs for VMS.TPS.Common.Model.API +Generated from .NET XML documentation +""" + +from typing import Any, List, Optional, Union, Dict, Iterable, overload +from datetime import datetime +from System import Array, Double, Single, Int32, Boolean, String +from System.Collections.Generic import KeyValuePair +from System import Collections + +# Type imports +from ..Types.Types import AxisAlignedMargins +from ..Types.Types import BrachyTreatmentTechniqueType +from ..Types.Types import CalculationType +from ..Types.Types import ClosedLeavesMeetingPoint +from ..Types.Types import DRRCalculationParameters +from ..Types.Types import DoseValue +from ..Types.Types import DoseValuePresentation +from ..Types.Types import ExternalBeamMachineParameters +from ..Types.Types import FitToStructureMargins +from ..Types.Types import Fluence +from ..Types.Types import GantryDirection +from ..Types.Types import ImagingBeamSetupParameters +from ..Types.Types import IonPlanNormalizationParameters +from ..Types.Types import IonPlanOptimizationMode +from ..Types.Types import JawFitting +from ..Types.Types import LMCMSSOptions +from ..Types.Types import LMCVOptions +from ..Types.Types import LogSeverity +from ..Types.Types import OpenLeavesMeetingPoint +from ..Types.Types import OptimizationObjectiveOperator +from ..Types.Types import OptimizationOption +from ..Types.Types import OptimizationOptionsIMPT +from ..Types.Types import OptimizationOptionsIMRT +from ..Types.Types import OptimizationOptionsVMAT +from ..Types.Types import PatientOrientation +from ..Types.Types import PlanSumOperation +from ..Types.Types import PlanUncertaintyType +from ..Types.Types import ProtonBeamMachineParameters +from ..Types.Types import RailPosition +from ..Types.Types import SmartLMCOptions +from ..Types.Types import StructureCodeInfo +from ..Types.Types import VRect +from ..Types.Types import VVector +from ..Types.Types import VolumePresentation + +class AddOn: + """ + Represents an add-on, which is a beam modifying device that is inserted into a beam in an accessory slot of the external beam machine. An add-on is used to shape the beam or modulate its intensity or both. Add-ons are blocks, MLCs, wedges, compensators, applicators, a tray, and other devices or materials that can be fixed to a tray to be mounted into an accessory slot. + + Attributes: + CreationDateTime (Optional[datetime]): The date when this object was created. + CreationDateTime (Optional[datetime]): The date when this object was created. + """ + def __init__(self) -> None: ... + + CreationDateTime: Optional[datetime] + + CreationDateTime: Optional[datetime] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class AddOnMaterial: + """ + Add-on material describes the dosimetric and physical properties of the metal alloy or other substance used to create the add-on. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ApplicationPackage: + """ + Presents the application package information in the system. Note: not all methods are necessarily Published at the moment. + + Attributes: + ApprovalStatus (ApplicationScriptApprovalStatus): The status of the application package. Possible values are defined by a lookup RT_APP_EXTENSION_STATUS. + Description (str): Description of functionality provided by the package. + ExpirationDate (Optional[datetime]): An optional expiration date of the package. The package cannot be executed after expiration date. The date is presented in UTC. + PackageId (str): Unique Package ID. + PackageName (str): The full name of the package. + PackageVersion (str): The version number of the package. + PublisherData (str): Optional JSON data that can be used by package internally, e.g. customer key. + PublisherName (str): The name of the organization or author that created the package. This is a free text that can be set by the approver. + ApprovalStatus (ApplicationScriptApprovalStatus): The status of the application package. Possible values are defined by a lookup RT_APP_EXTENSION_STATUS. + Description (str): Description of functionality provided by the package. + ExpirationDate (Optional[datetime]): An optional expiration date of the package. The package cannot be executed after expiration date. The date is presented in UTC. + PackageId (str): Unique Package ID. + PackageName (str): The full name of the package. + PackageVersion (str): The version number of the package. + PublisherData (str): Optional JSON data that can be used by package internally, e.g. customer key. + PublisherName (str): The name of the organization or author that created the package. This is a free text that can be set by the approver. + """ + def __init__(self) -> None: ... + + ApprovalStatus: ApplicationScriptApprovalStatus + + Description: str + + ExpirationDate: Optional[datetime] + + PackageId: str + + PackageName: str + + PackageVersion: str + + PublisherData: str + + PublisherName: str + + ApprovalStatus: ApplicationScriptApprovalStatus + + Description: str + + ExpirationDate: Optional[datetime] + + PackageId: str + + PackageName: str + + PackageVersion: str + + PublisherData: str + + PublisherName: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ApplicationScript: + """ + Presents the application script information in the system. The location of the script file is not stored in the system. + + Attributes: + ApprovalStatus (ApplicationScriptApprovalStatus): The status of the script. + ApprovalStatusDisplayText (str): The display text of the approval status. + AssemblyName (Reflection.AssemblyName): The full name of the script assembly. + ExpirationDate (Optional[datetime]): An optional expiration date of the script. The script cannot be executed after expiration date. The date is presented in UTC. + IsReadOnlyScript (bool): Returns true if the script is intended only to read patient data. + IsWriteableScript (bool): Returns true if the script is intended to modify persistent data. + PublisherName (str): The name of the organization or author that created the script. This is a free text that can be set by the approver. + ScriptType (ApplicationScriptType): The type of the application script. + StatusDate (Optional[datetime]): A timestamp of the last approval status modification. + StatusUserIdentity (UserIdentity): The identity of the user who last modified the approval status. + ApprovalStatus (ApplicationScriptApprovalStatus): The status of the script. + ApprovalStatusDisplayText (str): The display text of the approval status. + AssemblyName (Reflection.AssemblyName): The full name of the script assembly. + ExpirationDate (Optional[datetime]): An optional expiration date of the script. The script cannot be executed after expiration date. The date is presented in UTC. + IsReadOnlyScript (bool): Returns true if the script is intended only to read patient data. + IsWriteableScript (bool): Returns true if the script is intended to modify persistent data. + PublisherName (str): The name of the organization or author that created the script. This is a free text that can be set by the approver. + ScriptType (ApplicationScriptType): The type of the application script. + StatusDate (Optional[datetime]): A timestamp of the last approval status modification. + StatusUserIdentity (UserIdentity): The identity of the user who last modified the approval status. + """ + def __init__(self) -> None: ... + + ApprovalStatus: ApplicationScriptApprovalStatus + + ApprovalStatusDisplayText: str + + AssemblyName: Reflection.AssemblyName + + ExpirationDate: Optional[datetime] + + IsReadOnlyScript: bool + + IsWriteableScript: bool + + PublisherName: str + + ScriptType: ApplicationScriptType + + StatusDate: Optional[datetime] + + StatusUserIdentity: UserIdentity + + ApprovalStatus: ApplicationScriptApprovalStatus + + ApprovalStatusDisplayText: str + + AssemblyName: Reflection.AssemblyName + + ExpirationDate: Optional[datetime] + + IsReadOnlyScript: bool + + IsWriteableScript: bool + + PublisherName: str + + ScriptType: ApplicationScriptType + + StatusDate: Optional[datetime] + + StatusUserIdentity: UserIdentity + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ApplicationScriptLog: + """ + The log entry of the application script execution. + + Attributes: + CourseId (str): The identifier of the course that was modified by the script. + PatientId (str): The identifier of the patient that was modified by the script. + PlanSetupId (str): The identifier of the plan that was modified by the script, or an empty string if the script did not modify the plan. + PlanUID (str): The DICOM UID of the plan that was modified by the script, or an empty string if the script did not modify the plan. + Script (ApplicationScript): The script that modified the plan or structure set. + ScriptFullName (str): The full name of the script assembly that modified the plan or structure set. A System.Reflection.AssemblyName object can be created from the string. + StructureSetId (str): The identifier of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. + StructureSetUID (str): The DICOM UID of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. + CourseId (str): The identifier of the course that was modified by the script. + PatientId (str): The identifier of the patient that was modified by the script. + PlanSetupId (str): The identifier of the plan that was modified by the script, or an empty string if the script did not modify the plan. + PlanUID (str): The DICOM UID of the plan that was modified by the script, or an empty string if the script did not modify the plan. + Script (ApplicationScript): The script that modified the plan or structure set. + ScriptFullName (str): The full name of the script assembly that modified the plan or structure set. A System.Reflection.AssemblyName object can be created from the string. + StructureSetId (str): The identifier of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. + StructureSetUID (str): The DICOM UID of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. + """ + def __init__(self) -> None: ... + + CourseId: str + + PatientId: str + + PlanSetupId: str + + PlanUID: str + + Script: ApplicationScript + + ScriptFullName: str + + StructureSetId: str + + StructureSetUID: str + + CourseId: str + + PatientId: str + + PlanSetupId: str + + PlanUID: str + + Script: ApplicationScript + + ScriptFullName: str + + StructureSetId: str + + StructureSetUID: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Applicator: + """ + An applicator add-on, either an electron applicator or cone applicator. + + Attributes: + ApplicatorLengthInMM (float): Applicator length in mm. + DiameterInMM (float): Applicator Diameter in mm. + FieldSizeX (float): The field width in direction X (cm). + FieldSizeY (float): The field width in direction Y (cm). + IsStereotactic (bool): Is stereotactic. + ApplicatorLengthInMM (float): Applicator length in mm. + DiameterInMM (float): Applicator Diameter in mm. + FieldSizeX (float): The field width in direction X (cm). + FieldSizeY (float): The field width in direction Y (cm). + IsStereotactic (bool): Is stereotactic. + """ + def __init__(self) -> None: ... + + ApplicatorLengthInMM: float + + DiameterInMM: float + + FieldSizeX: float + + FieldSizeY: float + + IsStereotactic: bool + + ApplicatorLengthInMM: float + + DiameterInMM: float + + FieldSizeX: float + + FieldSizeY: float + + IsStereotactic: bool + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class BeamDose: + """ + Represents a dose that is connected to a Beam. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts a relative beam dose value into absolute units. This method factors in the field weight, dose prescription, prescribed percentage and plan normalization. + def GetAbsoluteBeamDoseValue(self, relative: DoseValue) -> DoseValue: + """ + Args: + relative: The relative dose value from this beam dose matrix to be converted. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts a relative beam dose value into absolute units. This method factors in the field weight, dose prescription, prescribed percentage and plan normalization. + def GetAbsoluteBeamDoseValue(self, relative: DoseValue) -> DoseValue: + """ + Args: + relative: The relative dose value from this beam dose matrix to be converted. + """ + ... + + + +class BeamParameters: + """ + An editable copy of the parameters of a treatment beam. + + Attributes: + ControlPoints (List[ControlPointParameters]): Editable control point parameters copied from the treatment beam. + GantryDirection (GantryDirection): The direction of gantry rotation (clockwise or counterclockwise). + Isocenter (VVector): A copy of the isocenter position, in millimeters. + WeightFactor (float): The weight factor of the beam. + ControlPoints (List[ControlPointParameters]): Editable control point parameters copied from the treatment beam. + GantryDirection (GantryDirection): The direction of gantry rotation (clockwise or counterclockwise). + Isocenter (VVector): A copy of the isocenter position, in millimeters. + WeightFactor (float): The weight factor of the beam. + + Note: + To apply the parameters, call the + """ + def __init__(self) -> None: ... + + ControlPoints: List[ControlPointParameters] + + GantryDirection: GantryDirection + + Isocenter: VVector + + WeightFactor: float + + ControlPoints: List[ControlPointParameters] + + GantryDirection: GantryDirection + + Isocenter: VVector + + WeightFactor: float + + # Assigns the given leaf positions to each of the control point parameters. + def SetAllLeafPositions(self, leafPositions: Array[float]) -> None: + """ + Args: + leafPositions: The positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. + """ + ... + + + # Assigns the given jaw positions to each of the control point parameters. + def SetJawPositions(self, positions: VRect[float]) -> None: + """ + Args: + positions: A rectangle describing the jaw positions in millimeters in IEC BEAM LIMITING DEVICE coordinates. + """ + ... + + + # Assigns the given leaf positions to each of the control point parameters. + def SetAllLeafPositions(self, leafPositions: Array[float]) -> None: + """ + Args: + leafPositions: The positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. + """ + ... + + + # Assigns the given jaw positions to each of the control point parameters. + def SetJawPositions(self, positions: VRect[float]) -> None: + """ + Args: + positions: A rectangle describing the jaw positions in millimeters in IEC BEAM LIMITING DEVICE coordinates. + """ + ... + + + +class BeamUncertainty: + """ + Access to beam uncertainty. + + Attributes: + Beam (Beam): The beam to which this uncertainty is linked. + BeamNumber (BeamNumber): Beam number of the related beam. + Dose (Dose): Dose of this beam uncertainty. + Beam (Beam): The beam to which this uncertainty is linked. + BeamNumber (BeamNumber): Beam number of the related beam. + Dose (Dose): Dose of this beam uncertainty. + """ + def __init__(self) -> None: ... + + Beam: Beam + + BeamNumber: BeamNumber + + Dose: Dose + + Beam: Beam + + BeamNumber: BeamNumber + + Dose: Dose + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class BrachyFieldReferencePoint: + """ + This object links a Brachy field to a reference point. + + Attributes: + FieldDose (DoseValue): The field dose. + IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. + IsPrimaryReferencePoint (bool): Checks if the reference point is primary. + ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. + RefPointLocation (VVector): The location of the reference point. + FieldDose (DoseValue): The field dose. + IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. + IsPrimaryReferencePoint (bool): Checks if the reference point is primary. + ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. + RefPointLocation (VVector): The location of the reference point. + """ + def __init__(self) -> None: ... + + FieldDose: DoseValue + + IsFieldDoseNominal: bool + + IsPrimaryReferencePoint: bool + + ReferencePoint: ReferencePoint + + RefPointLocation: VVector + + FieldDose: DoseValue + + IsFieldDoseNominal: bool + + IsPrimaryReferencePoint: bool + + ReferencePoint: ReferencePoint + + RefPointLocation: VVector + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class BrachyPlanSetup: + """ + Represents a brachytherapy treatment plan. + + Attributes: + ApplicationSetupType (str): The application setup type of this brachytherapy plan. Possible types are: "FLETCHER_SUIT", "DELCLOS", "BLOEDORN", "JOSLIN_FLYNN", "CHANDIGARH", "MANCHESTER", "HENSCHKE", "NASOPHARYNGEAL", "OESOPHAGEAL", "ENDOBRONCHIAL", "SYED_NEBLETT", "ENDORECTAL", "PERINEAL", "HAM_FLAB", "EYE_PLAQUE", and "OTHER". + BrachyTreatmentTechnique (BrachyTreatmentTechniqueType): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". + Catheters (List[Catheter]): The catheters or applicator channel centerlines of this brachytherapy plan, including any catheters associated with + NumberOfPdrPulses (Optional[int]): The number of pulses in a brachytherapy Pulse Dose Rate (PDR) treatment. Null if the plan is not for a PDR treatment. + PdrPulseInterval (Optional[float]): The pulse interval in a brachytherapy Pulse Dose Rate (PDR) treatment in seconds. Null if the plan is not for a PDR treatment. + ReferenceLines (List[Structure]): Collection of reference lines in the plan. + SeedCollections (List[SeedCollection]): The seed collections of this brachytherapy plan. + SolidApplicators (List[BrachySolidApplicator]): The solid applicator parts of this brachytherapy plan. + TreatmentTechnique (str): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". + TreatmentDateTime (Optional[datetime]): The treatment date of this brachytherapy plan. + ApplicationSetupType (str): The application setup type of this brachytherapy plan. Possible types are: "FLETCHER_SUIT", "DELCLOS", "BLOEDORN", "JOSLIN_FLYNN", "CHANDIGARH", "MANCHESTER", "HENSCHKE", "NASOPHARYNGEAL", "OESOPHAGEAL", "ENDOBRONCHIAL", "SYED_NEBLETT", "ENDORECTAL", "PERINEAL", "HAM_FLAB", "EYE_PLAQUE", and "OTHER". + BrachyTreatmentTechnique (BrachyTreatmentTechniqueType): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". + Catheters (List[Catheter]): The catheters or applicator channel centerlines of this brachytherapy plan, including any catheters associated with + NumberOfPdrPulses (Optional[int]): The number of pulses in a brachytherapy Pulse Dose Rate (PDR) treatment. Null if the plan is not for a PDR treatment. + PdrPulseInterval (Optional[float]): The pulse interval in a brachytherapy Pulse Dose Rate (PDR) treatment in seconds. Null if the plan is not for a PDR treatment. + ReferenceLines (List[Structure]): Collection of reference lines in the plan. + SeedCollections (List[SeedCollection]): The seed collections of this brachytherapy plan. + SolidApplicators (List[BrachySolidApplicator]): The solid applicator parts of this brachytherapy plan. + TreatmentTechnique (str): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". + TreatmentDateTime (Optional[datetime]): The treatment date of this brachytherapy plan. + """ + def __init__(self) -> None: ... + + ApplicationSetupType: str + + BrachyTreatmentTechnique: BrachyTreatmentTechniqueType + + Catheters: List[Catheter] + + NumberOfPdrPulses: Optional[int] + + PdrPulseInterval: Optional[float] + + ReferenceLines: List[Structure] + + SeedCollections: List[SeedCollection] + + SolidApplicators: List[BrachySolidApplicator] + + TreatmentTechnique: str + + TreatmentDateTime: Optional[datetime] + + ApplicationSetupType: str + + BrachyTreatmentTechnique: BrachyTreatmentTechniqueType + + Catheters: List[Catheter] + + NumberOfPdrPulses: Optional[int] + + PdrPulseInterval: Optional[float] + + ReferenceLines: List[Structure] + + SeedCollections: List[SeedCollection] + + SolidApplicators: List[BrachySolidApplicator] + + TreatmentTechnique: str + + TreatmentDateTime: Optional[datetime] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new brachyterapy applicator to the plan. + def AddCatheter(self, catheterId: str, treatmentUnit: BrachyTreatmentUnit, outputDiagnostics: Text.StringBuilder, appendChannelNumToId: bool, channelNum: int) -> Catheter: + """ + Args: + catheterId: Id of the catheter. + treatmentUnit: The + outputDiagnostics: Additional information about brachytherapy applicator creation. + appendChannelNumToId: If true, channel number will be appended to the given catheterId. + channelNum: Channel number of the catheter. 0 assigns next available free channel number. -1 assigns empty channel number. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add location to reference point. + def AddLocationToExistingReferencePoint(self, location: VVector, referencePoint: ReferencePoint) -> None: + """ + Args: + location: Reference point location in mm. + referencePoint: Reference point. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point without location. Created reference point is linked to the plan. + def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: + """ + Args: + target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). + id: Reference point ID. + """ + ... + + + # Calculates and returns the dose profile. Profile is calculated on the fly with TG-43 formalism. + def CalculateAccurateTG43DoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Changes the brachy treatment unit for all applicators in the brachy plan. + def ChangeTreatmentUnit(self, treatmentUnit: BrachyTreatmentUnit, messages: bool, keepDoseIntact: List[str]) -> ChangeBrachyTreatmentUnitResult: + """ + Args: + treatmentUnit: The + messages: An output parameter that may be populated with 1..n messages of additional information. + keepDoseIntact: If true, the dwell times are scaled to keep the dose intact. If false, dwell times are not scaled, and the dose may be invalidated. + """ + ... + + + # Calculates 3D dose using the TG-43 brachy calculator. + def CalculateTG43Dose(self) -> CalculateBrachy3DDoseResult: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new brachyterapy applicator to the plan. + def AddCatheter(self, catheterId: str, treatmentUnit: BrachyTreatmentUnit, outputDiagnostics: Text.StringBuilder, appendChannelNumToId: bool, channelNum: int) -> Catheter: + """ + Args: + catheterId: Id of the catheter. + treatmentUnit: The + outputDiagnostics: Additional information about brachytherapy applicator creation. + appendChannelNumToId: If true, channel number will be appended to the given catheterId. + channelNum: Channel number of the catheter. 0 assigns next available free channel number. -1 assigns empty channel number. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add location to reference point. + def AddLocationToExistingReferencePoint(self, location: VVector, referencePoint: ReferencePoint) -> None: + """ + Args: + location: Reference point location in mm. + referencePoint: Reference point. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point without location. Created reference point is linked to the plan. + def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: + """ + Args: + target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). + id: Reference point ID. + """ + ... + + + # Calculates and returns the dose profile. Profile is calculated on the fly with TG-43 formalism. + def CalculateAccurateTG43DoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Changes the brachy treatment unit for all applicators in the brachy plan. + def ChangeTreatmentUnit(self, treatmentUnit: BrachyTreatmentUnit, messages: bool, keepDoseIntact: List[str]) -> ChangeBrachyTreatmentUnitResult: + """ + Args: + treatmentUnit: The + messages: An output parameter that may be populated with 1..n messages of additional information. + keepDoseIntact: If true, the dwell times are scaled to keep the dose intact. If false, dwell times are not scaled, and the dose may be invalidated. + """ + ... + + + # Calculates 3D dose using the TG-43 brachy calculator. + def CalculateTG43Dose(self) -> CalculateBrachy3DDoseResult: + ... + + + +class BrachySolidApplicator: + """ + Represents a brachytherapy solid applicator part, such as a tandem or ovoid in a Fletcher Suit Delclos (FSD) applicator set. This class holds only the metadata related to the solid applicator part, and links to the + + Attributes: + ApplicatorSetName (str): The name of the solid applicator set to which this part belongs. + ApplicatorSetType (str): The type of the solid applicator set to which this part belongs. + Category (str): The category of the solid applicator set to which this part belongs. + Catheters (List[Catheter]): The channel(s) of this solid applicator part. + GroupNumber (int): Applicator Group number. + Note (str): A note or short description of the solid applicator part. + PartName (str): The name of the solid applicator part. + PartNumber (str): The part number of the solid applicator. + Summary (str): A summary of the solid applicator set to which this part belongs. + UID (str): The unique identifier of the solid applicator part. + Vendor (str): The vendor of the solid applicator set to which this part belongs. + Version (str): The version of the solid applicator part. + ApplicatorSetName (str): The name of the solid applicator set to which this part belongs. + ApplicatorSetType (str): The type of the solid applicator set to which this part belongs. + Category (str): The category of the solid applicator set to which this part belongs. + Catheters (List[Catheter]): The channel(s) of this solid applicator part. + GroupNumber (int): Applicator Group number. + Note (str): A note or short description of the solid applicator part. + PartName (str): The name of the solid applicator part. + PartNumber (str): The part number of the solid applicator. + Summary (str): A summary of the solid applicator set to which this part belongs. + UID (str): The unique identifier of the solid applicator part. + Vendor (str): The vendor of the solid applicator set to which this part belongs. + Version (str): The version of the solid applicator part. + """ + def __init__(self) -> None: ... + + ApplicatorSetName: str + + ApplicatorSetType: str + + Category: str + + Catheters: List[Catheter] + + GroupNumber: int + + Note: str + + PartName: str + + PartNumber: str + + Summary: str + + UID: str + + Vendor: str + + Version: str + + ApplicatorSetName: str + + ApplicatorSetType: str + + Category: str + + Catheters: List[Catheter] + + GroupNumber: int + + Note: str + + PartName: str + + PartNumber: str + + Summary: str + + UID: str + + Vendor: str + + Version: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class BrachyTreatmentUnit: + """ + Represents a brachytherapy afterloader. + + Attributes: + DoseRateMode (str): The dose rate mode of this treatment unit. Supported modes are "HDR", "PDR", "MDR", and "LDR". + DwellTimeResolution (float): The dwell time resolution supported by this treatment unit in seconds. + MachineInterface (str): The interface type for communicating with this brachytherapy treatment unit. Possible types are "GammaMed12i", "GammaMedPlus", "VariSource", "Other", and "Omnitron" (obsolete type). + MachineModel (str): The model identifier for this treatment unit. Possible models are "VariSource_5", "VariSource_10", "Remote_Afterloading", "Manual_Loading", "GammaMed12i", and "GammaMedPlus". + MaxDwellTimePerChannel (float): The maximum combined dwell time in a single channel in seconds. + MaxDwellTimePerPos (float): The maximum dwell time in a single dwell position in seconds. + MaxDwellTimePerTreatment (float): The maximum combined dwell time in all the channels during a single treatment session. The value is in seconds. + MaximumChannelLength (float): The maximum channel length supported by this treatment unit in millimeters. + MaximumDwellPositionsPerChannel (int): The maximum number of dwell positions per channel supported by this treatment unit. + MaximumStepSize (float): The maximum distance between adjacent source positions in millimeters. + MinAllowedSourcePos (float): The minimum allowed distance (in millimeters) from the tip of the inner lumen of the applicator to the center of the first dwell position. In other words, no source positions should be placed within this distance from the tip of the inner lumen. + MinimumChannelLength (float): The minimum channel length supported by this treatment unit in millimeters. + MinimumStepSize (float): The minimum distance between adjacent source positions in millimeters. + NumberOfChannels (int): The number of channels in this treatment unit. + SourceCenterOffsetFromTip (float): The offset distance (in millimeters) from the tip of the applicator to the center of the source at its first possible dwell position. In other words, the offset accounts for half of the active source length and encapsulation. + SourceMovementType (str): The source movement type as defined in DICOM. Possible types are "STEPWISE", "FIXED", and "OSCILLATING". + StepSizeResolution (float): The default step size resolution for this treatment unit in millimeters. + DoseRateMode (str): The dose rate mode of this treatment unit. Supported modes are "HDR", "PDR", "MDR", and "LDR". + DwellTimeResolution (float): The dwell time resolution supported by this treatment unit in seconds. + MachineInterface (str): The interface type for communicating with this brachytherapy treatment unit. Possible types are "GammaMed12i", "GammaMedPlus", "VariSource", "Other", and "Omnitron" (obsolete type). + MachineModel (str): The model identifier for this treatment unit. Possible models are "VariSource_5", "VariSource_10", "Remote_Afterloading", "Manual_Loading", "GammaMed12i", and "GammaMedPlus". + MaxDwellTimePerChannel (float): The maximum combined dwell time in a single channel in seconds. + MaxDwellTimePerPos (float): The maximum dwell time in a single dwell position in seconds. + MaxDwellTimePerTreatment (float): The maximum combined dwell time in all the channels during a single treatment session. The value is in seconds. + MaximumChannelLength (float): The maximum channel length supported by this treatment unit in millimeters. + MaximumDwellPositionsPerChannel (int): The maximum number of dwell positions per channel supported by this treatment unit. + MaximumStepSize (float): The maximum distance between adjacent source positions in millimeters. + MinAllowedSourcePos (float): The minimum allowed distance (in millimeters) from the tip of the inner lumen of the applicator to the center of the first dwell position. In other words, no source positions should be placed within this distance from the tip of the inner lumen. + MinimumChannelLength (float): The minimum channel length supported by this treatment unit in millimeters. + MinimumStepSize (float): The minimum distance between adjacent source positions in millimeters. + NumberOfChannels (int): The number of channels in this treatment unit. + SourceCenterOffsetFromTip (float): The offset distance (in millimeters) from the tip of the applicator to the center of the source at its first possible dwell position. In other words, the offset accounts for half of the active source length and encapsulation. + SourceMovementType (str): The source movement type as defined in DICOM. Possible types are "STEPWISE", "FIXED", and "OSCILLATING". + StepSizeResolution (float): The default step size resolution for this treatment unit in millimeters. + """ + def __init__(self) -> None: ... + + DoseRateMode: str + + DwellTimeResolution: float + + MachineInterface: str + + MachineModel: str + + MaxDwellTimePerChannel: float + + MaxDwellTimePerPos: float + + MaxDwellTimePerTreatment: float + + MaximumChannelLength: float + + MaximumDwellPositionsPerChannel: int + + MaximumStepSize: float + + MinAllowedSourcePos: float + + MinimumChannelLength: float + + MinimumStepSize: float + + NumberOfChannels: int + + SourceCenterOffsetFromTip: float + + SourceMovementType: str + + StepSizeResolution: float + + DoseRateMode: str + + DwellTimeResolution: float + + MachineInterface: str + + MachineModel: str + + MaxDwellTimePerChannel: float + + MaxDwellTimePerPos: float + + MaxDwellTimePerTreatment: float + + MaximumChannelLength: float + + MaximumDwellPositionsPerChannel: int + + MaximumStepSize: float + + MinAllowedSourcePos: float + + MinimumChannelLength: float + + MinimumStepSize: float + + NumberOfChannels: int + + SourceCenterOffsetFromTip: float + + SourceMovementType: str + + StepSizeResolution: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns the active radioactive source of this treatment unit. + def GetActiveRadioactiveSource(self) -> RadioactiveSource: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns the active radioactive source of this treatment unit. + def GetActiveRadioactiveSource(self) -> RadioactiveSource: + ... + + + +class CalculateBrachy3DDoseResult: + """ + Brachy 3D dose calculation result + + Attributes: + Errors (List[str]): Error messages if "Success" is false. + RoundedDwellTimeAdjustRatio (float): The ratio with which the dwell times were adjusted to meet the resolution of the treatment unit. A value of zero (0.0) means no adjustment to dwell times was made. Value is undefined if "Success" is false + Success (bool): Was the dose calculation successful? + Errors (List[str]): Error messages if "Success" is false. + RoundedDwellTimeAdjustRatio (float): The ratio with which the dwell times were adjusted to meet the resolution of the treatment unit. A value of zero (0.0) means no adjustment to dwell times was made. Value is undefined if "Success" is false + Success (bool): Was the dose calculation successful? + """ + def __init__(self) -> None: ... + + Errors: List[str] + + RoundedDwellTimeAdjustRatio: float + + Success: bool + + Errors: List[str] + + RoundedDwellTimeAdjustRatio: float + + Success: bool + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Calculation: + """ + Contains a calculation specific functions + + Attributes: + AlgorithmsRootPath (str): Algorithms Root Path + AlgorithmsRootPath (str): Algorithms Root Path + """ + # Calculation object constructor + @overload + def __init__(self, dvhEstimationModelLibrary: IDVHEstimationModelLibrary) -> None: + """ + Args: + dvhEstimationModelLibrary: DVH Estimation Model Library + """ + ... + + + # Calculation object constructor + @overload + def __init__(self, dvhEstimationModelLibrary: IDVHEstimationModelLibrary) -> None: + """ + Args: + dvhEstimationModelLibrary: DVH Estimation Model Library + """ + ... + + + AlgorithmsRootPath: str + + AlgorithmsRootPath: str + + # Installed Algorithms + def GetInstalledAlgorithms(self) -> List[Calculation+Algorithm]: + ... + + + # Retrieves calculation models + def GetCalculationModels(self) -> List[Calculation+CalculationModel]: + ... + + + # Retrieves the list of DVH Estimation Model structures + def GetDvhEstimationModelStructures(self, modelId: Guid) -> List[DVHEstimationModelStructure]: + """ + Args: + modelId: Model ID. + """ + ... + + + # List of DVH Estimation Model summaries. + def GetDvhEstimationModelSummaries(self) -> List[DVHEstimationModelSummary]: + ... + + + # Installed Algorithms + def GetInstalledAlgorithms(self) -> List[Calculation+Algorithm]: + ... + + + # Retrieves calculation models + def GetCalculationModels(self) -> List[Calculation+CalculationModel]: + ... + + + # Retrieves the list of DVH Estimation Model structures + def GetDvhEstimationModelStructures(self, modelId: Guid) -> List[DVHEstimationModelStructure]: + """ + Args: + modelId: Model ID. + """ + ... + + + # List of DVH Estimation Model summaries. + def GetDvhEstimationModelSummaries(self) -> List[DVHEstimationModelSummary]: + ... + + + +class Catheter: + """ + Represents a brachytherapy catheter or an applicator channel centerline. Catheters are associated with a + + Attributes: + ApplicatorLength (float): The total length from the tip of the catheter to the treatment unit in millimeters. + BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): A collection of brachy field reference points. + BrachySolidApplicatorPartID (int): The unique identifier of the + ChannelNumber (int): The channel number of this catheter. + Color (Windows.Media.Color): The color of the catheter in 2D views. + DeadSpaceLength (float): The total length from the tip of the catheter to the start of the inner lumen in millimeters. + FirstSourcePosition (float): The first source position in millimeters in this catheter. This is the source position closest to the tip of the catheter. + GroupNumber (int): Catheter Group number. + LastSourcePosition (float): The last source position in millimeters in this catheter. This is the source position furthest away from the tip of the catheter. + Shape (Array[VVector]): The DICOM coordinates of the applicator shape starting from the tip. + SourcePositions (List[SourcePosition]): The source positions in the catheter starting from the tip. + StepSize (float): The step size of the catheter in millimeters. + TreatmentUnit (BrachyTreatmentUnit): The brachytherapy treatment unit associated with this catheter. + ApplicatorLength (float): The total length from the tip of the catheter to the treatment unit in millimeters. + BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): A collection of brachy field reference points. + BrachySolidApplicatorPartID (int): The unique identifier of the + ChannelNumber (int): The channel number of this catheter. + Color (Windows.Media.Color): The color of the catheter in 2D views. + DeadSpaceLength (float): The total length from the tip of the catheter to the start of the inner lumen in millimeters. + FirstSourcePosition (float): The first source position in millimeters in this catheter. This is the source position closest to the tip of the catheter. + GroupNumber (int): Catheter Group number. + LastSourcePosition (float): The last source position in millimeters in this catheter. This is the source position furthest away from the tip of the catheter. + Shape (Array[VVector]): The DICOM coordinates of the applicator shape starting from the tip. + SourcePositions (List[SourcePosition]): The source positions in the catheter starting from the tip. + StepSize (float): The step size of the catheter in millimeters. + TreatmentUnit (BrachyTreatmentUnit): The brachytherapy treatment unit associated with this catheter. + """ + def __init__(self) -> None: ... + + ApplicatorLength: float + + BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] + + BrachySolidApplicatorPartID: int + + ChannelNumber: int + + Color: Windows.Media.Color + + DeadSpaceLength: float + + FirstSourcePosition: float + + GroupNumber: int + + LastSourcePosition: float + + Shape: Array[VVector] + + SourcePositions: List[SourcePosition] + + StepSize: float + + TreatmentUnit: BrachyTreatmentUnit + + ApplicatorLength: float + + BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] + + BrachySolidApplicatorPartID: int + + ChannelNumber: int + + Color: Windows.Media.Color + + DeadSpaceLength: float + + FirstSourcePosition: float + + GroupNumber: int + + LastSourcePosition: float + + Shape: Array[VVector] + + SourcePositions: List[SourcePosition] + + StepSize: float + + TreatmentUnit: BrachyTreatmentUnit + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # The distance (in millimeters) from the tip of the catheter (in the first possible source position) to the center of the source position. This is an offset from the actual catheter inner lumen tip by half of the source length and encapsulation. + def GetSourcePosCenterDistanceFromTip(self, sourcePosition: SourcePosition) -> float: + """ + Args: + sourcePosition: The source position for which the distance from the catheter tip is got. + """ + ... + + + # The total dwell time in this catheter in seconds. + def GetTotalDwellTime(self) -> float: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Link reference line to applicator. + def LinkRefLine(self, refLine: Structure) -> None: + """ + Args: + refLine: Reference line to link with applicator. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Link reference point to applicator. + def LinkRefPoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to link with applicator. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the ID of the applicator. + def SetId(self, id: str, message: str) -> bool: + """ + Args: + id: The new ID for the applicator. + message: May be populated with a reason why setting the ID failed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the step size, first source position, and last source position, and resets the source positions of the catheter. + def SetSourcePositions(self, stepSize: float, firstSourcePosition: float, lastSourcePosition: float) -> SetSourcePositionsResult: + """ + Args: + stepSize: Step size in millimeters. + firstSourcePosition: First source position in millimeters. + lastSourcePosition: Last source position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference line from applicator. + def UnlinkRefLine(self, refLine: Structure) -> None: + """ + Args: + refLine: Reference line to unlink from applicator + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference point from applicator. + def UnlinkRefPoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to unlink from applicator + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # The distance (in millimeters) from the tip of the catheter (in the first possible source position) to the center of the source position. This is an offset from the actual catheter inner lumen tip by half of the source length and encapsulation. + def GetSourcePosCenterDistanceFromTip(self, sourcePosition: SourcePosition) -> float: + """ + Args: + sourcePosition: The source position for which the distance from the catheter tip is got. + """ + ... + + + # The total dwell time in this catheter in seconds. + def GetTotalDwellTime(self) -> float: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Link reference line to applicator. + def LinkRefLine(self, refLine: Structure) -> None: + """ + Args: + refLine: Reference line to link with applicator. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Link reference point to applicator. + def LinkRefPoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to link with applicator. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the ID of the applicator. + def SetId(self, id: str, message: str) -> bool: + """ + Args: + id: The new ID for the applicator. + message: May be populated with a reason why setting the ID failed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the step size, first source position, and last source position, and resets the source positions of the catheter. + def SetSourcePositions(self, stepSize: float, firstSourcePosition: float, lastSourcePosition: float) -> SetSourcePositionsResult: + """ + Args: + stepSize: Step size in millimeters. + firstSourcePosition: First source position in millimeters. + lastSourcePosition: Last source position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference line from applicator. + def UnlinkRefLine(self, refLine: Structure) -> None: + """ + Args: + refLine: Reference line to unlink from applicator + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference point from applicator. + def UnlinkRefPoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to unlink from applicator + """ + ... + + + +class ControlPointParameters: + """ + An editable copy of the parameters of a control point. + + Attributes: + CollimatorAngle (float): A copy of the collimator angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. + JawPositions (VRect[float]): A copy of the jaw positions of the treatment beams at this control point in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + LeafPositions (Array[float]): A copy of the positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If no MLC exists, a (0,0)-length array is returned. + PatientSupportAngle (float): A copy of the patient support angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. + GantryAngle (float): A copy of the gantry angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + MetersetWeight (float): A copy of the cumulative meterset weight to this control point. + CollimatorAngle (float): A copy of the collimator angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. + JawPositions (VRect[float]): A copy of the jaw positions of the treatment beams at this control point in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + LeafPositions (Array[float]): A copy of the positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If no MLC exists, a (0,0)-length array is returned. + PatientSupportAngle (float): A copy of the patient support angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. + GantryAngle (float): A copy of the gantry angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + MetersetWeight (float): A copy of the cumulative meterset weight to this control point. + + Note: + To apply the parameters, call the ApplyParameters method of the Beam class. Because the parameters are simple copies, they do not reflect the current state of the data model. + """ + def __init__(self) -> None: ... + + CollimatorAngle: float + + Index: int + + JawPositions: VRect[float] + + LeafPositions: Array[float] + + PatientSupportAngle: float + + TableTopLateralPosition: float + + TableTopLongitudinalPosition: float + + TableTopVerticalPosition: float + + GantryAngle: float + + MetersetWeight: float + + CollimatorAngle: float + + Index: int + + JawPositions: VRect[float] + + LeafPositions: Array[float] + + PatientSupportAngle: float + + TableTopLateralPosition: float + + TableTopLongitudinalPosition: float + + TableTopVerticalPosition: float + + GantryAngle: float + + MetersetWeight: float + + +class AsyncPump: + """ + Provides a pump that supports running asynchronous methods on the current thread. + """ + def __init__(self) -> None: ... + + # Helper for executing an async (Task-returning) function on a single thread. This can be used in cases where calling Wait() or Result on the Task would cause a deadlock, i.e., when the async part of the Task-returning function cannot be executed purely on a background thread. Exceptions thrown by the async function are re-thrown. If the exception is an + def RunAsyncOnCurrentThread(self, asynchronousFunction: Func[Task[T]]) -> Any: + """ + Args: + asynchronousFunction: The async function to be executed + """ + ... + + + # Helper for executing an async (Task-returning) function on a single thread. This can be used in cases where calling Wait() or Result on the Task would cause a deadlock, i.e., when the async part of the Task-returning function cannot be executed purely on a background thread. Exceptions thrown by the async function are re-thrown. If the exception is an + def RunAsyncOnCurrentThread(self, asynchronousFunction: Func[Task[T]]) -> Any: + """ + Args: + asynchronousFunction: The async function to be executed + """ + ... + + + +class Beam: + """ + Represents one beam (also referred to as "field") of an external beam treatment plan. See the definition of DICOM RT Beam for more details. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Beam. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Beam. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] The Beam comment. + Meterset (MetersetValue): The meterset value of the beam. + BeamNumber (int): DICOM RT Beam Number. The value is unique within the plan in which it is created. + Applicator (Applicator): An applicator is a specific add-on used in the beam. + ArcLength (float): The arc length. + AreControlPointJawsMoving (bool): Checks if jaws are moving. + AverageSSD (float): The average Source-to-Skin Distance (SSD) of an arc beam. + BeamTechnique (BeamTechnique): Returns an enumeration that describes the type of the treatment field. + Blocks (List[Block]): A collection of installed blocks. + Boluses (List[Bolus]): A collection of beam boluses. + CalculationLogs (List[BeamCalculationLog]): A collection of beam calculation logs. + CollimatorRotation (float): Collimator rotation + Compensator (Compensator): The compensator. + ControlPoints (ControlPointCollection): An enumerable sequence of machine parameters that describe the planned treatment beam. + CreationDateTime (Optional[datetime]): The date when this object was created. + Dose (BeamDose): The dose for the beam. Returns null if the dose is not calculated. + DoseRate (int): The dose rate of the treatment machine in MU/min. + DosimetricLeafGap (float): The dosimetric leaf gap that has been configured for the Dynamic Multileaf Collimator (DMLC) beams in the system. The dosimetric leaf gap is used for accounting for dose transmission through rounded MLC leaves. + EnergyMode (EnergyMode): Energy mode of the treatment machine. + EnergyModeDisplayName (str): The display name of the energy mode. For example '18E' or '6X-SRS'. + FieldReferencePoints (List[FieldReferencePoint]): A collection of field reference points. + GantryDirection (GantryDirection): The gantry rotation direction: clockwise (CW), counterclockwise (CCW), or none. + HasAllMLCLeavesClosed (bool): Returns true if all MLC leaves are closed. + IsGantryExtended (bool): Checks if the gantry rotation is extended. For arc beams, checks if the gantry rotation is extended at the start angle. + IsGantryExtendedAtStopAngle (bool): Checks if the gantry rotation is extended at the stop angle of an arc beam. + IsImagingTreatmentField (bool): Checks if a beam is an Imaging Treatment Beam, i.e., a beam that is used to take an MV image and whose dose is calculated and taken into account in treatment planning. + IsIMRT (bool): Checks if a beam is IMRT. + IsocenterPosition (VVector): The position of the isocenter. + IsSetupField (bool): Checks if a beam is a setup field. + MetersetPerGy (float): The calculated meterset/Gy value for the beam. + MLC (MLC): Returns a hardware description of the Multileaf Collimator (MLC) used in an MLC plan, or null if no MLC exists. + MLCPlanType (MLCPlanType): The type of the Multileaf Collimator (MLC) plan. + MLCTransmissionFactor (float): The transmission factor of the Multileaf Collimator (MLC) material. + MotionCompensationTechnique (str): DICOM (respiratory) motion compensation technique. Returns an empty string if motion compensation technique is not used. + MotionSignalSource (str): DICOM (respiratory) signal source. Returns an empty string if motion compensation technique is not used. + NormalizationFactor (float): The beam normalization factor. + NormalizationMethod (str): The beam normalization method. + Plan (PlanSetup): Used for navigating to parent Plan + PlannedSSD (float): The Source-to-Skin Distance (SSD) value defined by the user. + ReferenceImage (Image): The reference image of the beam. + SetupNote (str): The setup note of the field. + SetupTechnique (SetupTechnique): The setup technique. + SSD (float): The Source-to-Skin Distance (SSD). For arc beams, the SSD at the start angle. This value is calculated from the geometrical setup of the beam. + SSDAtStopAngle (float): The Source-to-Skin Distance (SSD) at the stop angle of an arc beam. This value is calculated from the geometrical setup of the beam. + Technique (Technique): The technique used in the planning beam. + ToleranceTableLabel (str): User-defined label for the referenced tolerance table, or an empty string if there is no reference to a tolerance table. + Trays (List[Tray]): A collection of installed trays. + TreatmentTime (float): The treatment time set for the beam in seconds. Plan Approval wizard sets this value by default. + TreatmentUnit (ExternalBeamTreatmentUnit): The external beam treatment unit associated with this beam. + Wedges (List[Wedge]): A collection of installed wedges. + WeightFactor (float): The weight factor of the beam. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Beam. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Beam. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] The Beam comment. + Meterset (MetersetValue): The meterset value of the beam. + BeamNumber (int): DICOM RT Beam Number. The value is unique within the plan in which it is created. + Applicator (Applicator): An applicator is a specific add-on used in the beam. + ArcLength (float): The arc length. + AreControlPointJawsMoving (bool): Checks if jaws are moving. + AverageSSD (float): The average Source-to-Skin Distance (SSD) of an arc beam. + BeamTechnique (BeamTechnique): Returns an enumeration that describes the type of the treatment field. + Blocks (List[Block]): A collection of installed blocks. + Boluses (List[Bolus]): A collection of beam boluses. + CalculationLogs (List[BeamCalculationLog]): A collection of beam calculation logs. + CollimatorRotation (float): Collimator rotation + Compensator (Compensator): The compensator. + ControlPoints (ControlPointCollection): An enumerable sequence of machine parameters that describe the planned treatment beam. + CreationDateTime (Optional[datetime]): The date when this object was created. + Dose (BeamDose): The dose for the beam. Returns null if the dose is not calculated. + DoseRate (int): The dose rate of the treatment machine in MU/min. + DosimetricLeafGap (float): The dosimetric leaf gap that has been configured for the Dynamic Multileaf Collimator (DMLC) beams in the system. The dosimetric leaf gap is used for accounting for dose transmission through rounded MLC leaves. + EnergyMode (EnergyMode): Energy mode of the treatment machine. + EnergyModeDisplayName (str): The display name of the energy mode. For example '18E' or '6X-SRS'. + FieldReferencePoints (List[FieldReferencePoint]): A collection of field reference points. + GantryDirection (GantryDirection): The gantry rotation direction: clockwise (CW), counterclockwise (CCW), or none. + HasAllMLCLeavesClosed (bool): Returns true if all MLC leaves are closed. + IsGantryExtended (bool): Checks if the gantry rotation is extended. For arc beams, checks if the gantry rotation is extended at the start angle. + IsGantryExtendedAtStopAngle (bool): Checks if the gantry rotation is extended at the stop angle of an arc beam. + IsImagingTreatmentField (bool): Checks if a beam is an Imaging Treatment Beam, i.e., a beam that is used to take an MV image and whose dose is calculated and taken into account in treatment planning. + IsIMRT (bool): Checks if a beam is IMRT. + IsocenterPosition (VVector): The position of the isocenter. + IsSetupField (bool): Checks if a beam is a setup field. + MetersetPerGy (float): The calculated meterset/Gy value for the beam. + MLC (MLC): Returns a hardware description of the Multileaf Collimator (MLC) used in an MLC plan, or null if no MLC exists. + MLCPlanType (MLCPlanType): The type of the Multileaf Collimator (MLC) plan. + MLCTransmissionFactor (float): The transmission factor of the Multileaf Collimator (MLC) material. + MotionCompensationTechnique (str): DICOM (respiratory) motion compensation technique. Returns an empty string if motion compensation technique is not used. + MotionSignalSource (str): DICOM (respiratory) signal source. Returns an empty string if motion compensation technique is not used. + NormalizationFactor (float): The beam normalization factor. + NormalizationMethod (str): The beam normalization method. + Plan (PlanSetup): Used for navigating to parent Plan + PlannedSSD (float): The Source-to-Skin Distance (SSD) value defined by the user. + ReferenceImage (Image): The reference image of the beam. + SetupNote (str): The setup note of the field. + SetupTechnique (SetupTechnique): The setup technique. + SSD (float): The Source-to-Skin Distance (SSD). For arc beams, the SSD at the start angle. This value is calculated from the geometrical setup of the beam. + SSDAtStopAngle (float): The Source-to-Skin Distance (SSD) at the stop angle of an arc beam. This value is calculated from the geometrical setup of the beam. + Technique (Technique): The technique used in the planning beam. + ToleranceTableLabel (str): User-defined label for the referenced tolerance table, or an empty string if there is no reference to a tolerance table. + Trays (List[Tray]): A collection of installed trays. + TreatmentTime (float): The treatment time set for the beam in seconds. Plan Approval wizard sets this value by default. + TreatmentUnit (ExternalBeamTreatmentUnit): The external beam treatment unit associated with this beam. + Wedges (List[Wedge]): A collection of installed wedges. + WeightFactor (float): The weight factor of the beam. + """ + def __init__(self) -> None: ... + + Id: str + + Name: str + + Comment: str + + Meterset: MetersetValue + + BeamNumber: int + + Applicator: Applicator + + ArcLength: float + + AreControlPointJawsMoving: bool + + AverageSSD: float + + BeamTechnique: BeamTechnique + + Blocks: List[Block] + + Boluses: List[Bolus] + + CalculationLogs: List[BeamCalculationLog] + + CollimatorRotation: float + + Compensator: Compensator + + ControlPoints: ControlPointCollection + + CreationDateTime: Optional[datetime] + + Dose: BeamDose + + DoseRate: int + + DosimetricLeafGap: float + + EnergyMode: EnergyMode + + EnergyModeDisplayName: str + + FieldReferencePoints: List[FieldReferencePoint] + + GantryDirection: GantryDirection + + HasAllMLCLeavesClosed: bool + + IsGantryExtended: bool + + IsGantryExtendedAtStopAngle: bool + + IsImagingTreatmentField: bool + + IsIMRT: bool + + IsocenterPosition: VVector + + IsSetupField: bool + + MetersetPerGy: float + + MLC: MLC + + MLCPlanType: MLCPlanType + + MLCTransmissionFactor: float + + MotionCompensationTechnique: str + + MotionSignalSource: str + + NormalizationFactor: float + + NormalizationMethod: str + + Plan: PlanSetup + + PlannedSSD: float + + ReferenceImage: Image + + SetupNote: str + + SetupTechnique: SetupTechnique + + SSD: float + + SSDAtStopAngle: float + + Technique: Technique + + ToleranceTableLabel: str + + Trays: List[Tray] + + TreatmentTime: float + + TreatmentUnit: ExternalBeamTreatmentUnit + + Wedges: List[Wedge] + + WeightFactor: float + + Id: str + + Name: str + + Comment: str + + Meterset: MetersetValue + + BeamNumber: int + + Applicator: Applicator + + ArcLength: float + + AreControlPointJawsMoving: bool + + AverageSSD: float + + BeamTechnique: BeamTechnique + + Blocks: List[Block] + + Boluses: List[Bolus] + + CalculationLogs: List[BeamCalculationLog] + + CollimatorRotation: float + + Compensator: Compensator + + ControlPoints: ControlPointCollection + + CreationDateTime: Optional[datetime] + + Dose: BeamDose + + DoseRate: int + + DosimetricLeafGap: float + + EnergyMode: EnergyMode + + EnergyModeDisplayName: str + + FieldReferencePoints: List[FieldReferencePoint] + + GantryDirection: GantryDirection + + HasAllMLCLeavesClosed: bool + + IsGantryExtended: bool + + IsGantryExtendedAtStopAngle: bool + + IsImagingTreatmentField: bool + + IsIMRT: bool + + IsocenterPosition: VVector + + IsSetupField: bool + + MetersetPerGy: float + + MLC: MLC + + MLCPlanType: MLCPlanType + + MLCTransmissionFactor: float + + MotionCompensationTechnique: str + + MotionSignalSource: str + + NormalizationFactor: float + + NormalizationMethod: str + + Plan: PlanSetup + + PlannedSSD: float + + ReferenceImage: Image + + SetupNote: str + + SetupTechnique: SetupTechnique + + SSD: float + + SSDAtStopAngle: float + + Technique: Technique + + ToleranceTableLabel: str + + Trays: List[Tray] + + TreatmentTime: float + + TreatmentUnit: ExternalBeamTreatmentUnit + + Wedges: List[Wedge] + + WeightFactor: float + + # [Availability of this property depends on your Eclipse Scripting API license] Adds a link to bolus. + def AddBolus(self, bolus: Bolus) -> None: + """ + Args: + bolus: The bolus to add. + """ + ... + + + # [Availability of this property depends on your Eclipse Scripting API license] Removes the link to bolus. + def RemoveBolus(self, bolus: Bolus) -> bool: + """ + Args: + bolus: The bolus to remove from the beam. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a link to bolus. + def AddBolus(self, bolusId: str) -> None: + """ + Args: + bolusId: The ID of the bolus to add. The bolus structure must exist in the plan's structure set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a flattening sequence to a static Halcyon field. Throws an exception if the field is not a Halcyon field. + def AddFlatteningSequence(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Modifies the beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. + def ApplyParameters(self, beamParams: BeamParameters) -> None: + """ + Args: + beamParams: The parameters to apply to the beam. + """ + ... + + + # Calculate and get Average Leaf Pair Opening values. ALPO values are calculated on the fly (not serialized). Returns a Dictionary. Key element is the index of carriage group in the field and value element is the ALPO value for that carriage group. + def CalculateAverageLeafPairOpenings(self) -> Dict[int, float]: + ... + + + # Checks if optimal fluence can be set for this beam. + def CanSetOptimalFluence(self, fluence: Fluence, message: str) -> bool: + """ + Args: + fluence: The optimal fluence for the beam. + message: If the optimal fluence cannot be set, contains information about the reason. + """ + ... + + + # Converts the given collimator angle value from the internal IEC scale to the user facing scale of the machine. + def CollimatorAngleToUser(self, val: float) -> float: + """ + Args: + val: Collimator angle value + """ + ... + + + # Counts and returns Subfield count. + def CountSubfields(self) -> int: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the DRR. + def CreateOrReplaceDRR(self, parameters: DRRCalculationParameters) -> Image: + """ + Args: + parameters: DRR calculation parameters + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the collimator to the specified structure + def FitCollimatorToStructure(self, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) -> None: + """ + Args: + margins: Margins used to fit to structure + structure: Structure to fit to + useAsymmetricXJaws: Flag of using asymmetric x jaws + useAsymmetricYJaws: Flag of uisng asymmetric y jaws + optimizeCollimatorRotation: Flag of optimizing collimator angles as fitting result + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with default settings, or with settings from previous fit. + def FitMLCToOutline(self, outline: Array[Array[Windows.Point]]) -> None: + """ + Args: + outline: The shape to fit the MLC leaves to, for example, Block.Outline. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with specified options. + def FitMLCToOutline(self, outline: Array[Array[Windows.Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """ + Args: + outline: The shape to fit the MLC leaves to, for example, Block.Outline. + optimizeCollimatorRotation: Specifies if the MLC rotation is optimized. + jawFit: Controls whether the collimator jaws are positioned to match the MLC outline and how it is done. + olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). + clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves in the beam to a structure with the default settings, or with settings from the previous fit. The margin is zero. + def FitMLCToStructure(self, structure: Structure) -> None: + """ + Args: + structure: The structure to fit the MLC leaves to. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a structure projection on the isocenter plane with the specified margin. + def FitMLCToStructure(self, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """ + Args: + margins: Specifies the margin in all directions. + structure: The structure to fit the MLC leaves to. + optimizeCollimatorRotation: Specify if the MLC rotation is optimized. + jawFit: Controls whether and how the collimator jaws are positioned to match the MLC outline. + olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). + clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). + """ + ... + + + # Converts the given gantry rotation value from the internal IEC scale to the user facing scale of the machine. + def GantryAngleToUser(self, val: float) -> float: + """ + Args: + val: Gantry rotation value + """ + ... + + + # CAX path length in bolus is calculated along the vector spanning from radiation source to first skin contact (as defined by SSD). + def GetCAXPathLengthInBolus(self, bolus: Bolus) -> float: + ... + + + # Returns an editable copy of the beam parameters. The returned BeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another BeamParameters object. + def GetEditableParameters(self) -> BeamParameters: + ... + + + # Gets the optimal fluence for this beam. Returns null if optimal fluence does not exist. + def GetOptimalFluence(self) -> Fluence: + ... + + + # Returns the location of the radiation source at a given gantry angle of the beam. + def GetSourceLocation(self, gantryAngle: float) -> VVector: + """ + Args: + gantryAngle: Gantry angle + """ + ... + + + # Calculates Source To Bolus distance in mm. + def GetSourceToBolusDistance(self, bolus: Bolus) -> float: + ... + + + # If the structure has a segment, gets the outline of the structure on the isocenter plane of the beam. + def GetStructureOutlines(self, structure: Structure, inBEV: bool) -> Array[Array[Windows.Point]]: + """ + Args: + structure: The structure to be projected to the isocenter plane. + inBEV: If true, outlines are returned in the Beams Eye View (BEV) coordinates, where the collimator angle is 0.0 degrees. If false, outlines are returned in beam coordinates. Suitable for use with FitMLCToOutline(...). + """ + ... + + + # Converts the given jaw positions from the internal IEC scale to a string in the user facing scale of the machine. + def JawPositionsToUserString(self, val: VRect[float]) -> str: + """ + Args: + val: Jaw postitions + """ + ... + + + # Converts the given patient support angle value from the internal IEC scale to the user facing scale of the machine. + def PatientSupportAngleToUser(self, val: float) -> float: + """ + Args: + val: Patient support angle value + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the link to bolus. + def RemoveBolus(self, bolusId: str) -> bool: + """ + Args: + bolusId: The ID of the bolus to remove from the beam. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the flattening sequence from a Halcyon field. Throws an exception if the field is not a Halcyon field. + def RemoveFlatteningSequence(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the optimal fluence for this beam. If the fluence is empty (the fluence is null or the dimensions of the fluence matrix are zero) an ArgumentException will be thrown. Setting the optimal fluence for the beam does not clear DVH Estimations of the plan. + def SetOptimalFluence(self, fluence: Fluence) -> None: + """ + Args: + fluence: The optimal fluence to be set. + """ + ... + + + # [Availability of this property depends on your Eclipse Scripting API license] Adds a link to bolus. + def AddBolus(self, bolus: Bolus) -> None: + """ + Args: + bolus: The bolus to add. + """ + ... + + + # [Availability of this property depends on your Eclipse Scripting API license] Removes the link to bolus. + def RemoveBolus(self, bolus: Bolus) -> bool: + """ + Args: + bolus: The bolus to remove from the beam. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a link to bolus. + def AddBolus(self, bolusId: str) -> None: + """ + Args: + bolusId: The ID of the bolus to add. The bolus structure must exist in the plan's structure set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a flattening sequence to a static Halcyon field. Throws an exception if the field is not a Halcyon field. + def AddFlatteningSequence(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Modifies the beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. + def ApplyParameters(self, beamParams: BeamParameters) -> None: + """ + Args: + beamParams: The parameters to apply to the beam. + """ + ... + + + # Calculate and get Average Leaf Pair Opening values. ALPO values are calculated on the fly (not serialized). Returns a Dictionary. Key element is the index of carriage group in the field and value element is the ALPO value for that carriage group. + def CalculateAverageLeafPairOpenings(self) -> Dict[int, float]: + ... + + + # Checks if optimal fluence can be set for this beam. + def CanSetOptimalFluence(self, fluence: Fluence, message: str) -> bool: + """ + Args: + fluence: The optimal fluence for the beam. + message: If the optimal fluence cannot be set, contains information about the reason. + """ + ... + + + # Converts the given collimator angle value from the internal IEC scale to the user facing scale of the machine. + def CollimatorAngleToUser(self, val: float) -> float: + """ + Args: + val: Collimator angle value + """ + ... + + + # Counts and returns Subfield count. + def CountSubfields(self) -> int: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the DRR. + def CreateOrReplaceDRR(self, parameters: DRRCalculationParameters) -> Image: + """ + Args: + parameters: DRR calculation parameters + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the collimator to the specified structure + def FitCollimatorToStructure(self, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) -> None: + """ + Args: + margins: Margins used to fit to structure + structure: Structure to fit to + useAsymmetricXJaws: Flag of using asymmetric x jaws + useAsymmetricYJaws: Flag of uisng asymmetric y jaws + optimizeCollimatorRotation: Flag of optimizing collimator angles as fitting result + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with default settings, or with settings from previous fit. + def FitMLCToOutline(self, outline: Array[Array[Windows.Point]]) -> None: + """ + Args: + outline: The shape to fit the MLC leaves to, for example, Block.Outline. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with specified options. + def FitMLCToOutline(self, outline: Array[Array[Windows.Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """ + Args: + outline: The shape to fit the MLC leaves to, for example, Block.Outline. + optimizeCollimatorRotation: Specifies if the MLC rotation is optimized. + jawFit: Controls whether the collimator jaws are positioned to match the MLC outline and how it is done. + olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). + clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves in the beam to a structure with the default settings, or with settings from the previous fit. The margin is zero. + def FitMLCToStructure(self, structure: Structure) -> None: + """ + Args: + structure: The structure to fit the MLC leaves to. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a structure projection on the isocenter plane with the specified margin. + def FitMLCToStructure(self, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """ + Args: + margins: Specifies the margin in all directions. + structure: The structure to fit the MLC leaves to. + optimizeCollimatorRotation: Specify if the MLC rotation is optimized. + jawFit: Controls whether and how the collimator jaws are positioned to match the MLC outline. + olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). + clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). + """ + ... + + + # Converts the given gantry rotation value from the internal IEC scale to the user facing scale of the machine. + def GantryAngleToUser(self, val: float) -> float: + """ + Args: + val: Gantry rotation value + """ + ... + + + # CAX path length in bolus is calculated along the vector spanning from radiation source to first skin contact (as defined by SSD). + def GetCAXPathLengthInBolus(self, bolus: Bolus) -> float: + ... + + + # Returns an editable copy of the beam parameters. The returned BeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another BeamParameters object. + def GetEditableParameters(self) -> BeamParameters: + ... + + + # Gets the optimal fluence for this beam. Returns null if optimal fluence does not exist. + def GetOptimalFluence(self) -> Fluence: + ... + + + # Returns the location of the radiation source at a given gantry angle of the beam. + def GetSourceLocation(self, gantryAngle: float) -> VVector: + """ + Args: + gantryAngle: Gantry angle + """ + ... + + + # Calculates Source To Bolus distance in mm. + def GetSourceToBolusDistance(self, bolus: Bolus) -> float: + ... + + + # If the structure has a segment, gets the outline of the structure on the isocenter plane of the beam. + def GetStructureOutlines(self, structure: Structure, inBEV: bool) -> Array[Array[Windows.Point]]: + """ + Args: + structure: The structure to be projected to the isocenter plane. + inBEV: If true, outlines are returned in the Beams Eye View (BEV) coordinates, where the collimator angle is 0.0 degrees. If false, outlines are returned in beam coordinates. Suitable for use with FitMLCToOutline(...). + """ + ... + + + # Converts the given jaw positions from the internal IEC scale to a string in the user facing scale of the machine. + def JawPositionsToUserString(self, val: VRect[float]) -> str: + """ + Args: + val: Jaw postitions + """ + ... + + + # Converts the given patient support angle value from the internal IEC scale to the user facing scale of the machine. + def PatientSupportAngleToUser(self, val: float) -> float: + """ + Args: + val: Patient support angle value + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the link to bolus. + def RemoveBolus(self, bolusId: str) -> bool: + """ + Args: + bolusId: The ID of the bolus to remove from the beam. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the flattening sequence from a Halcyon field. Throws an exception if the field is not a Halcyon field. + def RemoveFlatteningSequence(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the optimal fluence for this beam. If the fluence is empty (the fluence is null or the dimensions of the fluence matrix are zero) an ArgumentException will be thrown. Setting the optimal fluence for the beam does not clear DVH Estimations of the plan. + def SetOptimalFluence(self, fluence: Fluence) -> None: + """ + Args: + fluence: The optimal fluence to be set. + """ + ... + + + +class Course: + """ + A course represents the course of treatment that a patient will be given. Every patient must have a course, and all plans always belong to a course. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Course. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Course. + ExternalPlanSetups (List[ExternalPlanSetup]): A collection of external beam plans for the course. + BrachyPlanSetups (List[BrachyPlanSetup]): A collection of brachytherapy plans for the course. + IonPlanSetups (List[IonPlanSetup]): A collection of proton plans for the course. + ClinicalStatus (CourseClinicalStatus): Clinical Status of Course. + CompletedDateTime (Optional[datetime]): The date and time when the course was completed. + Diagnoses (List[Diagnosis]): The diagnoses that are attached to the course. + Intent (str): The intent of the course. + Patient (Patient): Patient in which the course is defined. + PlanSetups (List[PlanSetup]): A collection of plans for the course. The plans can be of any type (external beam or brachytherapy). + PlanSums (List[PlanSum]): A collection of plan sums for the course. + StartDateTime (Optional[datetime]): The date and time when the course was started. + TreatmentPhases (List[TreatmentPhase]): All treatment phases in the course. + TreatmentSessions (List[TreatmentSession]): Treatment sessions of the course. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Course. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Course. + ExternalPlanSetups (List[ExternalPlanSetup]): A collection of external beam plans for the course. + BrachyPlanSetups (List[BrachyPlanSetup]): A collection of brachytherapy plans for the course. + IonPlanSetups (List[IonPlanSetup]): A collection of proton plans for the course. + ClinicalStatus (CourseClinicalStatus): Clinical Status of Course. + CompletedDateTime (Optional[datetime]): The date and time when the course was completed. + Diagnoses (List[Diagnosis]): The diagnoses that are attached to the course. + Intent (str): The intent of the course. + Patient (Patient): Patient in which the course is defined. + PlanSetups (List[PlanSetup]): A collection of plans for the course. The plans can be of any type (external beam or brachytherapy). + PlanSums (List[PlanSum]): A collection of plan sums for the course. + StartDateTime (Optional[datetime]): The date and time when the course was started. + TreatmentPhases (List[TreatmentPhase]): All treatment phases in the course. + TreatmentSessions (List[TreatmentSession]): Treatment sessions of the course. + """ + def __init__(self) -> None: ... + + Id: str + + Comment: str + + ExternalPlanSetups: List[ExternalPlanSetup] + + BrachyPlanSetups: List[BrachyPlanSetup] + + IonPlanSetups: List[IonPlanSetup] + + ClinicalStatus: CourseClinicalStatus + + CompletedDateTime: Optional[datetime] + + Diagnoses: List[Diagnosis] + + Intent: str + + Patient: Patient + + PlanSetups: List[PlanSetup] + + PlanSums: List[PlanSum] + + StartDateTime: Optional[datetime] + + TreatmentPhases: List[TreatmentPhase] + + TreatmentSessions: List[TreatmentSession] + + Id: str + + Comment: str + + ExternalPlanSetups: List[ExternalPlanSetup] + + BrachyPlanSetups: List[BrachyPlanSetup] + + IonPlanSetups: List[IonPlanSetup] + + ClinicalStatus: CourseClinicalStatus + + CompletedDateTime: Optional[datetime] + + Diagnoses: List[Diagnosis] + + Intent: str + + Patient: Patient + + PlanSetups: List[PlanSetup] + + PlanSums: List[PlanSum] + + StartDateTime: Optional[datetime] + + TreatmentPhases: List[TreatmentPhase] + + TreatmentSessions: List[TreatmentSession] + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan sum from given planning items. + def CreatePlanSum(self, planningItems: List[PlanningItem], image: Image) -> PlanSum: + """ + Args: + planningItems: Items to create sum from. All plans must share the same image, otherwise please use + image: Plan Sum image + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course with target, primary reference point and additional reference points in arguments + def AddExternalPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: List[ReferencePoint]) -> ExternalPlanSetup: + """ + Args: + structureSet: Valid StructureSet to connected with the plan + targetStructure: Target structure, if defined must be from 'structureSet', if left null target will remain unset. + primaryReferencePoint: Valid reference point to be connected as primary. + additionalReferencePoints: Collection of additional valid reference points + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course with the target structure, primary reference point and additional reference points specified in arguments. + def AddBrachyPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: DoseValue, dosePerFraction: BrachyTreatmentTechniqueType, brachyTreatmentTechnique: List[ReferencePoint]) -> BrachyPlanSetup: + """ + Args: + structureSet: Valid StructureSet to be connected to the plan + targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. + primaryReferencePoint: Valid reference point to be connected as primary reference point. + additionalReferencePoints: Collection of additional valid reference points + dosePerFraction: Dose per fraction + brachyTreatmentTechnique: Brachytherapy treatment technique + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. + def AddIonPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, patientSupportDeviceId: ReferencePoint, primaryReferencePoint: str, additionalReferencePoints: List[ReferencePoint]) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. + patientSupportDeviceId: Id of the patient support device. + primaryReferencePoint: Valid reference point to be connected as primary. + additionalReferencePoints: Collection of additional valid reference points + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course. A new primary reference point is always created for the new brachytherapy plan. + def AddBrachyPlanSetup(self, structureSet: StructureSet, dosePerFraction: DoseValue, brachyTreatmentTechnique: BrachyTreatmentTechniqueType) -> BrachyPlanSetup: + """ + Args: + structureSet: A valid StructureSet to be connected to the plan. + dosePerFraction: Dose per fraction + brachyTreatmentTechnique: Brachytherapy treatment technique + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course. A new primary reference point is always created for the new plan. + def AddExternalPlanSetup(self, structureSet: StructureSet) -> ExternalPlanSetup: + """ + Args: + structureSet: A valid structure set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the verified plan and a new plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. + def AddExternalPlanSetupAsVerificationPlan(self, structureSet: StructureSet, verifiedPlan: ExternalPlanSetup) -> ExternalPlanSetup: + """ + Args: + structureSet: A valid structure set. + verifiedPlan: The verified plan. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. + def AddIonPlanSetup(self, structureSet: StructureSet, patientSupportDeviceId: str) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + patientSupportDeviceId: Id of the patient support device. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the proton plan to be verified and the new verification plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. + def AddIonPlanSetupAsVerificationPlan(self, structureSet: StructureSet, patientSupportDeviceId: str, verifiedPlan: IonPlanSetup) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + patientSupportDeviceId: Id of the patient support device. + verifiedPlan: The verified plan. + """ + ... + + + # Checks if a new plan can be added to this course using the given structure set. + def CanAddPlanSetup(self, structureSet: StructureSet) -> bool: + """ + Args: + structureSet: The structure set used by the plan. + """ + ... + + + # Checks if the plan setup can be removed from this course. + def CanRemovePlanSetup(self, planSetup: PlanSetup) -> bool: + """ + Args: + planSetup: The plan setup to check. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan (the planning image will be the same for both plans). + def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: + """ + Args: + sourcePlan: Brachy plan to copy from + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with the primary image of the sourcePlan. First copies image and then changes planning image. + def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: + """ + Args: + sourcePlan: Brachy plan to copy from + structureset: The structure set along with its associated image that will be assigned to the copied plan + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan (the planning image will be the same for both plans). + def CopyPlanSetup(self, sourcePlan: PlanSetup) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. If there are multiple registrations, just copies isocenter locations and shows a message about this. + def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + targetImage: Image to copy plan to + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. + def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, registration: Registration, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + targetImage: Image to copy plan to + registration: Registration to use to map geometry from source to target + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. + def CopyPlanSetup(self, sourcePlan: PlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + structureset: The structure set along with its associated image that will be assigned to the copied plan + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # Checks if the clinical status of the course is completed or restored. + def IsCompleted(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan setup from the database. Use + def RemovePlanSetup(self, planSetup: PlanSetup) -> None: + """ + Args: + planSetup: The plan setup that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan sum from the database. The PlanSum object given as a parameter is not usable anymore after this operation. + def RemovePlanSum(self, planSum: PlanSum) -> None: + """ + Args: + planSum: The plan sum that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan sum from given planning items. + def CreatePlanSum(self, planningItems: List[PlanningItem], image: Image) -> PlanSum: + """ + Args: + planningItems: Items to create sum from. All plans must share the same image, otherwise please use + image: Plan Sum image + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course with target, primary reference point and additional reference points in arguments + def AddExternalPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: List[ReferencePoint]) -> ExternalPlanSetup: + """ + Args: + structureSet: Valid StructureSet to connected with the plan + targetStructure: Target structure, if defined must be from 'structureSet', if left null target will remain unset. + primaryReferencePoint: Valid reference point to be connected as primary. + additionalReferencePoints: Collection of additional valid reference points + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course with the target structure, primary reference point and additional reference points specified in arguments. + def AddBrachyPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: DoseValue, dosePerFraction: BrachyTreatmentTechniqueType, brachyTreatmentTechnique: List[ReferencePoint]) -> BrachyPlanSetup: + """ + Args: + structureSet: Valid StructureSet to be connected to the plan + targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. + primaryReferencePoint: Valid reference point to be connected as primary reference point. + additionalReferencePoints: Collection of additional valid reference points + dosePerFraction: Dose per fraction + brachyTreatmentTechnique: Brachytherapy treatment technique + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. + def AddIonPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, patientSupportDeviceId: ReferencePoint, primaryReferencePoint: str, additionalReferencePoints: List[ReferencePoint]) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. + patientSupportDeviceId: Id of the patient support device. + primaryReferencePoint: Valid reference point to be connected as primary. + additionalReferencePoints: Collection of additional valid reference points + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course. A new primary reference point is always created for the new brachytherapy plan. + def AddBrachyPlanSetup(self, structureSet: StructureSet, dosePerFraction: DoseValue, brachyTreatmentTechnique: BrachyTreatmentTechniqueType) -> BrachyPlanSetup: + """ + Args: + structureSet: A valid StructureSet to be connected to the plan. + dosePerFraction: Dose per fraction + brachyTreatmentTechnique: Brachytherapy treatment technique + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course. A new primary reference point is always created for the new plan. + def AddExternalPlanSetup(self, structureSet: StructureSet) -> ExternalPlanSetup: + """ + Args: + structureSet: A valid structure set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the verified plan and a new plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. + def AddExternalPlanSetupAsVerificationPlan(self, structureSet: StructureSet, verifiedPlan: ExternalPlanSetup) -> ExternalPlanSetup: + """ + Args: + structureSet: A valid structure set. + verifiedPlan: The verified plan. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. + def AddIonPlanSetup(self, structureSet: StructureSet, patientSupportDeviceId: str) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + patientSupportDeviceId: Id of the patient support device. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the proton plan to be verified and the new verification plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. + def AddIonPlanSetupAsVerificationPlan(self, structureSet: StructureSet, patientSupportDeviceId: str, verifiedPlan: IonPlanSetup) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + patientSupportDeviceId: Id of the patient support device. + verifiedPlan: The verified plan. + """ + ... + + + # Checks if a new plan can be added to this course using the given structure set. + def CanAddPlanSetup(self, structureSet: StructureSet) -> bool: + """ + Args: + structureSet: The structure set used by the plan. + """ + ... + + + # Checks if the plan setup can be removed from this course. + def CanRemovePlanSetup(self, planSetup: PlanSetup) -> bool: + """ + Args: + planSetup: The plan setup to check. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan (the planning image will be the same for both plans). + def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: + """ + Args: + sourcePlan: Brachy plan to copy from + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with the primary image of the sourcePlan. First copies image and then changes planning image. + def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: + """ + Args: + sourcePlan: Brachy plan to copy from + structureset: The structure set along with its associated image that will be assigned to the copied plan + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan (the planning image will be the same for both plans). + def CopyPlanSetup(self, sourcePlan: PlanSetup) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. If there are multiple registrations, just copies isocenter locations and shows a message about this. + def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + targetImage: Image to copy plan to + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. + def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, registration: Registration, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + targetImage: Image to copy plan to + registration: Registration to use to map geometry from source to target + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. + def CopyPlanSetup(self, sourcePlan: PlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + structureset: The structure set along with its associated image that will be assigned to the copied plan + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # Checks if the clinical status of the course is completed or restored. + def IsCompleted(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan setup from the database. Use + def RemovePlanSetup(self, planSetup: PlanSetup) -> None: + """ + Args: + planSetup: The plan setup that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan sum from the database. The PlanSum object given as a parameter is not usable anymore after this operation. + def RemovePlanSum(self, planSum: PlanSum) -> None: + """ + Args: + planSum: The plan sum that is removed. + """ + ... + + + +class CustomScriptExecutable: + """ + A factory class for creating an application object for a custom script executable. + """ + def __init__(self) -> None: ... + + # Creates an application object for a custom executable and logs it into the system. Application object created by this method can be used when the executable itself is not a script. For example, an interpreter of a high level programming language, or a native C++ application that integrates into .NET and uses ESAPI. The scripts executed with this application object are always read-only in a clinical environment, and writable in a non-clinical environment. + def CreateApplication(self, scriptName: str) -> Application: + """ + Args: + scriptName: The script name for logging in. Preferably use the full absolute path. + """ + ... + + + # Creates an application object for a custom executable and logs it into the system. Application object created by this method can be used when the executable itself is not a script. For example, an interpreter of a high level programming language, or a native C++ application that integrates into .NET and uses ESAPI. The scripts executed with this application object are always read-only in a clinical environment, and writable in a non-clinical environment. + def CreateApplication(self, scriptName: str) -> Application: + """ + Args: + scriptName: The script name for logging in. Preferably use the full absolute path. + """ + ... + + + +class IonPlanSetup: + """ + Represents a proton treatment plan. + + Attributes: + IsPostProcessingNeeded (bool): Instructs whether to include the post-processing of scanning spots in proton dose calculation. + CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. + DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by + IonBeams (List[IonBeam]): Gets the proton beams of the plan. + IsPostProcessingNeeded (bool): Instructs whether to include the post-processing of scanning spots in proton dose calculation. + CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. + DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by + IonBeams (List[IonBeam]): Gets the proton beams of the plan. + """ + def __init__(self) -> None: ... + + IsPostProcessingNeeded: bool + + CalculatePlanUncertaintyDose: bool + + DoseAsEvaluationDose: EvaluationDose + + IonBeams: List[IonBeam] + + IsPostProcessingNeeded: bool + + CalculatePlanUncertaintyDose: bool + + DoseAsEvaluationDose: EvaluationDose + + IonBeams: List[IonBeam] + + # [Availability of this property depends on your Eclipse Scripting API license] Creates a new proton verification plan that is a copy of this plan and that has dose calculated using the DECT proton stopping power values calculated based on the input images "rhoImage" and "zImage". + def CreateDectVerificationPlan(self, rhoImage: Image, zImage: Image) -> IonPlanSetup: + """ + Args: + rhoImage: A DECT relative electron density image where the value each voxel is interpreted as rho = 0.001 * (value + 1000). + zImage: A DECT effective atomic number image. + """ + ... + + + # This method is used to remove the temporary DECT objects under the DECT-study that was created for intermediate dose calculation. The method should be called only after the dose calculation is done, otherwise the intermediate dose is disposed too early. The temporary objects should be removed because they contain virtual CT images we do not want ending into the database. + def RemoveTemporaryObjects(self) -> Any: + ... + + + # Checks whether the proton volume dose calculation model attached to this plan is Proton Convolution Superposition. + def CheckDectCompatibleDoseCalcModel(self) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam line for the proton plan. + def CalculateBeamLine(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the proton plan. + def CalculateDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the proton plan. + def CalculatePlanUncertaintyDoses(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs IMPT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeIMPT(self, options: OptimizationOptionsIMPT) -> OptimizerResult: + """ + Args: + options: IMPT optimization options. + """ + ... + + + # Post-processes the proton plan by creating a final spot list, and calculates the dose. + def PostProcessAndCalculateDose(self) -> CalculationResult: + ... + + + # Calculates the dose for a proton plan without post-processing. The existing final spot list is used, and no new list is created during the calculation. + def CalculateDoseWithoutPostProcessing(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam delivery dynamics for the final spot list of a proton plan. + def CalculateBeamDeliveryDynamics(self) -> CalculationResult: + ... + + + # Returns a list of calculation models for the given calculation type. + def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new proton modulated scanning beam to the plan. + def AddModulatedScanningBeam(self, machineParameters: ProtonBeamMachineParameters, snoutId: str, snoutPosition: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See ExternalBeamMachineParameters. + snoutId: Snout ID. + snoutPosition: Snout position in centimeters. + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. + def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: + """ + Args: + existing: The dose matrix is copied from this object. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the + def CreateEvaluationDose(self) -> EvaluationDose: + ... + + + # Get information on whether the plan is optimized using multi-field optimization or single-field optimization. + def GetOptimizationMode(self) -> IonPlanOptimizationMode: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Set the plan normalization. See cref="PlanNormalizationMode" for the supported plan normalization methods. + def SetNormalization(self, normalizationParameters: IonPlanNormalizationParameters) -> None: + """ + Args: + normalizationParameters: Normalization parameters + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Set proton optimization to use either multi-field or single-field optimization. + def SetOptimizationMode(self, mode: IonPlanOptimizationMode) -> None: + """ + Args: + mode: Set the parameter to MultiFieldOptimization to use multi-field optimization and set to SingleFieldOptimization to use single-field optimization. + """ + ... + + + # [Availability of this property depends on your Eclipse Scripting API license] Creates a new proton verification plan that is a copy of this plan and that has dose calculated using the DECT proton stopping power values calculated based on the input images "rhoImage" and "zImage". + def CreateDectVerificationPlan(self, rhoImage: Image, zImage: Image) -> IonPlanSetup: + """ + Args: + rhoImage: A DECT relative electron density image where the value each voxel is interpreted as rho = 0.001 * (value + 1000). + zImage: A DECT effective atomic number image. + """ + ... + + + # This method is used to remove the temporary DECT objects under the DECT-study that was created for intermediate dose calculation. The method should be called only after the dose calculation is done, otherwise the intermediate dose is disposed too early. The temporary objects should be removed because they contain virtual CT images we do not want ending into the database. + def RemoveTemporaryObjects(self) -> Any: + ... + + + # Checks whether the proton volume dose calculation model attached to this plan is Proton Convolution Superposition. + def CheckDectCompatibleDoseCalcModel(self) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam line for the proton plan. + def CalculateBeamLine(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the proton plan. + def CalculateDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the proton plan. + def CalculatePlanUncertaintyDoses(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs IMPT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeIMPT(self, options: OptimizationOptionsIMPT) -> OptimizerResult: + """ + Args: + options: IMPT optimization options. + """ + ... + + + # Post-processes the proton plan by creating a final spot list, and calculates the dose. + def PostProcessAndCalculateDose(self) -> CalculationResult: + ... + + + # Calculates the dose for a proton plan without post-processing. The existing final spot list is used, and no new list is created during the calculation. + def CalculateDoseWithoutPostProcessing(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam delivery dynamics for the final spot list of a proton plan. + def CalculateBeamDeliveryDynamics(self) -> CalculationResult: + ... + + + # Returns a list of calculation models for the given calculation type. + def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new proton modulated scanning beam to the plan. + def AddModulatedScanningBeam(self, machineParameters: ProtonBeamMachineParameters, snoutId: str, snoutPosition: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See ExternalBeamMachineParameters. + snoutId: Snout ID. + snoutPosition: Snout position in centimeters. + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. + def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: + """ + Args: + existing: The dose matrix is copied from this object. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the + def CreateEvaluationDose(self) -> EvaluationDose: + ... + + + # Get information on whether the plan is optimized using multi-field optimization or single-field optimization. + def GetOptimizationMode(self) -> IonPlanOptimizationMode: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Set the plan normalization. See cref="PlanNormalizationMode" for the supported plan normalization methods. + def SetNormalization(self, normalizationParameters: IonPlanNormalizationParameters) -> None: + """ + Args: + normalizationParameters: Normalization parameters + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Set proton optimization to use either multi-field or single-field optimization. + def SetOptimizationMode(self, mode: IonPlanOptimizationMode) -> None: + """ + Args: + mode: Set the parameter to MultiFieldOptimization to use multi-field optimization and set to SingleFieldOptimization to use single-field optimization. + """ + ... + + + +class Dose: + """ + Represents a 3D dose grid. + + Attributes: + DoseMax3D (DoseValue): The maximum dose. + DoseMax3DLocation (VVector): The location of the maximum dose. + Isodoses (List[Isodose]): A collection of isodoses. + Origin (VVector): The origin of the dose matrix. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first dose plane. + Series (Series): Returns the series that contains the dose, or null if the dose is not connected to a series. + SeriesUID (str): Returns the DICOM UID of the series that contains the dose, or an empty string if the dose is not connected to a series. + UID (str): The DICOM UID of the dose. + XDirection (VVector): The direction of the x-axis in the dose matrix. + XRes (float): The dose matrix resolution in X-direction in millimeters. + XSize (int): The dose matrix size in X-direction in voxels. + YDirection (VVector): The direction of the y-axis in the dose matrix. + YRes (float): The dose matrix resolution in Y-direction in millimeters. + YSize (int): The dose matrix size in Y-direction in voxels. + ZDirection (VVector): The direction of the z-axis in the dose matrix. + ZRes (float): The dose matrix resolution in Z-direction in millimeters. + ZSize (int): The dose matrix size in Z-direction in voxels. + DoseMax3D (DoseValue): The maximum dose. + DoseMax3DLocation (VVector): The location of the maximum dose. + Isodoses (List[Isodose]): A collection of isodoses. + Origin (VVector): The origin of the dose matrix. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first dose plane. + Series (Series): Returns the series that contains the dose, or null if the dose is not connected to a series. + SeriesUID (str): Returns the DICOM UID of the series that contains the dose, or an empty string if the dose is not connected to a series. + UID (str): The DICOM UID of the dose. + XDirection (VVector): The direction of the x-axis in the dose matrix. + XRes (float): The dose matrix resolution in X-direction in millimeters. + XSize (int): The dose matrix size in X-direction in voxels. + YDirection (VVector): The direction of the y-axis in the dose matrix. + YRes (float): The dose matrix resolution in Y-direction in millimeters. + YSize (int): The dose matrix size in Y-direction in voxels. + ZDirection (VVector): The direction of the z-axis in the dose matrix. + ZRes (float): The dose matrix resolution in Z-direction in millimeters. + ZSize (int): The dose matrix size in Z-direction in voxels. + """ + def __init__(self) -> None: ... + + DoseMax3D: DoseValue + + DoseMax3DLocation: VVector + + Isodoses: List[Isodose] + + Origin: VVector + + Series: Series + + SeriesUID: str + + UID: str + + XDirection: VVector + + XRes: float + + XSize: int + + YDirection: VVector + + YRes: float + + YSize: int + + ZDirection: VVector + + ZRes: float + + ZSize: int + + DoseMax3D: DoseValue + + DoseMax3DLocation: VVector + + Isodoses: List[Isodose] + + Origin: VVector + + Series: Series + + SeriesUID: str + + UID: str + + XDirection: VVector + + XRes: float + + XSize: int + + YDirection: VVector + + YRes: float + + YSize: int + + ZDirection: VVector + + ZRes: float + + ZSize: int + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Gets the dose profile. + def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # Gets the point dose at a specified location. + def GetDoseToPoint(self, at: VVector) -> DoseValue: + """ + Args: + at: Location + """ + ... + + + # Gets the voxels of the given dose plane. + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """ + Args: + planeIndex: Zero based index of the plane. + preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this dose. + """ + ... + + + # Converts the given raw voxel value to the corresponding dose value. + def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: + """ + Args: + voxelValue: Voxel value. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Gets the dose profile. + def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # Gets the point dose at a specified location. + def GetDoseToPoint(self, at: VVector) -> DoseValue: + """ + Args: + at: Location + """ + ... + + + # Gets the voxels of the given dose plane. + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """ + Args: + planeIndex: Zero based index of the plane. + preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this dose. + """ + ... + + + # Converts the given raw voxel value to the corresponding dose value. + def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: + """ + Args: + voxelValue: Voxel value. + """ + ... + + + +class DVHEstimationModelStructure: + """ + Structure of a DVH estimation model in Planning Model Library + + Attributes: + Id (str): Id of the structure + IsValid (bool): Is Valid + ModelStructureGuid (str): Model Id + StructureCodes (List[StructureCode]): List of structure codes associated with the structure + StructureType (DVHEstimationStructureType): Structure type: PTV or OAR + Id (str): Id of the structure + IsValid (bool): Is Valid + ModelStructureGuid (str): Model Id + StructureCodes (List[StructureCode]): List of structure codes associated with the structure + StructureType (DVHEstimationStructureType): Structure type: PTV or OAR + """ + # Public constructor + @overload + def __init__(self, impl: IDVHEstimationModelStructure) -> None: + """ + Args: + impl: IDVHEstimationModelStructure object + """ + ... + + + # Public constructor + @overload + def __init__(self, impl: IDVHEstimationModelStructure) -> None: + """ + Args: + impl: IDVHEstimationModelStructure object + """ + ... + + + Id: str + + IsValid: bool + + ModelStructureGuid: str + + StructureCodes: List[StructureCode] + + StructureType: DVHEstimationStructureType + + Id: str + + IsValid: bool + + ModelStructureGuid: str + + StructureCodes: List[StructureCode] + + StructureType: DVHEstimationStructureType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Equipment: + """ + Provides access to clinical devices and accessories. + """ + # Equipment object constructor. + @overload + def __init__(self, admin: IAdmin) -> None: + """ + Args: + admin: An IAdmin object for accessing equipment data. + """ + ... + + + # Equipment object constructor. + @overload + def __init__(self, admin: IAdmin) -> None: + """ + Args: + admin: An IAdmin object for accessing equipment data. + """ + ... + + + # Returns the available brachy treatment units. Excludes virtual and deleted ones. + def GetBrachyTreatmentUnits(self) -> List[BrachyTreatmentUnit]: + ... + + + # Returns the available External Beam treatment units. Excludes virtual and deleted ones. + def GetExternalBeamTreatmentUnits(self) -> List[ExternalBeamTreatmentUnit]: + ... + + + # Returns the available brachy treatment units. Excludes virtual and deleted ones. + def GetBrachyTreatmentUnits(self) -> List[BrachyTreatmentUnit]: + ... + + + # Returns the available External Beam treatment units. Excludes virtual and deleted ones. + def GetExternalBeamTreatmentUnits(self) -> List[ExternalBeamTreatmentUnit]: + ... + + + +class ESAPIActionPackAttribute: + """ + Specifies the assembly as an Eclipse visual scripting action pack. Action packs are ESAPI scripts that are used by visual scripts. + + Attributes: + IsWriteable (bool): Returns true if the action pack can modify patient data. + IsWriteable (bool): Returns true if the action pack can modify patient data. + """ + def __init__(self) -> None: ... + + IsWriteable: bool + + IsWriteable: bool + + +class ESAPIScriptAttribute: + """ + Specifies the assembly as an Eclipse Scripting API (ESAPI) script. + + Attributes: + IsWriteable (bool): Returns true if the script can modify patient data. + IsWriteable (bool): Returns true if the script can modify patient data. + """ + def __init__(self) -> None: ... + + IsWriteable: bool + + IsWriteable: bool + + +class OptimizerDVH: + """ + Contains a structure-specific Dose Volume Histogram (DVH) curve generated in optimization. + + Attributes: + CurveData (Array[DVHPoint]): An array of DVH points representing the DVH curve data. + Structure (Structure): The corresponding structure for the DVH curve data. + CurveData (Array[DVHPoint]): An array of DVH points representing the DVH curve data. + Structure (Structure): The corresponding structure for the DVH curve data. + """ + def __init__(self) -> None: ... + + CurveData: Array[DVHPoint] + + Structure: Structure + + CurveData: Array[DVHPoint] + + Structure: Structure + + +class OptimizerObjectiveValue: + """ + The optimizer objective function value for the structure. + + Attributes: + Structure (Structure): The corresponding structure for the objective function value. + Value (float): The objective function value. + Structure (Structure): The corresponding structure for the objective function value. + Value (float): The objective function value. + """ + def __init__(self) -> None: ... + + Structure: Structure + + Value: float + + Structure: Structure + + Value: float + + +class ExternalPlanSetup: + """ + Represents an external beam plan. For more information, see the definition of the DICOM RT Plan. + + Attributes: + TradeoffExplorationContext (TradeoffExplorationContext): [Availability of this property depends on your Eclipse Scripting API license] Gets the + CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. + DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by + TradeoffExplorationContext (TradeoffExplorationContext): [Availability of this property depends on your Eclipse Scripting API license] Gets the + CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. + DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by + """ + def __init__(self) -> None: ... + + TradeoffExplorationContext: TradeoffExplorationContext + + CalculatePlanUncertaintyDose: bool + + DoseAsEvaluationDose: EvaluationDose + + TradeoffExplorationContext: TradeoffExplorationContext + + CalculatePlanUncertaintyDose: bool + + DoseAsEvaluationDose: EvaluationDose + + # Calculates the dose for the plan with preset meterset values. This applies only to IMRT beams. + def CalculateDoseWithPresetValues(self, presetValues: List[KeyValuePair[str, MetersetValue]]) -> CalculationResult: + """ + Args: + presetValues: The list of preset meterset values for the beams. An element of the list should contain a pair consisting of the beam identifier (as the key) and the corresponding preset meterset value for the beam. Each beam in the plan must have one entry in the list. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the plan. + def CalculateDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the photon plan. + def CalculatePlanUncertaintyDoses(self) -> CalculationResult: + ... + + + # Calculate leaf motions and dose using the calculation models defined in the plan setup. + def CalculateLeafMotionsAndDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. + def CalculateLeafMotions(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Leaf Motion Calculator (LMCV). + def CalculateLeafMotions(self, options: LMCVOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the Varian Leaf Motion Calculator (LMCV) algorithm. + """ + ... + + + # Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Smart LMC. + def CalculateLeafMotions(self, options: SmartLMCOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the Varian Smart LMC algorithm. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be MSS Leaf Motion Calculator (LMCMSS). + def CalculateLeafMotions(self, options: LMCMSSOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the MSS Leaf Motion Calculator (LMCMSS) algorithm. + """ + ... + + + # Returns a list of calculation models for the given calculation type. + def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Runs IMRT optimization for the plan setup. All existing optimal fluences are removed from the beams. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + """ + ... + + + # Runs IMRT optimization for the plan setup. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + optimizationOption: Optimization options. + """ + ... + + + # Runs IMRT optimization for the plan setup. You can add the Multileaf Collimator (MLC) as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption, mlcId: str) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + optimizationOption: Optimization option specifying the initial state. + mlcId: The identifier for the Multileaf Collimator (MLC). + """ + ... + + + # Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self) -> OptimizerResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs IMRT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, options: OptimizationOptionsIMRT) -> OptimizerResult: + """ + Args: + options: Options specifying initial state, intermediate dose, and termination upon convergence. + """ + ... + + + # This method is used to remove the temporary copy of the original IPlanSetup object that was created for intermediate dose calculation. The method should be called only after the optimization is done, otherwise the intermediate dose is disposed too early. The temporary copy should be removed because it is copy of an existing plan and this might cause problems when saving other plans to database, e.g., in automated validation tests. The plan is removed in the same way as in the optimization client for Eclipse. + def RemoveTemporaryPlan(self) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. You can add the MLC as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self, mlcId: str) -> OptimizerResult: + """ + Args: + mlcId: The identifier for the Multileaf Collimator (MLC). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self) -> OptimizerResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup using intermediate dose calculation. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self, options: OptimizationOptionsVMAT) -> OptimizerResult: + """ + Args: + options: VMAT optimization options. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam to the plan. + def AddArcBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new conformal arc beam to the plan. + def AddConformalArcBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, controlPointCount: int, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + controlPointCount: The number of control points to use. + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new fixed sequence (flattening sequence) beam to the plan. + def AddFixedSequenceBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, gantryAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds new imaging beam or beams to the plan. First removes the existing imaging beams. If MV imaging beams are involved, the plan should be optimized again. + def AddImagingSetup(self, machineParameters: ExternalBeamMachineParameters, setupParameters: ImagingBeamSetupParameters, targetStructure: Structure) -> bool: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + setupParameters: Setup parameters for the imaging beam. See + targetStructure: Target structure for imaging. If not specified, the target structure in the plan is used. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam with an MLC to the plan. + def AddMLCArcBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam with an MLC to the plan. + def AddMLCBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field with an MLC to the plan. + def AddMLCSetupBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Multiple Static Segments as the delivery technique. + def AddMultipleStaticSegmentBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field to the plan. + def AddSetupBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Sliding Window as the delivery technique. + def AddSlidingWindowBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new sliding window IMRT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. + def AddSlidingWindowBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: Gantry angle in the IEC GANTRY coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static beam to the plan. + def AddStaticBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam to the plan. + def AddVMATBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. + def AddVMATBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryStartAngle: float, gantryStopAngle: float, gantryDir: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryStartAngle: Gantry start angle in the IEC GANTRY coordinate system (in degrees). + gantryStopAngle: Gantry stop angle in the IEC GANTRY coordinate system (in degrees). + gantryDir: Gantry direction + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. + def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: + """ + Args: + existing: The dose matrix is copied from this object. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the + def CreateEvaluationDose(self) -> EvaluationDose: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes a beam from the plan. + def RemoveBeam(self, beam: Beam) -> None: + """ + Args: + beam: The beam that will be removed from the plan. + """ + ... + + + # Calculates the dose for the plan with preset meterset values. This applies only to IMRT beams. + def CalculateDoseWithPresetValues(self, presetValues: List[KeyValuePair[str, MetersetValue]]) -> CalculationResult: + """ + Args: + presetValues: The list of preset meterset values for the beams. An element of the list should contain a pair consisting of the beam identifier (as the key) and the corresponding preset meterset value for the beam. Each beam in the plan must have one entry in the list. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the plan. + def CalculateDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the photon plan. + def CalculatePlanUncertaintyDoses(self) -> CalculationResult: + ... + + + # Calculate leaf motions and dose using the calculation models defined in the plan setup. + def CalculateLeafMotionsAndDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. + def CalculateLeafMotions(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Leaf Motion Calculator (LMCV). + def CalculateLeafMotions(self, options: LMCVOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the Varian Leaf Motion Calculator (LMCV) algorithm. + """ + ... + + + # Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Smart LMC. + def CalculateLeafMotions(self, options: SmartLMCOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the Varian Smart LMC algorithm. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be MSS Leaf Motion Calculator (LMCMSS). + def CalculateLeafMotions(self, options: LMCMSSOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the MSS Leaf Motion Calculator (LMCMSS) algorithm. + """ + ... + + + # Returns a list of calculation models for the given calculation type. + def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Runs IMRT optimization for the plan setup. All existing optimal fluences are removed from the beams. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + """ + ... + + + # Runs IMRT optimization for the plan setup. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + optimizationOption: Optimization options. + """ + ... + + + # Runs IMRT optimization for the plan setup. You can add the Multileaf Collimator (MLC) as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption, mlcId: str) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + optimizationOption: Optimization option specifying the initial state. + mlcId: The identifier for the Multileaf Collimator (MLC). + """ + ... + + + # Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self) -> OptimizerResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs IMRT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, options: OptimizationOptionsIMRT) -> OptimizerResult: + """ + Args: + options: Options specifying initial state, intermediate dose, and termination upon convergence. + """ + ... + + + # This method is used to remove the temporary copy of the original IPlanSetup object that was created for intermediate dose calculation. The method should be called only after the optimization is done, otherwise the intermediate dose is disposed too early. The temporary copy should be removed because it is copy of an existing plan and this might cause problems when saving other plans to database, e.g., in automated validation tests. The plan is removed in the same way as in the optimization client for Eclipse. + def RemoveTemporaryPlan(self) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. You can add the MLC as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self, mlcId: str) -> OptimizerResult: + """ + Args: + mlcId: The identifier for the Multileaf Collimator (MLC). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self) -> OptimizerResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup using intermediate dose calculation. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self, options: OptimizationOptionsVMAT) -> OptimizerResult: + """ + Args: + options: VMAT optimization options. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam to the plan. + def AddArcBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new conformal arc beam to the plan. + def AddConformalArcBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, controlPointCount: int, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + controlPointCount: The number of control points to use. + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new fixed sequence (flattening sequence) beam to the plan. + def AddFixedSequenceBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, gantryAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds new imaging beam or beams to the plan. First removes the existing imaging beams. If MV imaging beams are involved, the plan should be optimized again. + def AddImagingSetup(self, machineParameters: ExternalBeamMachineParameters, setupParameters: ImagingBeamSetupParameters, targetStructure: Structure) -> bool: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + setupParameters: Setup parameters for the imaging beam. See + targetStructure: Target structure for imaging. If not specified, the target structure in the plan is used. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam with an MLC to the plan. + def AddMLCArcBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam with an MLC to the plan. + def AddMLCBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field with an MLC to the plan. + def AddMLCSetupBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Multiple Static Segments as the delivery technique. + def AddMultipleStaticSegmentBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field to the plan. + def AddSetupBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Sliding Window as the delivery technique. + def AddSlidingWindowBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new sliding window IMRT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. + def AddSlidingWindowBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: Gantry angle in the IEC GANTRY coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static beam to the plan. + def AddStaticBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam to the plan. + def AddVMATBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. + def AddVMATBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryStartAngle: float, gantryStopAngle: float, gantryDir: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryStartAngle: Gantry start angle in the IEC GANTRY coordinate system (in degrees). + gantryStopAngle: Gantry stop angle in the IEC GANTRY coordinate system (in degrees). + gantryDir: Gantry direction + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. + def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: + """ + Args: + existing: The dose matrix is copied from this object. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the + def CreateEvaluationDose(self) -> EvaluationDose: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes a beam from the plan. + def RemoveBeam(self, beam: Beam) -> None: + """ + Args: + beam: The beam that will be removed from the plan. + """ + ... + + + +class ReferencePoint: + """ + A reference point associated with a patient. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Reference Point. + DailyDoseLimit (DoseValue): Daily dose limit of this reference point. + SessionDoseLimit (DoseValue): Session dose limit of this reference point. + TotalDoseLimit (DoseValue): Total dose limit of this reference point. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Reference Point. + DailyDoseLimit (DoseValue): Daily dose limit of this reference point. + SessionDoseLimit (DoseValue): Session dose limit of this reference point. + TotalDoseLimit (DoseValue): Total dose limit of this reference point. + """ + def __init__(self) -> None: ... + + Id: str + + DailyDoseLimit: DoseValue + + SessionDoseLimit: DoseValue + + TotalDoseLimit: DoseValue + + Id: str + + DailyDoseLimit: DoseValue + + SessionDoseLimit: DoseValue + + TotalDoseLimit: DoseValue + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add location for reference point into image 'Image' + def AddLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image into which location is inserted + x: x coordinate + y: y coordinate + z: z coordinate + errorHint: Holder for error message if addition fails + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Change location for reference point into image 'Image' + def ChangeLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image into which location is inserted + x: x coordinate in mm + y: y coordinate in mm + z: z coordinate in mm + errorHint: Holder for error message if location cannot be changed + """ + ... + + + # 3D location of this reference point in mm + def GetReferencePointLocation(self, Image: Image) -> VVector: + """ + Args: + Image: Image for which the location is requested + """ + ... + + + # The location of the reference point in mm. + def GetReferencePointLocation(self, planSetup: PlanSetup) -> VVector: + """ + Args: + planSetup: Plan setup that this reference point is connected to. + """ + ... + + + # Tests if a valid reference point location exists. + def HasLocation(self, planSetup: PlanSetup) -> bool: + """ + Args: + planSetup: Plan setup that this reference point is connected to + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove reference point location from image 'Image' + def RemoveLocation(self, Image: Image, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image from which the location for the reference point is removed + errorHint: Holder for error message if removal fails + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add location for reference point into image 'Image' + def AddLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image into which location is inserted + x: x coordinate + y: y coordinate + z: z coordinate + errorHint: Holder for error message if addition fails + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Change location for reference point into image 'Image' + def ChangeLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image into which location is inserted + x: x coordinate in mm + y: y coordinate in mm + z: z coordinate in mm + errorHint: Holder for error message if location cannot be changed + """ + ... + + + # 3D location of this reference point in mm + def GetReferencePointLocation(self, Image: Image) -> VVector: + """ + Args: + Image: Image for which the location is requested + """ + ... + + + # The location of the reference point in mm. + def GetReferencePointLocation(self, planSetup: PlanSetup) -> VVector: + """ + Args: + planSetup: Plan setup that this reference point is connected to. + """ + ... + + + # Tests if a valid reference point location exists. + def HasLocation(self, planSetup: PlanSetup) -> bool: + """ + Args: + planSetup: Plan setup that this reference point is connected to + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove reference point location from image 'Image' + def RemoveLocation(self, Image: Image, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image from which the location for the reference point is removed + errorHint: Holder for error message if removal fails + """ + ... + + + +class SeedCollection: + """ + Represents a collection of brachytherapy + + Attributes: + BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): Obsolete. + Color (Windows.Media.Color): The color of the seeds in the seed collection in the views. + SourcePositions (List[SourcePosition]): The source positions in this collection in creation order. + BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): Obsolete. + Color (Windows.Media.Color): The color of the seeds in the seed collection in the views. + SourcePositions (List[SourcePosition]): The source positions in this collection in creation order. + """ + def __init__(self) -> None: ... + + BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] + + Color: Windows.Media.Color + + SourcePositions: List[SourcePosition] + + BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] + + Color: Windows.Media.Color + + SourcePositions: List[SourcePosition] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class SourcePosition: + """ + Represents a brachytherapy source dwell position in a + + Attributes: + DwellTime (float): Dwell time. + DwellTimeLock (Optional[bool]): Identifies if the dwell time is locked. Set dwell time either locked = true, or unlocked = false. Locked when not allowed to change the dwell time. If unlocked, the dwell time can be changed. + NominalDwellTime (float): The nominal dwell time associated with this source position in seconds. + RadioactiveSource (RadioactiveSource): The radioactive source associated with this dwell position. + Transform (Array[float]): The 4x4 transformation matrix represents the orientation and location of the source position in space. The matrix is composed of a 4x3 rotation submatrix and a 4x1 translation vector. Its bottom row indicates scaling and is always [0 0 0 1]. The translation vector indicates the coordinates of the source position center, in millimeters. The third column of the rotation matrix indicates the source axis direction. + Translation (VVector): The translation of this source position. + DwellTime (float): Dwell time. + DwellTimeLock (Optional[bool]): Identifies if the dwell time is locked. Set dwell time either locked = true, or unlocked = false. Locked when not allowed to change the dwell time. If unlocked, the dwell time can be changed. + NominalDwellTime (float): The nominal dwell time associated with this source position in seconds. + RadioactiveSource (RadioactiveSource): The radioactive source associated with this dwell position. + Transform (Array[float]): The 4x4 transformation matrix represents the orientation and location of the source position in space. The matrix is composed of a 4x3 rotation submatrix and a 4x1 translation vector. Its bottom row indicates scaling and is always [0 0 0 1]. The translation vector indicates the coordinates of the source position center, in millimeters. The third column of the rotation matrix indicates the source axis direction. + Translation (VVector): The translation of this source position. + """ + def __init__(self) -> None: ... + + DwellTime: float + + DwellTimeLock: Optional[bool] + + NominalDwellTime: float + + RadioactiveSource: RadioactiveSource + + Transform: Array[float] + + Translation: VVector + + DwellTime: float + + DwellTimeLock: Optional[bool] + + NominalDwellTime: float + + RadioactiveSource: RadioactiveSource + + Transform: Array[float] + + Translation: VVector + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class StructureCode: + """ + Represents a structure code and its coding scheme. + + Attributes: + Code (str): The structure code as defined in the associated coding scheme. + CodeMeaning (str): The meaning of the structure code. + CodingScheme (str): The coding scheme of the structure code. + DisplayName (str): The display name of the code. + IsEncompassStructureCode (bool): Indicates whether the structure code is an encompass structure code. + Code (str): The structure code as defined in the associated coding scheme. + CodeMeaning (str): The meaning of the structure code. + CodingScheme (str): The coding scheme of the structure code. + DisplayName (str): The display name of the code. + IsEncompassStructureCode (bool): Indicates whether the structure code is an encompass structure code. + """ + def __init__(self) -> None: ... + + Code: str + + CodeMeaning: str + + CodingScheme: str + + DisplayName: str + + IsEncompassStructureCode: bool + + Code: str + + CodeMeaning: str + + CodingScheme: str + + DisplayName: str + + IsEncompassStructureCode: bool + + # Returns a StructureCodeInfo object with the same coding scheme and code as in the current structure code object. + def ToStructureCodeInfo(self) -> StructureCodeInfo: + ... + + + # Determines whether this structure code is considered equal to the specified structure code. + def Equals(self, other: StructureCode) -> bool: + ... + + + # Determines whether the current object is considered equal to the specified object. + def Equals(self, obj: StructureCode) -> bool: + ... + + + # The equality operator. + def op_Equality(self, sc1: StructureCode, sc2: StructureCode) -> bool: + ... + + + # The inequality operator. + def op_Inequality(self, sc1: StructureCode, sc2: StructureCode) -> bool: + ... + + + # Returns a string that represents this object. + def ToString(self) -> str: + ... + + + # Returns the hash code for this structure code. + def GetHashCode(self) -> int: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns a StructureCodeInfo object with the same coding scheme and code as in the current structure code object. + def ToStructureCodeInfo(self) -> StructureCodeInfo: + ... + + + # Determines whether this structure code is considered equal to the specified structure code. + def Equals(self, other: StructureCode) -> bool: + ... + + + # Determines whether the current object is considered equal to the specified object. + def Equals(self, obj: StructureCode) -> bool: + ... + + + # The equality operator. + def op_Equality(self, sc1: StructureCode, sc2: StructureCode) -> bool: + ... + + + # The inequality operator. + def op_Inequality(self, sc1: StructureCode, sc2: StructureCode) -> bool: + ... + + + # Returns a string that represents this object. + def ToString(self) -> str: + ... + + + # Returns the hash code for this structure code. + def GetHashCode(self) -> int: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class StructureCodeDictionary: + """ + Represents a set of structure codes as defined by a structure code scheme. The class exposes the structure codes that are available through the implemented + + Attributes: + Name (str): The name of the structure code scheme. + Version (str): The version of the structure code scheme. May be an empty string, if not applicable to the scheme. + Keys (List[str]): Gets a collection containing the structure code identifiers in this structure code dictionary. + Values (List[StructureCode]): Gets a collection containing the structure codes in this structure code dictionary. + Count (int): Gets the number of structure code object key/value pairs in this structure code dictionary. + Name (str): The name of the structure code scheme. + Version (str): The version of the structure code scheme. May be an empty string, if not applicable to the scheme. + Keys (List[str]): Gets a collection containing the structure code identifiers in this structure code dictionary. + Values (List[StructureCode]): Gets a collection containing the structure codes in this structure code dictionary. + Count (int): Gets the number of structure code object key/value pairs in this structure code dictionary. + """ + def __init__(self) -> None: ... + + Name: str + + Version: str + + Keys: List[str] + + Values: List[StructureCode] + + Count: int + + Name: str + + Version: str + + Keys: List[str] + + Values: List[StructureCode] + + Count: int + + # Determines whether the scheme contains the specified key as an active structure code identifier. + def ContainsKey(self, key: str) -> bool: + ... + + + # Gets the structure code object associated with the specified structure code identifier (key). + def TryGetValue(self, key: str, value: StructureCode) -> bool: + """ + Args: + key: The structure code identifier. + value: When the method returns, contains the specified structure code object, if it is found, otherwise null. + """ + ... + + + # Returns an enumerator that iterates through the collection. + def GetEnumerator(self) -> Iterable[KeyValuePair[str, StructureCode]]: + ... + + + # Returns a string that represents this object. + def ToString(self) -> str: + ... + + + # Determines whether the scheme contains the specified key as an active structure code identifier. + def ContainsKey(self, key: str) -> bool: + ... + + + # Gets the structure code object associated with the specified structure code identifier (key). + def TryGetValue(self, key: str, value: StructureCode) -> bool: + """ + Args: + key: The structure code identifier. + value: When the method returns, contains the specified structure code object, if it is found, otherwise null. + """ + ... + + + # Returns an enumerator that iterates through the collection. + def GetEnumerator(self) -> Iterable[KeyValuePair[str, StructureCode]]: + ... + + + # Returns a string that represents this object. + def ToString(self) -> str: + ... + + + +class ActiveStructureCodeDictionaries: + """ + Provides access to the structure code dictionaries with the active structure codes. + + Attributes: + Fma (StructureCodeDictionary): The Foundational Model of Anatomy Ontology structure scheme. + RadLex (StructureCodeDictionary): The RSNA RadLex radiology lexicon structure scheme. + Srt (StructureCodeDictionary): The SNOMED RT structure scheme. + VmsStructCode (StructureCodeDictionary): The Varian 99VMS_STRUCTCODE structure scheme. + Fma (StructureCodeDictionary): The Foundational Model of Anatomy Ontology structure scheme. + RadLex (StructureCodeDictionary): The RSNA RadLex radiology lexicon structure scheme. + Srt (StructureCodeDictionary): The SNOMED RT structure scheme. + VmsStructCode (StructureCodeDictionary): The Varian 99VMS_STRUCTCODE structure scheme. + """ + # Constructs a new ActiveStructureCodeDictionaries instance. + @overload + def __init__(self, providerFunc: Func[str, IReadOnlyDictionary[str, IStructureCode]]) -> None: + ... + + + # Constructs a new ActiveStructureCodeDictionaries instance. + @overload + def __init__(self, providerFunc: Func[str, IReadOnlyDictionary[str, IStructureCode]]) -> None: + ... + + + Fma: StructureCodeDictionary + + RadLex: StructureCodeDictionary + + Srt: StructureCodeDictionary + + VmsStructCode: StructureCodeDictionary + + Fma: StructureCodeDictionary + + RadLex: StructureCodeDictionary + + Srt: StructureCodeDictionary + + VmsStructCode: StructureCodeDictionary + + +class TradeoffPlanGenerationIntermediateDoseMode: + """ + Enumeration that specifies the use of intermediate dose when optimizing a plan collection for trade-off exploring. + """ + def __init__(self) -> None: ... + + +class Image: + """ + Represents a 2D or 3D image, which can be a DRR, a CT, MR, or other volumetric dataset. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the image. + ApprovalHistory (List[ImageApprovalHistoryEntry]): Returns the approval history of the image. + ContrastBolusAgentIngredientName (str): The name of the contrast bolus agent ingredient that is used in the image. If the value has not been specified, returns null. + CreationDateTime (Optional[datetime]): The date when this object was created. + DisplayUnit (str): The name of the display unit in which the voxels of the image are shown in the user interface. + FOR (str): The UID of the frame of reference. + HasUserOrigin (bool): Defines if a user origin has been specified for the image. + ImageType (str): The type of the image as indicated in the properties of the image slices. + ImagingDeviceId (str): Identification of the device that is used to scan the images into the system. + ImagingOrientation (PatientOrientation): The orientation of the patient. + ImagingOrientationAsString (str): The orientation of the patient as a string (localized) + IsProcessed (bool): Returns the value true if an image processing filter is in use for the image. + Level (int): The level setting. The value is given in the internal voxel scale. + Modality (SeriesModality): The modality of the image as indicated in the properties of the image slices. + Origin (VVector): The origin of the image. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first image plane. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + Series (Series): Used for navigating to parent series. + UID (str): Return UID of the first (and the only) slice in case of a 2D Image. Return null in case of a 3D Image. + UserOrigin (VVector): The user origin in DICOM coordinates in millimeter. + UserOriginComments (str): The text typed on the Origin tab in the Image Properties dialog box. + Window (int): The window setting. The value is given in the internal voxel scale. + XDirection (VVector): The direction of the x-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + XRes (float): The image resolution in X-direction in millimeters. + XSize (int): The image size in X-direction in voxels. + YDirection (VVector): The direction of the y-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + YRes (float): The image resolution in Y-direction in millimeters. + YSize (int): The image size in Y-direction in voxels. + ZDirection (VVector): The direction of the z-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + ZRes (float): The image resolution in Z-direction in millimeters. + ZSize (int): The image size in Z-direction in voxels. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the image. + ApprovalHistory (List[ImageApprovalHistoryEntry]): Returns the approval history of the image. + ContrastBolusAgentIngredientName (str): The name of the contrast bolus agent ingredient that is used in the image. If the value has not been specified, returns null. + CreationDateTime (Optional[datetime]): The date when this object was created. + DisplayUnit (str): The name of the display unit in which the voxels of the image are shown in the user interface. + FOR (str): The UID of the frame of reference. + HasUserOrigin (bool): Defines if a user origin has been specified for the image. + ImageType (str): The type of the image as indicated in the properties of the image slices. + ImagingDeviceId (str): Identification of the device that is used to scan the images into the system. + ImagingOrientation (PatientOrientation): The orientation of the patient. + ImagingOrientationAsString (str): The orientation of the patient as a string (localized) + IsProcessed (bool): Returns the value true if an image processing filter is in use for the image. + Level (int): The level setting. The value is given in the internal voxel scale. + Modality (SeriesModality): The modality of the image as indicated in the properties of the image slices. + Origin (VVector): The origin of the image. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first image plane. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + Series (Series): Used for navigating to parent series. + UID (str): Return UID of the first (and the only) slice in case of a 2D Image. Return null in case of a 3D Image. + UserOrigin (VVector): The user origin in DICOM coordinates in millimeter. + UserOriginComments (str): The text typed on the Origin tab in the Image Properties dialog box. + Window (int): The window setting. The value is given in the internal voxel scale. + XDirection (VVector): The direction of the x-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + XRes (float): The image resolution in X-direction in millimeters. + XSize (int): The image size in X-direction in voxels. + YDirection (VVector): The direction of the y-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + YRes (float): The image resolution in Y-direction in millimeters. + YSize (int): The image size in Y-direction in voxels. + ZDirection (VVector): The direction of the z-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + ZRes (float): The image resolution in Z-direction in millimeters. + ZSize (int): The image size in Z-direction in voxels. + """ + def __init__(self) -> None: ... + + Id: str + + ApprovalHistory: List[ImageApprovalHistoryEntry] + + ContrastBolusAgentIngredientName: str + + CreationDateTime: Optional[datetime] + + DisplayUnit: str + + FOR: str + + HasUserOrigin: bool + + ImageType: str + + ImagingDeviceId: str + + ImagingOrientation: PatientOrientation + + ImagingOrientationAsString: str + + IsProcessed: bool + + Level: int + + Modality: SeriesModality + + Origin: VVector + + Series: Series + + UID: str + + UserOrigin: VVector + + UserOriginComments: str + + Window: int + + XDirection: VVector + + XRes: float + + XSize: int + + YDirection: VVector + + YRes: float + + YSize: int + + ZDirection: VVector + + ZRes: float + + ZSize: int + + Id: str + + ApprovalHistory: List[ImageApprovalHistoryEntry] + + ContrastBolusAgentIngredientName: str + + CreationDateTime: Optional[datetime] + + DisplayUnit: str + + FOR: str + + HasUserOrigin: bool + + ImageType: str + + ImagingDeviceId: str + + ImagingOrientation: PatientOrientation + + ImagingOrientationAsString: str + + IsProcessed: bool + + Level: int + + Modality: SeriesModality + + Origin: VVector + + Series: Series + + UID: str + + UserOrigin: VVector + + UserOriginComments: str + + Window: int + + XDirection: VVector + + XRes: float + + XSize: int + + YDirection: VVector + + YRes: float + + YSize: int + + ZDirection: VVector + + ZRes: float + + ZSize: int + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns the voxel-wise DECT proton stopping powers of the given image plane calculated from the current image and the rho and Z images. The image FOR, size, and resolution for the rho and Z images must conform with this image. + def CalculateDectProtonStoppingPowers(self, rhoImage: Image, zImage: Image, planeIndex: int, preallocatedBuffer: Array[float]) -> None: + """ + Args: + rhoImage: A DECT relative electron density image. The electron density is interpreted from the image values as rho = 0.001 * (value + 1000). + zImage: A DECT effective atomic number image. + planeIndex: Zero based index of the plane. + preallocatedBuffer: Pre-allocated buffer where the proton stopping power values are stored. The size of the buffer must conform with the X- and Y-size of this image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new structure set. If the image does not yet have a structure set, the new structure set will be assigned directly to it. If the image already has a structure set, a copy of this image is made, and the new structure set is assigned to the copy. The image must be a 3D image. + def CreateNewStructureSet(self) -> StructureSet: + ... + + + # Converts DICOM coordinates to the planning coordinate system used in the Eclipse user interface. + def DicomToUser(self, dicom: VVector, planSetup: PlanSetup) -> VVector: + """ + Args: + dicom: Coordinate value in DICOM coordinate system. + planSetup: Plan that defines the planning orientation or null. + """ + ... + + + # Gets the image profile. + def GetImageProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> ImageProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # Returns the HU to proton stopping power curve associated with the image. + def GetProtonStoppingPowerCurve(self, protonStoppingPowerCurve: SortedList[float, float]) -> bool: + """ + Args: + protonStoppingPowerCurve: An empty list where the curve values will be stored. + """ + ... + + + # Gets the voxels of the given image plane. + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """ + Args: + planeIndex: Zero based index of the plane. + preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this image. + """ + ... + + + # Converts a coordinate value from the planning coordinate system used in the Eclipse user interface to DICOM coordinates. + def UserToDicom(self, user: VVector, planSetup: PlanSetup) -> VVector: + """ + Args: + user: Coordinate value in the planning coordinate system. + planSetup: Plan that defines the planning orientation or null. + """ + ... + + + # Converts the given raw voxel value to the corresponding value in the user interface display unit, for example, HU, Bq/ml. + def VoxelToDisplayValue(self, voxelValue: int) -> float: + """ + Args: + voxelValue: Voxel value. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns the voxel-wise DECT proton stopping powers of the given image plane calculated from the current image and the rho and Z images. The image FOR, size, and resolution for the rho and Z images must conform with this image. + def CalculateDectProtonStoppingPowers(self, rhoImage: Image, zImage: Image, planeIndex: int, preallocatedBuffer: Array[float]) -> None: + """ + Args: + rhoImage: A DECT relative electron density image. The electron density is interpreted from the image values as rho = 0.001 * (value + 1000). + zImage: A DECT effective atomic number image. + planeIndex: Zero based index of the plane. + preallocatedBuffer: Pre-allocated buffer where the proton stopping power values are stored. The size of the buffer must conform with the X- and Y-size of this image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new structure set. If the image does not yet have a structure set, the new structure set will be assigned directly to it. If the image already has a structure set, a copy of this image is made, and the new structure set is assigned to the copy. The image must be a 3D image. + def CreateNewStructureSet(self) -> StructureSet: + ... + + + # Converts DICOM coordinates to the planning coordinate system used in the Eclipse user interface. + def DicomToUser(self, dicom: VVector, planSetup: PlanSetup) -> VVector: + """ + Args: + dicom: Coordinate value in DICOM coordinate system. + planSetup: Plan that defines the planning orientation or null. + """ + ... + + + # Gets the image profile. + def GetImageProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> ImageProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # Returns the HU to proton stopping power curve associated with the image. + def GetProtonStoppingPowerCurve(self, protonStoppingPowerCurve: SortedList[float, float]) -> bool: + """ + Args: + protonStoppingPowerCurve: An empty list where the curve values will be stored. + """ + ... + + + # Gets the voxels of the given image plane. + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """ + Args: + planeIndex: Zero based index of the plane. + preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this image. + """ + ... + + + # Converts a coordinate value from the planning coordinate system used in the Eclipse user interface to DICOM coordinates. + def UserToDicom(self, user: VVector, planSetup: PlanSetup) -> VVector: + """ + Args: + user: Coordinate value in the planning coordinate system. + planSetup: Plan that defines the planning orientation or null. + """ + ... + + + # Converts the given raw voxel value to the corresponding value in the user interface display unit, for example, HU, Bq/ml. + def VoxelToDisplayValue(self, voxelValue: int) -> float: + """ + Args: + voxelValue: Voxel value. + """ + ... + + + +class IDVHEstimationCalculator: + """ + Interface to the calculation of the DVH Estimates + """ + def __init__(self) -> None: ... + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + +class IonBeamParameters: + """ + An editable copy of the parameters of a proton beam. + + Attributes: + ControlPoints (List[IonControlPointParameters]): Editable control point parameters copied from the treatment beam. + PreSelectedRangeShifter1Id (str): ID of the pre-selected range shifter 1 in the field. + PreSelectedRangeShifter1Setting (str): Setting of the pre-selected range shifter 1 in the field. + PreSelectedRangeShifter2Id (str): ID of the pre-selected range shifter 2 in the field. + PreSelectedRangeShifter2Setting (str): Setting of the pre-selected range shifter 2 in the field. + IonControlPointPairs (IonControlPointPairCollection): A copy of editable control point pairs. + SnoutId (str): The snout identifier. Returns null if undefined. + SnoutPosition (float): Snout position in centimeters. + TargetStructure (Structure): Target structure of the field. + ControlPoints (List[IonControlPointParameters]): Editable control point parameters copied from the treatment beam. + PreSelectedRangeShifter1Id (str): ID of the pre-selected range shifter 1 in the field. + PreSelectedRangeShifter1Setting (str): Setting of the pre-selected range shifter 1 in the field. + PreSelectedRangeShifter2Id (str): ID of the pre-selected range shifter 2 in the field. + PreSelectedRangeShifter2Setting (str): Setting of the pre-selected range shifter 2 in the field. + IonControlPointPairs (IonControlPointPairCollection): A copy of editable control point pairs. + SnoutId (str): The snout identifier. Returns null if undefined. + SnoutPosition (float): Snout position in centimeters. + TargetStructure (Structure): Target structure of the field. + + Note: + To apply the parameters, call the + """ + def __init__(self) -> None: ... + + ControlPoints: List[IonControlPointParameters] + + PreSelectedRangeShifter1Id: str + + PreSelectedRangeShifter1Setting: str + + PreSelectedRangeShifter2Id: str + + PreSelectedRangeShifter2Setting: str + + IonControlPointPairs: IonControlPointPairCollection + + SnoutId: str + + SnoutPosition: float + + TargetStructure: Structure + + ControlPoints: List[IonControlPointParameters] + + PreSelectedRangeShifter1Id: str + + PreSelectedRangeShifter1Setting: str + + PreSelectedRangeShifter2Id: str + + PreSelectedRangeShifter2Setting: str + + IonControlPointPairs: IonControlPointPairCollection + + SnoutId: str + + SnoutPosition: float + + TargetStructure: Structure + + +class OptimizationControllerIMPT: + """ + Controls the IMPT optimization from the Script + """ + def __init__(self) -> None: ... + +class OptimizationControllerIMRT: + """ + Controls the IMRT optimization from the Script + """ + def __init__(self) -> None: ... + +class OptimizationControllerVMAT: + """ + Controls the VMAT optimization from the Script + """ + def __init__(self) -> None: ... + +class OptimizationSetup: + """ + Gives access to the optimization parameters and objectives. + + Attributes: + UseJawTracking (bool): [Availability of this property depends on your Eclipse Scripting API license] Jaw tracking parameter for VMAT optimization. The parameter can only be set for plans to be delivered with a treatment machine that supports jaw tracking. + Objectives (List[OptimizationObjective]): A collection of optimization objectives. + Parameters (List[OptimizationParameter]): A collection of optimization parameters. + UseJawTracking (bool): [Availability of this property depends on your Eclipse Scripting API license] Jaw tracking parameter for VMAT optimization. The parameter can only be set for plans to be delivered with a treatment machine that supports jaw tracking. + Objectives (List[OptimizationObjective]): A collection of optimization objectives. + Parameters (List[OptimizationParameter]): A collection of optimization parameters. + """ + def __init__(self) -> None: ... + + UseJawTracking: bool + + Objectives: List[OptimizationObjective] + + Parameters: List[OptimizationParameter] + + UseJawTracking: bool + + Objectives: List[OptimizationObjective] + + Parameters: List[OptimizationParameter] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. + def AddAutomaticNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic SBRT normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. + def AddAutomaticSbrtNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam-specific parameter for IMRT optimization. + def AddBeamSpecificParameter(self, beam: Beam, smoothX: float, smoothY: float, fixedJaws: bool) -> OptimizationIMRTBeamParameter: + """ + Args: + beam: The beam for which the parameters are added. + smoothX: A fluence-smoothing parameter in X-direction. + smoothY: A fluence-smoothing parameter in Y-direction. + fixedJaws: If true, the collimator jaw positions of the beam remain the same during the optimization. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new gEUD objective. + def AddEUDObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, parameterA: float, priority: float) -> OptimizationEUDObjective: + """ + Args: + structure: The target structure of the objective. + objectiveOperator: The type of the gEUD objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + parameterA: gEUD parameter a. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new mean dose objective. + def AddMeanDoseObjective(self, structure: Structure, dose: DoseValue, priority: float) -> OptimizationMeanDoseObjective: + """ + Args: + structure: The target structure of the objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. + def AddNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float, fallOff: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + fallOff: Determines the steepness of the normal tissue objective fall-off. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new point objective. + def AddPointObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, volume: float, priority: float) -> OptimizationPointObjective: + """ + Args: + structure: The target structure of the objective. + objectiveOperator: The type of the dose-volume objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + volume: The volume of the objective. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) for a proton plan or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. + def AddProtonNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization objective. + def RemoveObjective(self, objective: OptimizationObjective) -> None: + """ + Args: + objective: The objective that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization parameter. + def RemoveParameter(self, parameter: OptimizationParameter) -> None: + """ + Args: + parameter: The parameter that is removed. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. + def AddAutomaticNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic SBRT normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. + def AddAutomaticSbrtNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam-specific parameter for IMRT optimization. + def AddBeamSpecificParameter(self, beam: Beam, smoothX: float, smoothY: float, fixedJaws: bool) -> OptimizationIMRTBeamParameter: + """ + Args: + beam: The beam for which the parameters are added. + smoothX: A fluence-smoothing parameter in X-direction. + smoothY: A fluence-smoothing parameter in Y-direction. + fixedJaws: If true, the collimator jaw positions of the beam remain the same during the optimization. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new gEUD objective. + def AddEUDObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, parameterA: float, priority: float) -> OptimizationEUDObjective: + """ + Args: + structure: The target structure of the objective. + objectiveOperator: The type of the gEUD objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + parameterA: gEUD parameter a. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new mean dose objective. + def AddMeanDoseObjective(self, structure: Structure, dose: DoseValue, priority: float) -> OptimizationMeanDoseObjective: + """ + Args: + structure: The target structure of the objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. + def AddNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float, fallOff: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + fallOff: Determines the steepness of the normal tissue objective fall-off. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new point objective. + def AddPointObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, volume: float, priority: float) -> OptimizationPointObjective: + """ + Args: + structure: The target structure of the objective. + objectiveOperator: The type of the dose-volume objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + volume: The volume of the objective. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) for a proton plan or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. + def AddProtonNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization objective. + def RemoveObjective(self, objective: OptimizationObjective) -> None: + """ + Args: + objective: The objective that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization parameter. + def RemoveParameter(self, parameter: OptimizationParameter) -> None: + """ + Args: + parameter: The parameter that is removed. + """ + ... + + + +class CalculationResult: + """ + Holds the result of the calculation (pass/fail). + + Attributes: + Success (bool): Returns true if calculation did not return any errors. Otherwise returns false. + Success (bool): Returns true if calculation did not return any errors. Otherwise returns false. + """ + def __init__(self) -> None: ... + + Success: bool + + Success: bool + + +class OptimizerResult: + """ + Holds the result of the optimization (pass/fail). + + Attributes: + StructureDVHs (List[OptimizerDVH]): A list of Dose Volume Histogram (DVH) curves for structures. + StructureObjectiveValues (List[OptimizerObjectiveValue]): The list of objective function values per structure. + TotalObjectiveFunctionValue (float): The total objective function value for the optimization. + NumberOfIMRTOptimizerIterations (int): The number of iterations taken by the IMRT optimizer. + StructureDVHs (List[OptimizerDVH]): A list of Dose Volume Histogram (DVH) curves for structures. + StructureObjectiveValues (List[OptimizerObjectiveValue]): The list of objective function values per structure. + TotalObjectiveFunctionValue (float): The total objective function value for the optimization. + NumberOfIMRTOptimizerIterations (int): The number of iterations taken by the IMRT optimizer. + """ + def __init__(self) -> None: ... + + StructureDVHs: List[OptimizerDVH] + + StructureObjectiveValues: List[OptimizerObjectiveValue] + + TotalObjectiveFunctionValue: float + + NumberOfIMRTOptimizerIterations: int + + StructureDVHs: List[OptimizerDVH] + + StructureObjectiveValues: List[OptimizerObjectiveValue] + + TotalObjectiveFunctionValue: float + + NumberOfIMRTOptimizerIterations: int + + +class PlanSetup: + """ + Represents a treatment plan. See the definition of a DICOM RT Plan for more information. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSetup. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Plan. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Plan. + PlanNormalizationValue (float): [Availability of this property depends on your Eclipse Scripting API license] The plan normalization value in percentage. The plan is normalized according to the plan normalization value, for instance, 200%. The value is Double.NaN if it is not defined. + PlanUncertainties (List[PlanUncertainty]): Plan uncertainties defined for the plan. + PlanObjectiveStructures (List[str]): The list of structure IDs that are present in the plan objectives (prescriptions and indices). + ApprovalHistory (List[ApprovalHistoryEntry]): Returns the approval history of the plan setup. + DosePerFractionInPrimaryRefPoint (DoseValue): The calculated fraction dose in the primary reference point. + PrescribedDosePerFraction (DoseValue): The prescribed fraction dose. + PrescribedPercentage (float): The prescribed dose percentage as a decimal number. For example, if the prescribed dose percentage shown in the Eclipse user interface is 80 %, returns 0.8 + TotalPrescribedDose (DoseValue): The total prescribed dose. + ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the plan. + ApprovalStatus (PlanSetupApprovalStatus): The approval status. + ApprovalStatusAsString (str): Returns the approval status as a string (localized). + BaseDosePlanningItem (PlanningItem): BaseDose for the optimization, can be either plan or plan sum. + Beams (List[Beam]): A collection of all the beams in the plan (including setup beams). Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. + BeamsInTreatmentOrder (List[Beam]): A collection of all the beams in the plan (including setup beams) in treatment order. Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. + CreationUserName (str): The name of the user who saved the plan for the first time. + DosePerFraction (DoseValue): The dose per fraction. + DVHEstimates (List[EstimatedDVH]): Returns a list of DVH estimate objects for this plan + ElectronCalculationModel (str): The name of the electron calculation model. Not applicable to brachytherapy plans. + ElectronCalculationOptions (Dict[str, str]): The electron calculation options. Not applicable to brachytherapy plans. + IntegrityHash (str): Returns the plan's integrity hash. Returns null if the plan's integrity hash has not been set. + IsDoseValid (bool): Returns the value true if the plan dose is valid. This implies that the dose object returned from the dose property is not null and can therefore be used to query dose values. + IsTreated (bool): Checks if the treatment plan has been delivered. + NumberOfFractions (Optional[int]): The number of fractions. + OptimizationSetup (OptimizationSetup): Provides access to optimization objectives and parameters. + PatientSupportDevice (PatientSupportDevice): Patient support device. + PhotonCalculationModel (str): The name of the photon calculation model. Not applicable to brachytherapy plans. + PhotonCalculationOptions (Dict[str, str]): The photon calculation options. Not applicable to brachytherapy plans. + PlanIntent (str): The plan intent as in DICOM, or an empty string. The defined terms are "CURATIVE", "PALLIATIVE", "PROPHYLACTIC", "VERIFICATION", "MACHINE_QA", "RESEARCH" and "SERVICE", but the value can be different for imported plans. + PlanIsInTreatment (bool): Checks if plan is loaded into console. + PlannedDosePerFraction (DoseValue): The calculated fraction dose in the primary reference point. + PlanningApprovalDate (str): The date when the plan was approved for planning. + PlanningApprover (str): The identifier of the user who approved the plan for planning. + PlanningApproverDisplayName (str): The display name of the user who approved the plan for planning. + PlanNormalizationMethod (str): The user interface name for the current normalization method. + PlanNormalizationPoint (VVector): The plan normalization point. + PlanType (PlanType): The plan type. + PredecessorPlan (PlanSetup): The prior revision of the plan + PredecessorPlanUID (str): The UID of the predecessor plan. + PrimaryReferencePoint (ReferencePoint): The primary reference point. + ProtocolID (str): The protocol identifier. + ProtocolPhaseID (str): The protocol phase identifier. + ProtonCalculationModel (str): The name of the proton calculation model. Not applicable to brachytherapy plans. + ProtonCalculationOptions (Dict[str, str]): The proton calculation options. Not applicable to brachytherapy plans. + ReferencePoints (List[ReferencePoint]): Collection of reference points in the plan. + RTPrescription (RTPrescription): Used for navigating to the linked prescription. + Series (Series): The series that contains this plan. Null if the plan is not connected to a series. + SeriesUID (str): The DICOM UID of the series that contains this plan. Empty string if the plan is not connected to a series. + TargetVolumeID (str): The target volume identifier. + TotalDose (DoseValue): Planned total dose. + TreatmentApprovalDate (str): The date when the plan was approved for treatment. + TreatmentApprover (str): The identifier of the user who approved the plan for treatment. + TreatmentApproverDisplayName (str): The display name of the user who approved the plan for treatment. + TreatmentOrientation (PatientOrientation): The orientation of the treatment. + TreatmentOrientationAsString (str): The orientation of the treatment as a string (localized). + TreatmentPercentage (float): The treatment percentage as a decimal number. For example, if the treatment percentage shown in the Eclipse user interface is 80%, returns 0.8. + TreatmentSessions (List[PlanTreatmentSession]): Treatment sessions for the plan, either scheduled sessions or treated sessions. + UID (str): The DICOM UID of the plan. + UseGating (bool): Boolean to mark if gating is used in the plan. + VerifiedPlan (PlanSetup): Returns the verified plan if this is a verification plan, otherwise returns null. The verified plan is the clinical plan that was used to create the verification plan. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSetup. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Plan. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Plan. + PlanNormalizationValue (float): [Availability of this property depends on your Eclipse Scripting API license] The plan normalization value in percentage. The plan is normalized according to the plan normalization value, for instance, 200%. The value is Double.NaN if it is not defined. + PlanUncertainties (List[PlanUncertainty]): Plan uncertainties defined for the plan. + PlanObjectiveStructures (List[str]): The list of structure IDs that are present in the plan objectives (prescriptions and indices). + ApprovalHistory (List[ApprovalHistoryEntry]): Returns the approval history of the plan setup. + DosePerFractionInPrimaryRefPoint (DoseValue): The calculated fraction dose in the primary reference point. + PrescribedDosePerFraction (DoseValue): The prescribed fraction dose. + PrescribedPercentage (float): The prescribed dose percentage as a decimal number. For example, if the prescribed dose percentage shown in the Eclipse user interface is 80 %, returns 0.8 + TotalPrescribedDose (DoseValue): The total prescribed dose. + ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the plan. + ApprovalStatus (PlanSetupApprovalStatus): The approval status. + ApprovalStatusAsString (str): Returns the approval status as a string (localized). + BaseDosePlanningItem (PlanningItem): BaseDose for the optimization, can be either plan or plan sum. + Beams (List[Beam]): A collection of all the beams in the plan (including setup beams). Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. + BeamsInTreatmentOrder (List[Beam]): A collection of all the beams in the plan (including setup beams) in treatment order. Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. + CreationUserName (str): The name of the user who saved the plan for the first time. + DosePerFraction (DoseValue): The dose per fraction. + DVHEstimates (List[EstimatedDVH]): Returns a list of DVH estimate objects for this plan + ElectronCalculationModel (str): The name of the electron calculation model. Not applicable to brachytherapy plans. + ElectronCalculationOptions (Dict[str, str]): The electron calculation options. Not applicable to brachytherapy plans. + IntegrityHash (str): Returns the plan's integrity hash. Returns null if the plan's integrity hash has not been set. + IsDoseValid (bool): Returns the value true if the plan dose is valid. This implies that the dose object returned from the dose property is not null and can therefore be used to query dose values. + IsTreated (bool): Checks if the treatment plan has been delivered. + NumberOfFractions (Optional[int]): The number of fractions. + OptimizationSetup (OptimizationSetup): Provides access to optimization objectives and parameters. + PatientSupportDevice (PatientSupportDevice): Patient support device. + PhotonCalculationModel (str): The name of the photon calculation model. Not applicable to brachytherapy plans. + PhotonCalculationOptions (Dict[str, str]): The photon calculation options. Not applicable to brachytherapy plans. + PlanIntent (str): The plan intent as in DICOM, or an empty string. The defined terms are "CURATIVE", "PALLIATIVE", "PROPHYLACTIC", "VERIFICATION", "MACHINE_QA", "RESEARCH" and "SERVICE", but the value can be different for imported plans. + PlanIsInTreatment (bool): Checks if plan is loaded into console. + PlannedDosePerFraction (DoseValue): The calculated fraction dose in the primary reference point. + PlanningApprovalDate (str): The date when the plan was approved for planning. + PlanningApprover (str): The identifier of the user who approved the plan for planning. + PlanningApproverDisplayName (str): The display name of the user who approved the plan for planning. + PlanNormalizationMethod (str): The user interface name for the current normalization method. + PlanNormalizationPoint (VVector): The plan normalization point. + PlanType (PlanType): The plan type. + PredecessorPlan (PlanSetup): The prior revision of the plan + PredecessorPlanUID (str): The UID of the predecessor plan. + PrimaryReferencePoint (ReferencePoint): The primary reference point. + ProtocolID (str): The protocol identifier. + ProtocolPhaseID (str): The protocol phase identifier. + ProtonCalculationModel (str): The name of the proton calculation model. Not applicable to brachytherapy plans. + ProtonCalculationOptions (Dict[str, str]): The proton calculation options. Not applicable to brachytherapy plans. + ReferencePoints (List[ReferencePoint]): Collection of reference points in the plan. + RTPrescription (RTPrescription): Used for navigating to the linked prescription. + Series (Series): The series that contains this plan. Null if the plan is not connected to a series. + SeriesUID (str): The DICOM UID of the series that contains this plan. Empty string if the plan is not connected to a series. + TargetVolumeID (str): The target volume identifier. + TotalDose (DoseValue): Planned total dose. + TreatmentApprovalDate (str): The date when the plan was approved for treatment. + TreatmentApprover (str): The identifier of the user who approved the plan for treatment. + TreatmentApproverDisplayName (str): The display name of the user who approved the plan for treatment. + TreatmentOrientation (PatientOrientation): The orientation of the treatment. + TreatmentOrientationAsString (str): The orientation of the treatment as a string (localized). + TreatmentPercentage (float): The treatment percentage as a decimal number. For example, if the treatment percentage shown in the Eclipse user interface is 80%, returns 0.8. + TreatmentSessions (List[PlanTreatmentSession]): Treatment sessions for the plan, either scheduled sessions or treated sessions. + UID (str): The DICOM UID of the plan. + UseGating (bool): Boolean to mark if gating is used in the plan. + VerifiedPlan (PlanSetup): Returns the verified plan if this is a verification plan, otherwise returns null. The verified plan is the clinical plan that was used to create the verification plan. + """ + def __init__(self) -> None: ... + + Id: str + + Name: str + + Comment: str + + PlanNormalizationValue: float + + PlanUncertainties: List[PlanUncertainty] + + PlanObjectiveStructures: List[str] + + ApprovalHistory: List[ApprovalHistoryEntry] + + DosePerFractionInPrimaryRefPoint: DoseValue + + PrescribedDosePerFraction: DoseValue + + PrescribedPercentage: float + + TotalPrescribedDose: DoseValue + + ApplicationScriptLogs: List[ApplicationScriptLog] + + ApprovalStatus: PlanSetupApprovalStatus + + ApprovalStatusAsString: str + + BaseDosePlanningItem: PlanningItem + + Beams: List[Beam] + + BeamsInTreatmentOrder: List[Beam] + + CreationUserName: str + + DosePerFraction: DoseValue + + DVHEstimates: List[EstimatedDVH] + + ElectronCalculationModel: str + + ElectronCalculationOptions: Dict[str, str] + + IntegrityHash: str + + IsDoseValid: bool + + IsTreated: bool + + NumberOfFractions: Optional[int] + + OptimizationSetup: OptimizationSetup + + PatientSupportDevice: PatientSupportDevice + + PhotonCalculationModel: str + + PhotonCalculationOptions: Dict[str, str] + + PlanIntent: str + + PlanIsInTreatment: bool + + PlannedDosePerFraction: DoseValue + + PlanningApprovalDate: str + + PlanningApprover: str + + PlanningApproverDisplayName: str + + PlanNormalizationMethod: str + + PlanNormalizationPoint: VVector + + PlanType: PlanType + + PredecessorPlan: PlanSetup + + PredecessorPlanUID: str + + PrimaryReferencePoint: ReferencePoint + + ProtocolID: str + + ProtocolPhaseID: str + + ProtonCalculationModel: str + + ProtonCalculationOptions: Dict[str, str] + + ReferencePoints: List[ReferencePoint] + + RTPrescription: RTPrescription + + Series: Series + + SeriesUID: str + + TargetVolumeID: str + + TotalDose: DoseValue + + TreatmentApprovalDate: str + + TreatmentApprover: str + + TreatmentApproverDisplayName: str + + TreatmentOrientation: PatientOrientation + + TreatmentOrientationAsString: str + + TreatmentPercentage: float + + TreatmentSessions: List[PlanTreatmentSession] + + UID: str + + UseGating: bool + + VerifiedPlan: PlanSetup + + Id: str + + Name: str + + Comment: str + + PlanNormalizationValue: float + + PlanUncertainties: List[PlanUncertainty] + + PlanObjectiveStructures: List[str] + + ApprovalHistory: List[ApprovalHistoryEntry] + + DosePerFractionInPrimaryRefPoint: DoseValue + + PrescribedDosePerFraction: DoseValue + + PrescribedPercentage: float + + TotalPrescribedDose: DoseValue + + ApplicationScriptLogs: List[ApplicationScriptLog] + + ApprovalStatus: PlanSetupApprovalStatus + + ApprovalStatusAsString: str + + BaseDosePlanningItem: PlanningItem + + Beams: List[Beam] + + BeamsInTreatmentOrder: List[Beam] + + CreationUserName: str + + DosePerFraction: DoseValue + + DVHEstimates: List[EstimatedDVH] + + ElectronCalculationModel: str + + ElectronCalculationOptions: Dict[str, str] + + IntegrityHash: str + + IsDoseValid: bool + + IsTreated: bool + + NumberOfFractions: Optional[int] + + OptimizationSetup: OptimizationSetup + + PatientSupportDevice: PatientSupportDevice + + PhotonCalculationModel: str + + PhotonCalculationOptions: Dict[str, str] + + PlanIntent: str + + PlanIsInTreatment: bool + + PlannedDosePerFraction: DoseValue + + PlanningApprovalDate: str + + PlanningApprover: str + + PlanningApproverDisplayName: str + + PlanNormalizationMethod: str + + PlanNormalizationPoint: VVector + + PlanType: PlanType + + PredecessorPlan: PlanSetup + + PredecessorPlanUID: str + + PrimaryReferencePoint: ReferencePoint + + ProtocolID: str + + ProtocolPhaseID: str + + ProtonCalculationModel: str + + ProtonCalculationOptions: Dict[str, str] + + ReferencePoints: List[ReferencePoint] + + RTPrescription: RTPrescription + + Series: Series + + SeriesUID: str + + TargetVolumeID: str + + TotalDose: DoseValue + + TreatmentApprovalDate: str + + TreatmentApprover: str + + TreatmentApproverDisplayName: str + + TreatmentOrientation: PatientOrientation + + TreatmentOrientationAsString: str + + TreatmentPercentage: float + + TreatmentSessions: List[PlanTreatmentSession] + + UID: str + + UseGating: bool + + VerifiedPlan: PlanSetup + + # Gets the prescriptions and measures in the protocol that is associated with this plan setup. + def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List[ProtocolPhasePrescription], measures: List[ProtocolPhaseMeasure]) -> None: + """ + Args: + prescriptions: Returned list of prescriptions (plan objectives). + measures: Returned list of plan measures (quality indices). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. + def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: + """ + Args: + target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). + location: Reference point location in mm. + id: Reference point ID. + """ + ... + + + # Attaches event handling. + def AttachToCalcClient(self, doseCalcClient: ICalculationClient) -> Any: + ... + + + # Detaches event handling for the calculation client. + def DetachFromCalcClient(self, doseCalcClient: ICalculationClient) -> Any: + ... + + + # Reporting. + def Report(self, str: str) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimatesImpl(self, dvhCalculator: IPhotonCalculation, client: ICalculationClient, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str], license: LicenseId) -> Any: + """ + Args: + dvhCalculator: Interface for calculating the DVH estimates. + client: Calculation client. + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + license: License required for running the DVH estimation + """ + ... + + + # Check if plan approval status is valid. Note: Configured approval extensions are not executed. + def IsValidForPlanApproval(self, validationResults: List[PlanValidationResultEsapiDetail]) -> bool: + """ + Args: + validationResults: Validation results which contain detailed warning and error messages. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a new plan or field uncertainty with parameters. In case of field specific uncertainty, HUConversionError is overwritten to be always zero. Supported uncertainty types: RangeUncertainty, IsocenterShiftUncertainty, BaselineShiftUncertainty, RobustOptimizationUncertainty (=Perturbation). RangeUncertainty and RobustOptimizationUncertainty are proton specific. IsocenterShiftUncertainty and BaselineShiftUncertainty are photon specific. Field specific plan uncertainty dose can be used only for RobustOptimizationUncertainty. In case of BaselineShiftUncertainty isocenterShift parameter is actually target shift. + def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: + """ + Args: + uncertaintyType: Type of the plan uncertainty dose. + planSpecificUncertainty: The plan uncertainty dose is either plan specific (true) or field specific (false). + HUConversionError: Calibration curve error [%] + isocenterShift: Patient setup error [cm] + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the treatment order of the beams. + def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: + """ + Args: + orderedBeams: The beams in wanted order. All the beams of the plan must be present, otherwise the method fails. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. + def AddReferencePoint(self, refPoint: ReferencePoint) -> ReferencePoint: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Clears the calculation model for the given calculation type. + def ClearCalculationModel(self, calculationType: CalculationType) -> None: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Returns the selected calculation model for the given calculation type. Returns null if no model has been selected. + def GetCalculationModel(self, calculationType: CalculationType) -> str: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Gets the given calculation option value. + def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """ + Args: + calculationModel: The name of the calculation model. + optionName: The XPath or name of the option to set. + optionValue: The value of the given option. + """ + ... + + + # Gets all the calculation options and their values for the given calculation model. + def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: + """ + Args: + calculationModel: The name of the calculation model. + """ + ... + + + # Retrieves the name of DVH Estimation Model. + def GetDvhEstimationModelName(self) -> str: + ... + + + # Checks the limits of the current calculation area. + def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Moves the plan setup from its current course to the destination course, maintaining the plan UID. + def MoveToCourse(self, destinationCourse: Course) -> None: + """ + Args: + destinationCourse: The destination course for the plan setup. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove provided reference point from plan + def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to remove. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the calculation model for the given calculation type. + def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: + """ + Args: + calculationType: The type of calculation. + model: The name of the calculation model. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the given calculation option to the given value. Before setting the options for the model, set the calculation model. See + def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """ + Args: + calculationModel: The name of the calculation model. + optionName: The XPath or name of the option to set. If this is not an XPath, the method sets the first attribute that matches the name. Example 1: CalculationGridSizeInCM in the Anisotropic Analytical Algorithm (AAA) sets the option /AAACalculationOptions/@CalculationGridSizeInCM. Example 2: MaximalDrillDepthInCM in the Proton Convolution Superposition (PCS) algorithm sets the option /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling1/@MaximalDrillDepthInCM. To set the values, for example, for the Drilling2 settings, you have to specify the entire XPath /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling2/@MaximalDrillDepthInCM. + optionValue: The value to set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets and validates the number of fractions and dose per fraction. + def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: + """ + Args: + numberOfFractions: The number of fractions. + dosePerFraction: The dose per fraction. + treatmentPercentage: The treatment percentage as a decimal number. For example, if the treatment percentage shown in the user interface is 80%, use 0.8. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets or changes target structure if valid dose is not affected by the change. + def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: Text.StringBuilder) -> bool: + """ + Args: + newTargetStructure: New target structure. + errorHint: Holder for error message. + """ + ... + + + # Gets the prescriptions and measures in the protocol that is associated with this plan setup. + def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List[ProtocolPhasePrescription], measures: List[ProtocolPhaseMeasure]) -> None: + """ + Args: + prescriptions: Returned list of prescriptions (plan objectives). + measures: Returned list of plan measures (quality indices). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. + def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: + """ + Args: + target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). + location: Reference point location in mm. + id: Reference point ID. + """ + ... + + + # Attaches event handling. + def AttachToCalcClient(self, doseCalcClient: ICalculationClient) -> Any: + ... + + + # Detaches event handling for the calculation client. + def DetachFromCalcClient(self, doseCalcClient: ICalculationClient) -> Any: + ... + + + # Reporting. + def Report(self, str: str) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimatesImpl(self, dvhCalculator: IPhotonCalculation, client: ICalculationClient, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str], license: LicenseId) -> Any: + """ + Args: + dvhCalculator: Interface for calculating the DVH estimates. + client: Calculation client. + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + license: License required for running the DVH estimation + """ + ... + + + # Check if plan approval status is valid. Note: Configured approval extensions are not executed. + def IsValidForPlanApproval(self, validationResults: List[PlanValidationResultEsapiDetail]) -> bool: + """ + Args: + validationResults: Validation results which contain detailed warning and error messages. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a new plan or field uncertainty with parameters. In case of field specific uncertainty, HUConversionError is overwritten to be always zero. Supported uncertainty types: RangeUncertainty, IsocenterShiftUncertainty, BaselineShiftUncertainty, RobustOptimizationUncertainty (=Perturbation). RangeUncertainty and RobustOptimizationUncertainty are proton specific. IsocenterShiftUncertainty and BaselineShiftUncertainty are photon specific. Field specific plan uncertainty dose can be used only for RobustOptimizationUncertainty. In case of BaselineShiftUncertainty isocenterShift parameter is actually target shift. + def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: + """ + Args: + uncertaintyType: Type of the plan uncertainty dose. + planSpecificUncertainty: The plan uncertainty dose is either plan specific (true) or field specific (false). + HUConversionError: Calibration curve error [%] + isocenterShift: Patient setup error [cm] + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the treatment order of the beams. + def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: + """ + Args: + orderedBeams: The beams in wanted order. All the beams of the plan must be present, otherwise the method fails. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. + def AddReferencePoint(self, refPoint: ReferencePoint) -> ReferencePoint: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Clears the calculation model for the given calculation type. + def ClearCalculationModel(self, calculationType: CalculationType) -> None: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Returns the selected calculation model for the given calculation type. Returns null if no model has been selected. + def GetCalculationModel(self, calculationType: CalculationType) -> str: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Gets the given calculation option value. + def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """ + Args: + calculationModel: The name of the calculation model. + optionName: The XPath or name of the option to set. + optionValue: The value of the given option. + """ + ... + + + # Gets all the calculation options and their values for the given calculation model. + def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: + """ + Args: + calculationModel: The name of the calculation model. + """ + ... + + + # Retrieves the name of DVH Estimation Model. + def GetDvhEstimationModelName(self) -> str: + ... + + + # Checks the limits of the current calculation area. + def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Moves the plan setup from its current course to the destination course, maintaining the plan UID. + def MoveToCourse(self, destinationCourse: Course) -> None: + """ + Args: + destinationCourse: The destination course for the plan setup. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove provided reference point from plan + def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to remove. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the calculation model for the given calculation type. + def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: + """ + Args: + calculationType: The type of calculation. + model: The name of the calculation model. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the given calculation option to the given value. Before setting the options for the model, set the calculation model. See + def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """ + Args: + calculationModel: The name of the calculation model. + optionName: The XPath or name of the option to set. If this is not an XPath, the method sets the first attribute that matches the name. Example 1: CalculationGridSizeInCM in the Anisotropic Analytical Algorithm (AAA) sets the option /AAACalculationOptions/@CalculationGridSizeInCM. Example 2: MaximalDrillDepthInCM in the Proton Convolution Superposition (PCS) algorithm sets the option /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling1/@MaximalDrillDepthInCM. To set the values, for example, for the Drilling2 settings, you have to specify the entire XPath /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling2/@MaximalDrillDepthInCM. + optionValue: The value to set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets and validates the number of fractions and dose per fraction. + def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: + """ + Args: + numberOfFractions: The number of fractions. + dosePerFraction: The dose per fraction. + treatmentPercentage: The treatment percentage as a decimal number. For example, if the treatment percentage shown in the user interface is 80%, use 0.8. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets or changes target structure if valid dose is not affected by the change. + def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: Text.StringBuilder) -> bool: + """ + Args: + newTargetStructure: New target structure. + errorHint: Holder for error message. + """ + ... + + + +class ProtocolPhaseMeasure: + """ + Represents the plan measures (quality indices) of the clinical protocol. + + Attributes: + TargetValue (float): The target value of this plan measure. + ActualValue (float): The calculated actual value of this plan measure. + TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. + Modifier (MeasureModifier): Measure Modifier. + StructureId (str): ID of the structure to which this measure is applied. + Type (MeasureType): Measure Type. + TypeText (str): Measure type as text, for instance, 'Conformity Index' in 'Conformity Index is more than 10.0'. + TargetValue (float): The target value of this plan measure. + ActualValue (float): The calculated actual value of this plan measure. + TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. + Modifier (MeasureModifier): Measure Modifier. + StructureId (str): ID of the structure to which this measure is applied. + Type (MeasureType): Measure Type. + TypeText (str): Measure type as text, for instance, 'Conformity Index' in 'Conformity Index is more than 10.0'. + """ + def __init__(self) -> None: ... + + TargetValue: float + + ActualValue: float + + TargetIsMet: Optional[bool] + + Modifier: MeasureModifier + + StructureId: str + + Type: MeasureType + + TypeText: str + + TargetValue: float + + ActualValue: float + + TargetIsMet: Optional[bool] + + Modifier: MeasureModifier + + StructureId: str + + Type: MeasureType + + TypeText: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ProtocolPhasePrescription: + """ + Represents the prescriptions (plan objectives) of the clinical protocol. + + Attributes: + TargetTotalDose (DoseValue): Total dose in absolute units specified for this prescription. + TargetFractionDose (DoseValue): Fraction dose in absolute units specified for this prescription. + ActualTotalDose (DoseValue): Actual total dose for this prescription + TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. + PrescModifier (PrescriptionModifier): Prescription Modifier. + PrescParameter (float): Value of the prescription parameter, for instance, '80' in 'At least 80% receives more than 2 Gy'. + PrescType (PrescriptionType): Prescription Type. + StructureId (str): ID of structure to which this prescription is applied. + TargetTotalDose (DoseValue): Total dose in absolute units specified for this prescription. + TargetFractionDose (DoseValue): Fraction dose in absolute units specified for this prescription. + ActualTotalDose (DoseValue): Actual total dose for this prescription + TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. + PrescModifier (PrescriptionModifier): Prescription Modifier. + PrescParameter (float): Value of the prescription parameter, for instance, '80' in 'At least 80% receives more than 2 Gy'. + PrescType (PrescriptionType): Prescription Type. + StructureId (str): ID of structure to which this prescription is applied. + """ + def __init__(self) -> None: ... + + TargetTotalDose: DoseValue + + TargetFractionDose: DoseValue + + ActualTotalDose: DoseValue + + TargetIsMet: Optional[bool] + + PrescModifier: PrescriptionModifier + + PrescParameter: float + + PrescType: PrescriptionType + + StructureId: str + + TargetTotalDose: DoseValue + + TargetFractionDose: DoseValue + + ActualTotalDose: DoseValue + + TargetIsMet: Optional[bool] + + PrescModifier: PrescriptionModifier + + PrescParameter: float + + PrescType: PrescriptionType + + StructureId: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ScriptEnvironment: + """ + Contains the runtime information of the application environment for the script. + + Attributes: + ApplicationName (str): The name of the active application. + VersionInfo (str): The version number of Eclipse. + ApiVersionInfo (str): The version number of Eclipse Scripting API. + Scripts (List[ApplicationScript]): Retrieves a list of all scripts known by the application. + Packages (List[ApplicationPackage]): Retrieves a list of all packages known by the application. + ApplicationName (str): The name of the active application. + VersionInfo (str): The version number of Eclipse. + ApiVersionInfo (str): The version number of Eclipse Scripting API. + Scripts (List[ApplicationScript]): Retrieves a list of all scripts known by the application. + Packages (List[ApplicationPackage]): Retrieves a list of all packages known by the application. + """ + # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. + @overload + def __init__(self, appName: str, scripts: List[IApplicationScript], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: + """ + Args: + appName: The application name. + scripts: A list of all scripts known by the application. + scriptExecutionEngine: The execution engine for executing a script from another script. + """ + ... + + + # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. + @overload + def __init__(self, appName: str, scripts: List[IApplicationScript], packages: List[IApplicationPackage], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: + """ + Args: + appName: The application name. + scripts: A list of all scripts known by the application. + packages: A list of all packages known by the application. + scriptExecutionEngine: The execution engine for executing a script from another script. + """ + ... + + + # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. + @overload + def __init__(self, appName: str, scripts: List[IApplicationScript], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: + """ + Args: + appName: The application name. + scripts: A list of all scripts known by the application. + scriptExecutionEngine: The execution engine for executing a script from another script. + """ + ... + + + # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. + @overload + def __init__(self, appName: str, scripts: List[IApplicationScript], packages: List[IApplicationPackage], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: + """ + Args: + appName: The application name. + scripts: A list of all scripts known by the application. + packages: A list of all packages known by the application. + scriptExecutionEngine: The execution engine for executing a script from another script. + """ + ... + + + ApplicationName: str + + VersionInfo: str + + ApiVersionInfo: str + + Scripts: List[ApplicationScript] + + Packages: List[ApplicationPackage] + + ApplicationName: str + + VersionInfo: str + + ApiVersionInfo: str + + Scripts: List[ApplicationScript] + + Packages: List[ApplicationPackage] + + # Executes an other script from script. This allows a script to be used for launching other scripts. Without using this special method, the system would be unaware of the other script, and thus could not save the correct script logs. + def ExecuteScript(self, scriptAssembly: Reflection.Assembly, scriptContext: ScriptContext, window: Windows.Window) -> None: + """ + Args: + scriptAssembly: The other script assembly. The assembly must have a location. + scriptContext: The script context that was passed to the executing script. + window: The script window. This is an optional parameter, can be null. + """ + ... + + + # Executes an other script from script. This allows a script to be used for launching other scripts. Without using this special method, the system would be unaware of the other script, and thus could not save the correct script logs. + def ExecuteScript(self, scriptAssembly: Reflection.Assembly, scriptContext: ScriptContext, window: Windows.Window) -> None: + """ + Args: + scriptAssembly: The other script assembly. The assembly must have a location. + scriptContext: The script context that was passed to the executing script. + window: The script window. This is an optional parameter, can be null. + """ + ... + + + +class Structure: + """ + A structure is a geometrical representation of an anatomical organ, a treatment volume, a marker, or a support structure. See the definition of a DICOM Structure for more information. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Structure. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Structure. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Structure. + ApprovalHistory (List[StructureApprovalHistoryEntry]): Returns the approval history of the structure. + CenterPoint (VVector): The center point of the structure. + Color (Windows.Media.Color): The color of the structure. + DicomType (str): The DICOM type of the structure, for example, PTV, MARKER, or ORGAN. + HasCalculatedPlans (bool): Checks if a calculated plan exists for the structure + HasSegment (bool): Checks if the structure has a segment. + IsApproved (bool): Checks if the structure is approved + IsEmpty (bool): Checks if the structure is empty. + IsHighResolution (bool): true if this structure is a high-resolution structure. Otherwise false. + IsTarget (bool): Checks if the structure is PTV, CTV or GTV + MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The mesh geometry. + ROINumber (int): The DICOM ROI Number of the structure. + SegmentVolume (SegmentVolume): Provides access to the segment volume of the structure. + StructureCode (StructureCode): The structure code that identifies this structure. + StructureCodeInfos (List[StructureCodeInfo]): Property value. + Volume (float): The calculated volume. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Structure. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Structure. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Structure. + ApprovalHistory (List[StructureApprovalHistoryEntry]): Returns the approval history of the structure. + CenterPoint (VVector): The center point of the structure. + Color (Windows.Media.Color): The color of the structure. + DicomType (str): The DICOM type of the structure, for example, PTV, MARKER, or ORGAN. + HasCalculatedPlans (bool): Checks if a calculated plan exists for the structure + HasSegment (bool): Checks if the structure has a segment. + IsApproved (bool): Checks if the structure is approved + IsEmpty (bool): Checks if the structure is empty. + IsHighResolution (bool): true if this structure is a high-resolution structure. Otherwise false. + IsTarget (bool): Checks if the structure is PTV, CTV or GTV + MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The mesh geometry. + ROINumber (int): The DICOM ROI Number of the structure. + SegmentVolume (SegmentVolume): Provides access to the segment volume of the structure. + StructureCode (StructureCode): The structure code that identifies this structure. + StructureCodeInfos (List[StructureCodeInfo]): Property value. + Volume (float): The calculated volume. + """ + def __init__(self) -> None: ... + + Id: str + + Name: str + + Comment: str + + ApprovalHistory: List[StructureApprovalHistoryEntry] + + CenterPoint: VVector + + Color: Windows.Media.Color + + DicomType: str + + HasCalculatedPlans: bool + + HasSegment: bool + + IsApproved: bool + + IsEmpty: bool + + IsHighResolution: bool + + IsTarget: bool + + MeshGeometry: Windows.Media.Media3D.MeshGeometry3D + + ROINumber: int + + SegmentVolume: SegmentVolume + + StructureCode: StructureCode + + StructureCodeInfos: List[StructureCodeInfo] + + Volume: float + + Id: str + + Name: str + + Comment: str + + ApprovalHistory: List[StructureApprovalHistoryEntry] + + CenterPoint: VVector + + Color: Windows.Media.Color + + DicomType: str + + HasCalculatedPlans: bool + + HasSegment: bool + + IsApproved: bool + + IsEmpty: bool + + IsHighResolution: bool + + IsTarget: bool + + MeshGeometry: Windows.Media.Media3D.MeshGeometry3D + + ROINumber: int + + SegmentVolume: SegmentVolume + + StructureCode: StructureCode + + StructureCodeInfos: List[StructureCodeInfo] + + Volume: float + + # An implicit conversion from Structure to SegmentVolume makes it easier to use the SegmentVolume functionality, such as the boolean operators and margin. + def op_Implicit(self, structure: SegmentVolume) -> SegmentVolume: + """ + Args: + structure: The converted structure. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds the given contour to the given image plane. + def AddContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: + """ + Args: + contour: The contour points, z coordinates are ignored. + z: A zero-based image plane index. + """ + ... + + + # Boolean And operation for structures that have a segment model. Provided here for convenience. + def And(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this segment volume. + """ + ... + + + # Asymmetric margin operation for structures that have a segment model. Provided here for convenience. + def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: + """ + Args: + margins: The margins aligned to the axes of the image coordinate system, in millimeters. The maximum is 50. + """ + ... + + + # Returns true if this structure can be converted to a high-resolution structure. + def CanConvertToHighResolution(self) -> bool: + ... + + + # Checks if the segment volume of the structure can be edited. + def CanEditSegmentVolume(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If the segment volume cannot be edited, contains the error message. + """ + ... + + + # Checks if the HU value of the structure can be modified. + def CanSetAssignedHU(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If the HU value cannot be set, contains the error message. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Clears the contours on the given image plane. + def ClearAllContoursOnImagePlane(self, z: int) -> None: + """ + Args: + z: A zero-based image plane index. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a structure out of an isodose level. + def ConvertDoseLevelToStructure(self, dose: Dose, doseLevel: DoseValue) -> None: + """ + Args: + dose: The dose from which the dose level is extracted. + doseLevel: The dose level. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Converts this structure to a high-resolution structure. Increases the resolution of the segment volume in cases where the image size is larger than 256x256 voxels. + def ConvertToHighResolution(self) -> None: + ... + + + # Returns the HU value of the material. + def GetAssignedHU(self, huValue: float) -> bool: + """ + Args: + huValue: Double value that will contain the HU value upon return from this method + """ + ... + + + # If the structure has a segment, gets the contours of the structure on the given image plane. + def GetContoursOnImagePlane(self, z: int) -> Array[Array[VVector]]: + """ + Args: + z: Zero based image plane index. + """ + ... + + + # If the structure has a segment, returns the number of separate parts. + def GetNumberOfSeparateParts(self) -> int: + ... + + + # If the structure is a reference line, gets its points. + def GetReferenceLinePoints(self) -> Array[VVector]: + ... + + + # If the structure has a segment, gets the segment profile. + def GetSegmentProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Collections.BitArray) -> SegmentProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # If the structure has a segment, checks if the given point lies within the structure. + def IsPointInsideSegment(self, point: VVector) -> bool: + """ + Args: + point: Location of the point. + """ + ... + + + # Margin operation for structures that have a segment model. Provided here for convenience. + def Margin(self, marginInMM: float) -> SegmentVolume: + """ + Args: + marginInMM: The used margin in millimeters. The maximum is 50. + """ + ... + + + # Boolean Not operation for structures that have a segment model. Provided here for convenience. + def Not(self) -> SegmentVolume: + ... + + + # Boolean Or operation for structures that have a segment model. Provided here for convenience. + def Or(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Resets the HU value of the material to "undefined". + def ResetAssignedHU(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the HU value of the material. + def SetAssignedHU(self, huValue: float) -> None: + """ + Args: + huValue: A double value that contains the HU value to be set. + """ + ... + + + # Boolean Sub operation for structures that have a segment model. Provided here for convenience. + def Sub(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is subtracted from this segment volume. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Subtracts the given contour from the given image plane. + def SubtractContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: + """ + Args: + contour: The contour points, z coordinates are ignored. + z: A zero-based image plane index. + """ + ... + + + # Boolean Xor operation for structures that have a segment model. Provided here for convenience. + def Xor(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # An implicit conversion from Structure to SegmentVolume makes it easier to use the SegmentVolume functionality, such as the boolean operators and margin. + def op_Implicit(self, structure: SegmentVolume) -> SegmentVolume: + """ + Args: + structure: The converted structure. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds the given contour to the given image plane. + def AddContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: + """ + Args: + contour: The contour points, z coordinates are ignored. + z: A zero-based image plane index. + """ + ... + + + # Boolean And operation for structures that have a segment model. Provided here for convenience. + def And(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this segment volume. + """ + ... + + + # Asymmetric margin operation for structures that have a segment model. Provided here for convenience. + def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: + """ + Args: + margins: The margins aligned to the axes of the image coordinate system, in millimeters. The maximum is 50. + """ + ... + + + # Returns true if this structure can be converted to a high-resolution structure. + def CanConvertToHighResolution(self) -> bool: + ... + + + # Checks if the segment volume of the structure can be edited. + def CanEditSegmentVolume(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If the segment volume cannot be edited, contains the error message. + """ + ... + + + # Checks if the HU value of the structure can be modified. + def CanSetAssignedHU(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If the HU value cannot be set, contains the error message. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Clears the contours on the given image plane. + def ClearAllContoursOnImagePlane(self, z: int) -> None: + """ + Args: + z: A zero-based image plane index. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a structure out of an isodose level. + def ConvertDoseLevelToStructure(self, dose: Dose, doseLevel: DoseValue) -> None: + """ + Args: + dose: The dose from which the dose level is extracted. + doseLevel: The dose level. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Converts this structure to a high-resolution structure. Increases the resolution of the segment volume in cases where the image size is larger than 256x256 voxels. + def ConvertToHighResolution(self) -> None: + ... + + + # Returns the HU value of the material. + def GetAssignedHU(self, huValue: float) -> bool: + """ + Args: + huValue: Double value that will contain the HU value upon return from this method + """ + ... + + + # If the structure has a segment, gets the contours of the structure on the given image plane. + def GetContoursOnImagePlane(self, z: int) -> Array[Array[VVector]]: + """ + Args: + z: Zero based image plane index. + """ + ... + + + # If the structure has a segment, returns the number of separate parts. + def GetNumberOfSeparateParts(self) -> int: + ... + + + # If the structure is a reference line, gets its points. + def GetReferenceLinePoints(self) -> Array[VVector]: + ... + + + # If the structure has a segment, gets the segment profile. + def GetSegmentProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Collections.BitArray) -> SegmentProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # If the structure has a segment, checks if the given point lies within the structure. + def IsPointInsideSegment(self, point: VVector) -> bool: + """ + Args: + point: Location of the point. + """ + ... + + + # Margin operation for structures that have a segment model. Provided here for convenience. + def Margin(self, marginInMM: float) -> SegmentVolume: + """ + Args: + marginInMM: The used margin in millimeters. The maximum is 50. + """ + ... + + + # Boolean Not operation for structures that have a segment model. Provided here for convenience. + def Not(self) -> SegmentVolume: + ... + + + # Boolean Or operation for structures that have a segment model. Provided here for convenience. + def Or(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Resets the HU value of the material to "undefined". + def ResetAssignedHU(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the HU value of the material. + def SetAssignedHU(self, huValue: float) -> None: + """ + Args: + huValue: A double value that contains the HU value to be set. + """ + ... + + + # Boolean Sub operation for structures that have a segment model. Provided here for convenience. + def Sub(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is subtracted from this segment volume. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Subtracts the given contour from the given image plane. + def SubtractContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: + """ + Args: + contour: The contour points, z coordinates are ignored. + z: A zero-based image plane index. + """ + ... + + + # Boolean Xor operation for structures that have a segment model. Provided here for convenience. + def Xor(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + +class StructureSet: + """ + A structure set is a container for structures of a patient, including anatomical organs, treatment volumes and markers, and support structures. + + Attributes: + Structures (List[Structure]): Used for navigating to the child structures. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the structure set. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the structure set. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the structure set. + ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the structure set. + Image (Image): Used for navigating to the image. + Patient (Patient): Used for navigating to the patient. + Series (Series): The series that contains this plan. Null if the plan is not connected to a series. + SeriesUID (str): The DICOM UID of the series that contains this structure set. Empty string if the structure set is not connected to a series. + UID (str): DICOM UID. + Structures (List[Structure]): Used for navigating to the child structures. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the structure set. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the structure set. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the structure set. + ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the structure set. + Image (Image): Used for navigating to the image. + Patient (Patient): Used for navigating to the patient. + Series (Series): The series that contains this plan. Null if the plan is not connected to a series. + SeriesUID (str): The DICOM UID of the series that contains this structure set. Empty string if the structure set is not connected to a series. + UID (str): DICOM UID. + """ + def __init__(self) -> None: ... + + Structures: List[Structure] + + Id: str + + Name: str + + Comment: str + + ApplicationScriptLogs: List[ApplicationScriptLog] + + Image: Image + + Patient: Patient + + Series: Series + + SeriesUID: str + + UID: str + + Structures: List[Structure] + + Id: str + + Name: str + + Comment: str + + ApplicationScriptLogs: List[ApplicationScriptLog] + + Image: Image + + Patient: Patient + + Series: Series + + SeriesUID: str + + UID: str + + # [Availability of this method depends on your Eclipse Scripting API license] Adds couch structures to the StructureSet. Eclipse can model certain couches for photon treatment planning. A couch is modeled as a set of couch structures.The couch panel surface and interior, movable structural rails and grid(for Unipanel only) are each modeled as separate couch structures. The structure code of a couch structure is Support by default. You can change it to another structure code if necessary. The volume type of a couch structure is always Support. Couch structures are modeled inside a 3D image. If the 3D image is too small, this method will always enlarge the image to fit the couch structures. + def AddCouchStructures(self, couchModel: str, orientation: PatientOrientation, railA: RailPosition, railB: RailPosition, surfaceHU: Optional[float], interiorHU: Optional[float], railHU: Optional[float], addedStructures: IReadOnlyList[Structure], imageResized: bool, error: str) -> bool: + """ + Args: + couchModel: The id of the couch profile configured in Eclipse to use when creating the couch structures. + orientation: Patient orientation specifying where the couch structures are added. Pass NoOrientation to take the orientation from the image. + railA: Position of moveable rail A. + railB: Position of moveable rail B. + surfaceHU: HU value of the modeled couch surface. Pass null to use the setting from the specified couch profile or override by passing another value. + interiorHU: HU value of the modeled couch interior. Pass null to use the setting from the specified couch profile or override by passing another value. + railHU: HU value of the modeled couch rails. Pass null to use the setting from the specified couch profile or override by passing another value. + addedStructures: Returned list of added couch structures if successful. + imageResized: True if image was resized. + error: Returned error message if call failed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes couch structures from the StructureSet. + def RemoveCouchStructures(self, removedStructureIds: IReadOnlyList[str], error: str) -> bool: + """ + Args: + removedStructureIds: Returned list of removed couch structure IDs if successful. + error: Returned error message if call failed. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new reference line. + def AddReferenceLine(self, name: str, id: str, referenceLinePoints: Array[VVector]) -> Structure: + """ + Args: + name: Reference line name. + id: Reference line Id. + referenceLinePoints: Reference line points. Number of points: 1 .. 500. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure according to the DICOM structure type. + def AddStructure(self, dicomType: str, id: str) -> Structure: + """ + Args: + dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". + id: The identifier for the new structure. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure based on structure code. The DICOM structure type and structure ID are automatically assigned. + def AddStructure(self, code: StructureCodeInfo) -> Structure: + """ + Args: + code: The structure code. + """ + ... + + + # This method is used to verify whether it is possible to add couch structures to the StructureSet. + def CanAddCouchStructures(self, error: str) -> bool: + """ + Args: + error: Returned reason why couch structures cannot be added if method returns false. + """ + ... + + + # Returns true if it is possible to add the given type of structure to the structure set. + def CanAddStructure(self, dicomType: str, id: str) -> bool: + """ + Args: + dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". + id: The identifier for the new structure. + """ + ... + + + # This method is used to verify whether it is possible to remove couch structures from the StructureSet. + def CanRemoveCouchStructures(self, error: str) -> bool: + """ + Args: + error: Returned reason why couch structures cannot be removed if method returns false. + """ + ... + + + # Returns true if it is possible to remove the given structure from the structure set. + def CanRemoveStructure(self, structure: Structure) -> bool: + """ + Args: + structure: The structure to check. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a copy of this structure set. + def Copy(self) -> StructureSet: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new Body structure and searches Body with the specified parameters. The existing Body structure is returned, if there is one. + def CreateAndSearchBody(self, parameters: SearchBodyParameters) -> Structure: + """ + Args: + parameters: Parameters for the Search Body feature. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Deletes this structure set. + def Delete(self) -> None: + ... + + + # Gets a default set of Search Body parameters. + def GetDefaultSearchBodyParameters(self) -> SearchBodyParameters: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the structure from this structure set if removal is allowed. + def RemoveStructure(self, structure: Structure) -> None: + """ + Args: + structure: The structure to remove. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds couch structures to the StructureSet. Eclipse can model certain couches for photon treatment planning. A couch is modeled as a set of couch structures.The couch panel surface and interior, movable structural rails and grid(for Unipanel only) are each modeled as separate couch structures. The structure code of a couch structure is Support by default. You can change it to another structure code if necessary. The volume type of a couch structure is always Support. Couch structures are modeled inside a 3D image. If the 3D image is too small, this method will always enlarge the image to fit the couch structures. + def AddCouchStructures(self, couchModel: str, orientation: PatientOrientation, railA: RailPosition, railB: RailPosition, surfaceHU: Optional[float], interiorHU: Optional[float], railHU: Optional[float], addedStructures: IReadOnlyList[Structure], imageResized: bool, error: str) -> bool: + """ + Args: + couchModel: The id of the couch profile configured in Eclipse to use when creating the couch structures. + orientation: Patient orientation specifying where the couch structures are added. Pass NoOrientation to take the orientation from the image. + railA: Position of moveable rail A. + railB: Position of moveable rail B. + surfaceHU: HU value of the modeled couch surface. Pass null to use the setting from the specified couch profile or override by passing another value. + interiorHU: HU value of the modeled couch interior. Pass null to use the setting from the specified couch profile or override by passing another value. + railHU: HU value of the modeled couch rails. Pass null to use the setting from the specified couch profile or override by passing another value. + addedStructures: Returned list of added couch structures if successful. + imageResized: True if image was resized. + error: Returned error message if call failed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes couch structures from the StructureSet. + def RemoveCouchStructures(self, removedStructureIds: IReadOnlyList[str], error: str) -> bool: + """ + Args: + removedStructureIds: Returned list of removed couch structure IDs if successful. + error: Returned error message if call failed. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new reference line. + def AddReferenceLine(self, name: str, id: str, referenceLinePoints: Array[VVector]) -> Structure: + """ + Args: + name: Reference line name. + id: Reference line Id. + referenceLinePoints: Reference line points. Number of points: 1 .. 500. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure according to the DICOM structure type. + def AddStructure(self, dicomType: str, id: str) -> Structure: + """ + Args: + dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". + id: The identifier for the new structure. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure based on structure code. The DICOM structure type and structure ID are automatically assigned. + def AddStructure(self, code: StructureCodeInfo) -> Structure: + """ + Args: + code: The structure code. + """ + ... + + + # This method is used to verify whether it is possible to add couch structures to the StructureSet. + def CanAddCouchStructures(self, error: str) -> bool: + """ + Args: + error: Returned reason why couch structures cannot be added if method returns false. + """ + ... + + + # Returns true if it is possible to add the given type of structure to the structure set. + def CanAddStructure(self, dicomType: str, id: str) -> bool: + """ + Args: + dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". + id: The identifier for the new structure. + """ + ... + + + # This method is used to verify whether it is possible to remove couch structures from the StructureSet. + def CanRemoveCouchStructures(self, error: str) -> bool: + """ + Args: + error: Returned reason why couch structures cannot be removed if method returns false. + """ + ... + + + # Returns true if it is possible to remove the given structure from the structure set. + def CanRemoveStructure(self, structure: Structure) -> bool: + """ + Args: + structure: The structure to check. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a copy of this structure set. + def Copy(self) -> StructureSet: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new Body structure and searches Body with the specified parameters. The existing Body structure is returned, if there is one. + def CreateAndSearchBody(self, parameters: SearchBodyParameters) -> Structure: + """ + Args: + parameters: Parameters for the Search Body feature. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Deletes this structure set. + def Delete(self) -> None: + ... + + + # Gets a default set of Search Body parameters. + def GetDefaultSearchBodyParameters(self) -> SearchBodyParameters: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the structure from this structure set if removal is allowed. + def RemoveStructure(self, structure: Structure) -> None: + """ + Args: + structure: The structure to remove. + """ + ... + + + +class TradeoffExplorationContext: + """ + + Attributes: + HasPlanCollection (bool): True if the trade-off exploration context has a plan collection, so that the trade-offs can be explored using the + CanLoadSavedPlanCollection (bool): True if a previously saved plan collection can be loaded. + CanCreatePlanCollection (bool): True if a plan collection can be created. + CanUsePlanDoseAsIntermediateDose (bool): True if plan dose can be used as intermediate dose in + CanUseHybridOptimizationInPlanGeneration (bool): True if VMAT-IMRT hybrid optimization can be used in + TradeoffObjectiveCandidates (List[OptimizationObjective]): Available optimization objectives that can be selected for trade-off exploration in multi-criteria optimization. + TradeoffObjectives (Collections.Generic.IReadOnlyCollection[TradeoffObjective]): Trade-off objectives. If + TradeoffStructureCandidates (List[Structure]): Available structures that can be selected for trade-off exploration in multi-criteria optimization. Only organs at risk can be used for trade-off exploration at the structure level. + TargetStructures (List[Structure]): Target structures in trade-off exploration. These structures cannot be selected for trade-off exploration at the structure level. Homogeneity indices only apply to the target structures. + CurrentDose (Dose): Dose at the current location on the Pareto surface (the current trade-offs). Returns null if no valid dose exists. + HasPlanCollection (bool): True if the trade-off exploration context has a plan collection, so that the trade-offs can be explored using the + CanLoadSavedPlanCollection (bool): True if a previously saved plan collection can be loaded. + CanCreatePlanCollection (bool): True if a plan collection can be created. + CanUsePlanDoseAsIntermediateDose (bool): True if plan dose can be used as intermediate dose in + CanUseHybridOptimizationInPlanGeneration (bool): True if VMAT-IMRT hybrid optimization can be used in + TradeoffObjectiveCandidates (List[OptimizationObjective]): Available optimization objectives that can be selected for trade-off exploration in multi-criteria optimization. + TradeoffObjectives (Collections.Generic.IReadOnlyCollection[TradeoffObjective]): Trade-off objectives. If + TradeoffStructureCandidates (List[Structure]): Available structures that can be selected for trade-off exploration in multi-criteria optimization. Only organs at risk can be used for trade-off exploration at the structure level. + TargetStructures (List[Structure]): Target structures in trade-off exploration. These structures cannot be selected for trade-off exploration at the structure level. Homogeneity indices only apply to the target structures. + CurrentDose (Dose): Dose at the current location on the Pareto surface (the current trade-offs). Returns null if no valid dose exists. + + Note: + To be able to get the + """ + # Creates a trade-off exploration context for a given plan. Acquires an MCO license for the lifetime of the application. + @overload + def __init__(self, param1: ExternalPlanSetup, param2: ILicenseManager, param3: IMcoControllerWithLocalDoseCorrection, param4: IMcoRuleValidator) -> None: + ... + + + # Creates a trade-off exploration context for a given plan. Acquires an MCO license for the lifetime of the application. + @overload + def __init__(self, param1: ExternalPlanSetup, param2: ILicenseManager, param3: IMcoControllerWithLocalDoseCorrection, param4: IMcoRuleValidator) -> None: + ... + + + HasPlanCollection: bool + + CanLoadSavedPlanCollection: bool + + CanCreatePlanCollection: bool + + CanUsePlanDoseAsIntermediateDose: bool + + CanUseHybridOptimizationInPlanGeneration: bool + + TradeoffObjectiveCandidates: List[OptimizationObjective] + + TradeoffObjectives: Collections.Generic.IReadOnlyCollection[TradeoffObjective] + + TradeoffStructureCandidates: List[Structure] + + TargetStructures: List[Structure] + + CurrentDose: Dose + + HasPlanCollection: bool + + CanLoadSavedPlanCollection: bool + + CanCreatePlanCollection: bool + + CanUsePlanDoseAsIntermediateDose: bool + + CanUseHybridOptimizationInPlanGeneration: bool + + TradeoffObjectiveCandidates: List[OptimizationObjective] + + TradeoffObjectives: Collections.Generic.IReadOnlyCollection[TradeoffObjective] + + TradeoffStructureCandidates: List[Structure] + + TargetStructures: List[Structure] + + CurrentDose: Dose + + # Loads a previously saved plan collection and sets + def LoadSavedPlanCollection(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan collection for trade-off exploration and sets + def CreatePlanCollection(self, continueOptimization: bool, intermediateDoseMode: TradeoffPlanGenerationIntermediateDoseMode, useHybridOptimizationForVmat: bool) -> bool: + """ + Args: + continueOptimization: True if the starting point for the trade-off exploration should be created by continuing optimization for the existing plan. Otherwise, the starting point is created by starting optimization from the beginning. + intermediateDoseMode: Specifies which intermediate dose mode is used for plan generation. + useHybridOptimizationForVmat: True if VMAT-IMRT hybrid optimization should be used in VMAT plan generation. Otherwise native VMAT optimization is used. + """ + ... + + + # Gets the current relative cost of a trade-off objective. The costs are normalized to the range [0,1]. If + def GetObjectiveCost(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the cost. + """ + ... + + + # Gets the lower limit value for a trade-off objective. It is not possible to set the cost value of the objective below this value. The range of the objective may be limited because one or more objective has a restrictor ( + def GetObjectiveLowerLimit(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the lower limit. + """ + ... + + + # Gets the upper limit value for a trade-off objective. It is not possible to set the cost value of the objective above this value. The range of the objective may be limited because one or more objective has a restrictor ( + def GetObjectiveUpperLimit(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the upper limit. + """ + ... + + + # Gets the current upper limit of a trade-off objective. The limits are normalized to the range [0,1]. If + def GetObjectiveUpperRestrictor(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective to get the upper limit. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] A single trade-off objective specifies a one dimensional subspace of the Pareto surface. By adjusting the relative cost of the objective, it is possible to move in this one dimensional subspace. The difference between the current relative cost and the new relative cost specifies the direction of the movement. If the difference is negative, the movement is towards the extreme case where the given trade-off objective is emphasized at the cost of all other objectives. If the difference is positive, the movement is away from the extreme case. If + def SetObjectiveCost(self, tradeoffObjective: TradeoffObjective, cost: float) -> None: + """ + Args: + tradeoffObjective: Trade-off objective that specifies the one dimensional subspace. + cost: The relative cost is defined as an interval [0,1]. A smaller value gives more emphasis to the given trade-off objective. + """ + ... + + + # Sets an upper limit for a trade-off objective. The limits are normalized to the range [0,1]. If + def SetObjectiveUpperRestrictor(self, tradeoffObjective: TradeoffObjective, restrictorValue: float) -> None: + """ + Args: + tradeoffObjective: Optimization objective selected for trade-off exploration. This trade-off objective specifies the one dimensional subspace of the Pareto surface. + restrictorValue: New upper limit [0,1] of the given trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Resets the costs of a trade-off objective to correspond to the balanced plan. If + def ResetToBalancedPlan(self) -> None: + ... + + + # Calculates a DVH for a given structure based on the dose at the current location on the Pareto surface (current trade-offs). If + def GetStructureDvh(self, structure: Structure) -> DVHData: + """ + Args: + structure: Structure for which the DVH is calculated. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a homogeneity objective for a given target structure to be used as a trade-off objective. Only target structures with an upper dose objective with larger than zero priority may have a homogeneity objective. Adding a new trade-off objective sets + def AddTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: + """ + Args: + targetStructure: Structure for which the homogeneity objective is created. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from all objectives associated with the given structure. Targets cannot be used in trade-off exploration at the structure level. Structures that do not have objectives or are not included in the plan cannot be added as trade-off objectives. Adding a new trade-off objective sets + def AddTradeoffObjective(self, structure: Structure) -> bool: + """ + Args: + structure: Structure to be added as a trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from an individual optimization objective. Adding a new trade-off objective sets + def AddTradeoffObjective(self, objective: OptimizationObjective) -> bool: + """ + Args: + objective: Objective to be added as a trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the given trade-off objective. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTradeoffObjective(self, tradeoffObjective: TradeoffObjective) -> bool: + """ + Args: + tradeoffObjective: Trade-off objective to be removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the homogeneity trade-off objective of the given target structure. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: + """ + Args: + targetStructure: Target structure for which the homogeneity objective is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the trade-off objective of the given structure. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTradeoffObjective(self, structure: Structure) -> bool: + """ + Args: + structure: Structure for which the trade-off objective is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan collection from the plan setup and database. Removing the plan collection sets + def RemovePlanCollection(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes all the trade-off objectives of the current plan collection. Removing all trade-off objectives invalidates the current plan collection and sets + def RemoveAllTradeoffObjectives(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Saves the trade-off exploration result. Also applies the trade-off exploration result to the plan setup for IMRT plans. For VMAT plans, to apply the results to the plan setup, an additional call to the + def ApplyTradeoffExplorationResult(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Applies the trade-off exploration result to the plan setup for VMAT plans. + def CreateDeliverableVmatPlan(self, useIntermediateDose: bool) -> bool: + """ + Args: + useIntermediateDose: True if intermediate dose is used when creating the VMAT plan. + """ + ... + + + # Loads a previously saved plan collection and sets + def LoadSavedPlanCollection(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan collection for trade-off exploration and sets + def CreatePlanCollection(self, continueOptimization: bool, intermediateDoseMode: TradeoffPlanGenerationIntermediateDoseMode, useHybridOptimizationForVmat: bool) -> bool: + """ + Args: + continueOptimization: True if the starting point for the trade-off exploration should be created by continuing optimization for the existing plan. Otherwise, the starting point is created by starting optimization from the beginning. + intermediateDoseMode: Specifies which intermediate dose mode is used for plan generation. + useHybridOptimizationForVmat: True if VMAT-IMRT hybrid optimization should be used in VMAT plan generation. Otherwise native VMAT optimization is used. + """ + ... + + + # Gets the current relative cost of a trade-off objective. The costs are normalized to the range [0,1]. If + def GetObjectiveCost(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the cost. + """ + ... + + + # Gets the lower limit value for a trade-off objective. It is not possible to set the cost value of the objective below this value. The range of the objective may be limited because one or more objective has a restrictor ( + def GetObjectiveLowerLimit(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the lower limit. + """ + ... + + + # Gets the upper limit value for a trade-off objective. It is not possible to set the cost value of the objective above this value. The range of the objective may be limited because one or more objective has a restrictor ( + def GetObjectiveUpperLimit(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the upper limit. + """ + ... + + + # Gets the current upper limit of a trade-off objective. The limits are normalized to the range [0,1]. If + def GetObjectiveUpperRestrictor(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective to get the upper limit. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] A single trade-off objective specifies a one dimensional subspace of the Pareto surface. By adjusting the relative cost of the objective, it is possible to move in this one dimensional subspace. The difference between the current relative cost and the new relative cost specifies the direction of the movement. If the difference is negative, the movement is towards the extreme case where the given trade-off objective is emphasized at the cost of all other objectives. If the difference is positive, the movement is away from the extreme case. If + def SetObjectiveCost(self, tradeoffObjective: TradeoffObjective, cost: float) -> None: + """ + Args: + tradeoffObjective: Trade-off objective that specifies the one dimensional subspace. + cost: The relative cost is defined as an interval [0,1]. A smaller value gives more emphasis to the given trade-off objective. + """ + ... + + + # Sets an upper limit for a trade-off objective. The limits are normalized to the range [0,1]. If + def SetObjectiveUpperRestrictor(self, tradeoffObjective: TradeoffObjective, restrictorValue: float) -> None: + """ + Args: + tradeoffObjective: Optimization objective selected for trade-off exploration. This trade-off objective specifies the one dimensional subspace of the Pareto surface. + restrictorValue: New upper limit [0,1] of the given trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Resets the costs of a trade-off objective to correspond to the balanced plan. If + def ResetToBalancedPlan(self) -> None: + ... + + + # Calculates a DVH for a given structure based on the dose at the current location on the Pareto surface (current trade-offs). If + def GetStructureDvh(self, structure: Structure) -> DVHData: + """ + Args: + structure: Structure for which the DVH is calculated. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a homogeneity objective for a given target structure to be used as a trade-off objective. Only target structures with an upper dose objective with larger than zero priority may have a homogeneity objective. Adding a new trade-off objective sets + def AddTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: + """ + Args: + targetStructure: Structure for which the homogeneity objective is created. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from all objectives associated with the given structure. Targets cannot be used in trade-off exploration at the structure level. Structures that do not have objectives or are not included in the plan cannot be added as trade-off objectives. Adding a new trade-off objective sets + def AddTradeoffObjective(self, structure: Structure) -> bool: + """ + Args: + structure: Structure to be added as a trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from an individual optimization objective. Adding a new trade-off objective sets + def AddTradeoffObjective(self, objective: OptimizationObjective) -> bool: + """ + Args: + objective: Objective to be added as a trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the given trade-off objective. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTradeoffObjective(self, tradeoffObjective: TradeoffObjective) -> bool: + """ + Args: + tradeoffObjective: Trade-off objective to be removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the homogeneity trade-off objective of the given target structure. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: + """ + Args: + targetStructure: Target structure for which the homogeneity objective is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the trade-off objective of the given structure. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTradeoffObjective(self, structure: Structure) -> bool: + """ + Args: + structure: Structure for which the trade-off objective is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan collection from the plan setup and database. Removing the plan collection sets + def RemovePlanCollection(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes all the trade-off objectives of the current plan collection. Removing all trade-off objectives invalidates the current plan collection and sets + def RemoveAllTradeoffObjectives(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Saves the trade-off exploration result. Also applies the trade-off exploration result to the plan setup for IMRT plans. For VMAT plans, to apply the results to the plan setup, an additional call to the + def ApplyTradeoffExplorationResult(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Applies the trade-off exploration result to the plan setup for VMAT plans. + def CreateDeliverableVmatPlan(self, useIntermediateDose: bool) -> bool: + """ + Args: + useIntermediateDose: True if intermediate dose is used when creating the VMAT plan. + """ + ... + + + +class TypeBasedIdValidator: + """ + A utility class for validating the data object identifier. + """ + def __init__(self) -> None: ... + + # Returns true if the given identifier is valid for the given data object. + def IsValidId(self, id: str, dataObject: ApiDataObject, errorHint: Text.StringBuilder) -> bool: + """ + Args: + id: The new identifier to check. + dataObject: The data object for whom the new identifier is checked. + errorHint: The error string that is set if the validation failed. + """ + ... + + + # Throws System.ArgumentException if the given identifier is not valid for the given data object. + def ThrowIfNotValidId(self, id: str, dataObject: ApiDataObject) -> None: + """ + Args: + id: The new identifier to check. + dataObject: The data object for whom the new identifier is checked. + """ + ... + + + # Returns true if the given identifier is valid for the given data object. + def IsValidId(self, id: str, dataObject: ApiDataObject, errorHint: Text.StringBuilder) -> bool: + """ + Args: + id: The new identifier to check. + dataObject: The data object for whom the new identifier is checked. + errorHint: The error string that is set if the validation failed. + """ + ... + + + # Throws System.ArgumentException if the given identifier is not valid for the given data object. + def ThrowIfNotValidId(self, id: str, dataObject: ApiDataObject) -> None: + """ + Args: + id: The new identifier to check. + dataObject: The data object for whom the new identifier is checked. + """ + ... + + + +class User: + """ + Represents a user. + + Attributes: + Id (str): The identifier of the user. + Language (str): The language of the user. + Name (str): The display name of the user. + Id (str): The identifier of the user. + Language (str): The language of the user. + Name (str): The display name of the user. + """ + def __init__(self) -> None: ... + + Id: str + + Language: str + + Name: str + + Id: str + + Language: str + + Name: str + + # Returns a string that represents the current object. + def ToString(self) -> str: + ... + + + # Determines whether the specified Object is equal to the current Object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: Object to compare with the current object + """ + ... + + + # Serves as a hash function for this type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: User, b: User) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: User, b: User) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns a string that represents the current object. + def ToString(self) -> str: + ... + + + # Determines whether the specified Object is equal to the current Object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: Object to compare with the current object + """ + ... + + + # Serves as a hash function for this type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: User, b: User) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: User, b: User) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Diagnosis: + """ + Represents a diagnosis of the patient. + + Attributes: + ClinicalDescription (str): User-defined clinical description of the diagnosis. + Code (str): The disease code from the specified code table. + CodeTable (str): Identifies the coding system table, for example, ICD-9-CM. + ClinicalDescription (str): User-defined clinical description of the diagnosis. + Code (str): The disease code from the specified code table. + CodeTable (str): Identifies the coding system table, for example, ICD-9-CM. + """ + def __init__(self) -> None: ... + + ClinicalDescription: str + + Code: str + + CodeTable: str + + ClinicalDescription: str + + Code: str + + CodeTable: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class DVHEstimationModelSummary: + """ + A summary of an DVH Estimation Model. Contains the needed information for selecting a model. + + Attributes: + Description (str): Model Description + IsPublished (bool): True if set to published state. Only published models are available for optimizing. + IsTrained (bool): True if the model contains data. + ModelDataVersion (str): Version + ModelParticleType (ParticleType): Returns particle type for the model. Either ParticleType.Proton or ParticleType.Photon. + ModelUID (str): Model UID. To be used for the Load command. + Name (str): Display Name + Revision (int): Publish revision of the model + TreatmentSite (str): Indicating the treatment site the model was created for + Description (str): Model Description + IsPublished (bool): True if set to published state. Only published models are available for optimizing. + IsTrained (bool): True if the model contains data. + ModelDataVersion (str): Version + ModelParticleType (ParticleType): Returns particle type for the model. Either ParticleType.Proton or ParticleType.Photon. + ModelUID (str): Model UID. To be used for the Load command. + Name (str): Display Name + Revision (int): Publish revision of the model + TreatmentSite (str): Indicating the treatment site the model was created for + """ + def __init__(self) -> None: ... + + Description: str + + IsPublished: bool + + IsTrained: bool + + ModelDataVersion: str + + ModelParticleType: ParticleType + + ModelUID: str + + Name: str + + Revision: int + + TreatmentSite: str + + Description: str + + IsPublished: bool + + IsTrained: bool + + ModelDataVersion: str + + ModelParticleType: ParticleType + + ModelUID: str + + Name: str + + Revision: int + + TreatmentSite: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class EnergyMode: + """ + Represents an energy mode. + + Attributes: + IsElectron (bool): Checks if the mode is electron. + IsPhoton (bool): Checks if the mode is photon. + IsProton (bool): Checks if the mode is proton. + IsElectron (bool): Checks if the mode is electron. + IsPhoton (bool): Checks if the mode is photon. + IsProton (bool): Checks if the mode is proton. + """ + def __init__(self) -> None: ... + + IsElectron: bool + + IsPhoton: bool + + IsProton: bool + + IsElectron: bool + + IsPhoton: bool + + IsProton: bool + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class EstimatedDVH: + """ + Represents an estimated Dose Volume Histogram (DVH) curve. + + Attributes: + CurveData (Array[DVHPoint]): The points of the estimated DVH curve. + PlanSetup (PlanSetup): Parent plan. + PlanSetupId (str): ID of the parent plan. + Structure (Structure): Parent structure. + StructureId (str): ID of the parent structure. + TargetDoseLevel (DoseValue): Dose level of the associated target structure. + Type (DVHEstimateType): Type of DVH estimate curve. + CurveData (Array[DVHPoint]): The points of the estimated DVH curve. + PlanSetup (PlanSetup): Parent plan. + PlanSetupId (str): ID of the parent plan. + Structure (Structure): Parent structure. + StructureId (str): ID of the parent structure. + TargetDoseLevel (DoseValue): Dose level of the associated target structure. + Type (DVHEstimateType): Type of DVH estimate curve. + """ + def __init__(self) -> None: ... + + CurveData: Array[DVHPoint] + + PlanSetup: PlanSetup + + PlanSetupId: str + + Structure: Structure + + StructureId: str + + TargetDoseLevel: DoseValue + + Type: DVHEstimateType + + CurveData: Array[DVHPoint] + + PlanSetup: PlanSetup + + PlanSetupId: str + + Structure: Structure + + StructureId: str + + TargetDoseLevel: DoseValue + + Type: DVHEstimateType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class EvaluationDose: + """ + Represents an evaluation dose that is connected to a plan that has no beams. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts the given dose value to the corresponding raw voxel value. + def DoseValueToVoxel(self, doseValue: DoseValue) -> int: + """ + Args: + doseValue: Dose value. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] For an evaluation dose (the dose of a plan that has no beams), sets the voxels of the given dose plane. Create the evaluation dose first using + def SetVoxels(self, planeIndex: int, values: Array[int]) -> None: + """ + Args: + planeIndex: Zero-based index of the plane. + values: The plane of voxel values. The size of the array must conform to the X-size and Y-size of the dose. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts the given dose value to the corresponding raw voxel value. + def DoseValueToVoxel(self, doseValue: DoseValue) -> int: + """ + Args: + doseValue: Dose value. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] For an evaluation dose (the dose of a plan that has no beams), sets the voxels of the given dose plane. Create the evaluation dose first using + def SetVoxels(self, planeIndex: int, values: Array[int]) -> None: + """ + Args: + planeIndex: Zero-based index of the plane. + values: The plane of voxel values. The size of the array must conform to the X-size and Y-size of the dose. + """ + ... + + + +class ExternalBeamTreatmentUnit: + """ + Represents a treatment machine used for delivering external beam radiotherapy. + + Attributes: + MachineDepartmentName (str): Default department associated with the machine. + MachineModel (str): The model of the treatment unit. + MachineModelName (str): The displayed name of the treatment unit model. + MachineScaleDisplayName (str): The name of the scale used in the treatment unit. + OperatingLimits (TreatmentUnitOperatingLimits): Information about operating limits for a set of treatment unit parameters. + SourceAxisDistance (float): The Source to Axis Distance (SAD). + MachineDepartmentName (str): Default department associated with the machine. + MachineModel (str): The model of the treatment unit. + MachineModelName (str): The displayed name of the treatment unit model. + MachineScaleDisplayName (str): The name of the scale used in the treatment unit. + OperatingLimits (TreatmentUnitOperatingLimits): Information about operating limits for a set of treatment unit parameters. + SourceAxisDistance (float): The Source to Axis Distance (SAD). + """ + def __init__(self) -> None: ... + + MachineDepartmentName: str + + MachineModel: str + + MachineModelName: str + + MachineScaleDisplayName: str + + OperatingLimits: TreatmentUnitOperatingLimits + + SourceAxisDistance: float + + MachineDepartmentName: str + + MachineModel: str + + MachineModelName: str + + MachineScaleDisplayName: str + + OperatingLimits: TreatmentUnitOperatingLimits + + SourceAxisDistance: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonBeam: + """ + Proton beam interface. + + Attributes: + AirGap (float): The user-defined air gap in mm. + BeamLineStatus (ProtonBeamLineStatus): Determine beamline's status + DistalTargetMargin (float): Distal end margin, in mm. + LateralMargins (VRect[float]): The lateral margins of this field, in mm. + LateralSpreadingDevices (List[LateralSpreadingDevice]): The lateral spreading devices in this beam. + NominalRange (float): The nominal range of the beam line, in mm. + NominalSOBPWidth (float): The nominal width of the Spread Out Bragg Peak, in mm. + OptionId (str): The identifier of the selected beam-line setting for proton beams. For a typical double scattering system, for example, an option is a combination of range modulator, second scatterer, and nominal energy that correspond to a broad proton beam with a certain range in patient and field size. Returns null if the option is undefined. + PatientSupportId (str): Patient support identifier. Returns null if undefined. + PatientSupportType (PatientSupportType): Patient support type. + IonControlPoints (IonControlPointCollection): Gets the proton control points. + ProximalTargetMargin (float): Proximal end margin, in mm. + RangeModulators (List[RangeModulator]): The range modulator devices in this beam. + RangeShifters (List[RangeShifter]): The range shifter devices in this beam. + ScanMode (IonBeamScanMode): The method of beam scanning to be used during treatment. + SnoutId (str): The Snout identifier. Returns null if undefined. + SnoutPosition (float): The snout position in cm. Returns System::Double::NaN if undefined. + TargetStructure (Structure): Returns the field target structure. Null if the field target is not defined (and axial margins are defined around the isocenter level). + VirtualSADX (float): Virtual Source-to-Axis Distance X, in mm. + VirtualSADY (float): Virtual Source-to-Axis Distance Y, in mm. + AirGap (float): The user-defined air gap in mm. + BeamLineStatus (ProtonBeamLineStatus): Determine beamline's status + DistalTargetMargin (float): Distal end margin, in mm. + LateralMargins (VRect[float]): The lateral margins of this field, in mm. + LateralSpreadingDevices (List[LateralSpreadingDevice]): The lateral spreading devices in this beam. + NominalRange (float): The nominal range of the beam line, in mm. + NominalSOBPWidth (float): The nominal width of the Spread Out Bragg Peak, in mm. + OptionId (str): The identifier of the selected beam-line setting for proton beams. For a typical double scattering system, for example, an option is a combination of range modulator, second scatterer, and nominal energy that correspond to a broad proton beam with a certain range in patient and field size. Returns null if the option is undefined. + PatientSupportId (str): Patient support identifier. Returns null if undefined. + PatientSupportType (PatientSupportType): Patient support type. + IonControlPoints (IonControlPointCollection): Gets the proton control points. + ProximalTargetMargin (float): Proximal end margin, in mm. + RangeModulators (List[RangeModulator]): The range modulator devices in this beam. + RangeShifters (List[RangeShifter]): The range shifter devices in this beam. + ScanMode (IonBeamScanMode): The method of beam scanning to be used during treatment. + SnoutId (str): The Snout identifier. Returns null if undefined. + SnoutPosition (float): The snout position in cm. Returns System::Double::NaN if undefined. + TargetStructure (Structure): Returns the field target structure. Null if the field target is not defined (and axial margins are defined around the isocenter level). + VirtualSADX (float): Virtual Source-to-Axis Distance X, in mm. + VirtualSADY (float): Virtual Source-to-Axis Distance Y, in mm. + """ + def __init__(self) -> None: ... + + AirGap: float + + BeamLineStatus: ProtonBeamLineStatus + + DistalTargetMargin: float + + LateralMargins: VRect[float] + + LateralSpreadingDevices: List[LateralSpreadingDevice] + + NominalRange: float + + NominalSOBPWidth: float + + OptionId: str + + PatientSupportId: str + + PatientSupportType: PatientSupportType + + IonControlPoints: IonControlPointCollection + + ProximalTargetMargin: float + + RangeModulators: List[RangeModulator] + + RangeShifters: List[RangeShifter] + + ScanMode: IonBeamScanMode + + SnoutId: str + + SnoutPosition: float + + TargetStructure: Structure + + VirtualSADX: float + + VirtualSADY: float + + AirGap: float + + BeamLineStatus: ProtonBeamLineStatus + + DistalTargetMargin: float + + LateralMargins: VRect[float] + + LateralSpreadingDevices: List[LateralSpreadingDevice] + + NominalRange: float + + NominalSOBPWidth: float + + OptionId: str + + PatientSupportId: str + + PatientSupportType: PatientSupportType + + IonControlPoints: IonControlPointCollection + + ProximalTargetMargin: float + + RangeModulators: List[RangeModulator] + + RangeShifters: List[RangeShifter] + + ScanMode: IonBeamScanMode + + SnoutId: str + + SnoutPosition: float + + TargetStructure: Structure + + VirtualSADX: float + + VirtualSADY: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Modifies the proton beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. DVH Estimations of the plan, if any, are cleared. + def ApplyParameters(self, beamParams: BeamParameters) -> None: + """ + Args: + beamParams: The parameters to apply to the beam. + """ + ... + + + # Returns a proton field deliverability status by room ID. Proton field deliverability status can be Deliverable, Undeliverable or NotCalculated. + def GetDeliveryTimeStatusByRoomId(self, roomId: str) -> ProtonDeliveryTimeStatus: + """ + Args: + roomId: Treatment room ID. + """ + ... + + + # Returns a new editable copy of the ion beam parameters. The returned IonBeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another IonBeamParameters object. + def GetEditableParameters(self) -> IonBeamParameters: + ... + + + # Returns a proton delivery time by room ID in seconds. Returns System::Double::NaN if delivery time status is Undeliverable or NotCalculated. + def GetProtonDeliveryTimeByRoomIdAsNumber(self, roomId: str) -> float: + """ + Args: + roomId: Treatment room ID. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Modifies the proton beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. DVH Estimations of the plan, if any, are cleared. + def ApplyParameters(self, beamParams: BeamParameters) -> None: + """ + Args: + beamParams: The parameters to apply to the beam. + """ + ... + + + # Returns a proton field deliverability status by room ID. Proton field deliverability status can be Deliverable, Undeliverable or NotCalculated. + def GetDeliveryTimeStatusByRoomId(self, roomId: str) -> ProtonDeliveryTimeStatus: + """ + Args: + roomId: Treatment room ID. + """ + ... + + + # Returns a new editable copy of the ion beam parameters. The returned IonBeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another IonBeamParameters object. + def GetEditableParameters(self) -> IonBeamParameters: + ... + + + # Returns a proton delivery time by room ID in seconds. Returns System::Double::NaN if delivery time status is Undeliverable or NotCalculated. + def GetProtonDeliveryTimeByRoomIdAsNumber(self, roomId: str) -> float: + """ + Args: + roomId: Treatment room ID. + """ + ... + + + +class IonControlPoint: + """ + Proton control point interface. + + Attributes: + FinalSpotList (IonSpotCollection): Gets a cached copy of the post-processed final spot list. + LateralSpreadingDeviceSettings (List[LateralSpreadingDeviceSettings]): The lateral spreading device settings. + NominalBeamEnergy (float): Nominal beam energy, in megavolts. + NumberOfPaintings (int): The number of times the scan pattern shall be applied at the current control point. + RangeModulatorSettings (List[RangeModulatorSettings]): The range modulator settings. + RangeShifterSettings (List[RangeShifterSettings]): The range shifter settings. + RawSpotList (IonSpotCollection): Gets a cached copy of the raw spot list. + ScanningSpotSizeX (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY X direction (mm). + ScanningSpotSizeY (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY Y direction (mm). + ScanSpotTuneId (str): User-supplied or machine code identifier for machine configuration to produce beam spot. This may be the nominal spot size or some other machine-specific value. Returns null if undefined. + SnoutPosition (float): The snout position, in mm. + FinalSpotList (IonSpotCollection): Gets a cached copy of the post-processed final spot list. + LateralSpreadingDeviceSettings (List[LateralSpreadingDeviceSettings]): The lateral spreading device settings. + NominalBeamEnergy (float): Nominal beam energy, in megavolts. + NumberOfPaintings (int): The number of times the scan pattern shall be applied at the current control point. + RangeModulatorSettings (List[RangeModulatorSettings]): The range modulator settings. + RangeShifterSettings (List[RangeShifterSettings]): The range shifter settings. + RawSpotList (IonSpotCollection): Gets a cached copy of the raw spot list. + ScanningSpotSizeX (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY X direction (mm). + ScanningSpotSizeY (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY Y direction (mm). + ScanSpotTuneId (str): User-supplied or machine code identifier for machine configuration to produce beam spot. This may be the nominal spot size or some other machine-specific value. Returns null if undefined. + SnoutPosition (float): The snout position, in mm. + """ + def __init__(self) -> None: ... + + FinalSpotList: IonSpotCollection + + LateralSpreadingDeviceSettings: List[LateralSpreadingDeviceSettings] + + NominalBeamEnergy: float + + NumberOfPaintings: int + + RangeModulatorSettings: List[RangeModulatorSettings] + + RangeShifterSettings: List[RangeShifterSettings] + + RawSpotList: IonSpotCollection + + ScanningSpotSizeX: float + + ScanningSpotSizeY: float + + ScanSpotTuneId: str + + SnoutPosition: float + + FinalSpotList: IonSpotCollection + + LateralSpreadingDeviceSettings: List[LateralSpreadingDeviceSettings] + + NominalBeamEnergy: float + + NumberOfPaintings: int + + RangeModulatorSettings: List[RangeModulatorSettings] + + RangeShifterSettings: List[RangeShifterSettings] + + RawSpotList: IonSpotCollection + + ScanningSpotSizeX: float + + ScanningSpotSizeY: float + + ScanSpotTuneId: str + + SnoutPosition: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonControlPointCollection: + """ + Represents a collection of machine parameters that describe the planned proton beam. + + Attributes: + Count (int): The number of control points in the collection. + Count (int): The number of control points in the collection. + """ + def __init__(self) -> None: ... + + Count: int + + Count: int + + # Retrieves enumerator for IonControlPoints in the collection. + def GetEnumerator(self) -> Iterable[IonControlPoint]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Retrieves enumerator for IonControlPoints in the collection. + def GetEnumerator(self) -> Iterable[IonControlPoint]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonControlPointPair: + """ + An editable copy of a control point pair (the pair of the start control point with an even index, and the end control point with an odd index). + + Attributes: + EndControlPoint (IonControlPointParameters): The end control point in the pair, with an odd index. + FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the editable post-processed final spot list. + NominalBeamEnergy (float): Nominal beam energy in megavolts. + RawSpotList (IonSpotParametersCollection): Gets a cached copy of the editable raw spot list + StartControlPoint (IonControlPointParameters): Start control point in the pair, with an even index from zero. + StartIndex (int): The index of the start control point in the pair. The index should be an even number starting from zero. + EndControlPoint (IonControlPointParameters): The end control point in the pair, with an odd index. + FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the editable post-processed final spot list. + NominalBeamEnergy (float): Nominal beam energy in megavolts. + RawSpotList (IonSpotParametersCollection): Gets a cached copy of the editable raw spot list + StartControlPoint (IonControlPointParameters): Start control point in the pair, with an even index from zero. + StartIndex (int): The index of the start control point in the pair. The index should be an even number starting from zero. + + Note: + To apply the parameters, call the + """ + def __init__(self) -> None: ... + + EndControlPoint: IonControlPointParameters + + FinalSpotList: IonSpotParametersCollection + + NominalBeamEnergy: float + + RawSpotList: IonSpotParametersCollection + + StartControlPoint: IonControlPointParameters + + StartIndex: int + + EndControlPoint: IonControlPointParameters + + FinalSpotList: IonSpotParametersCollection + + NominalBeamEnergy: float + + RawSpotList: IonSpotParametersCollection + + StartControlPoint: IonControlPointParameters + + StartIndex: int + + # Resizes the list of final spots. + def ResizeFinalSpotList(self, count: int) -> None: + """ + Args: + count: New length of the list. + """ + ... + + + # Resizes the list of raw spots. + def ResizeRawSpotList(self, count: int) -> None: + """ + Args: + count: New length of the list. + """ + ... + + + # Resizes the list of final spots. + def ResizeFinalSpotList(self, count: int) -> None: + """ + Args: + count: New length of the list. + """ + ... + + + # Resizes the list of raw spots. + def ResizeRawSpotList(self, count: int) -> None: + """ + Args: + count: New length of the list. + """ + ... + + + +class IonControlPointPairCollection: + """ + A collection of editable copies of control point pairs that describe the planned proton beam. + + Attributes: + Count (int): The number of control point pairs in the collection. + Count (int): The number of control point pairs in the collection. + + Note: + To apply the parameters, call the + """ + def __init__(self) -> None: ... + + Count: int + + Count: int + + # Retrieves enumerator for IonControlPointPairs in the collection. + def GetEnumerator(self) -> Iterable[IonControlPointPair]: + ... + + + # Retrieves enumerator for IonControlPointPairs in the collection. + def GetEnumerator(self) -> Iterable[IonControlPointPair]: + ... + + + +class IonControlPointParameters: + """ + An editable copy of the parameters of a proton control point. + + Attributes: + FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the post-processed final spot list. + RawSpotList (IonSpotParametersCollection): Gets a cached copy of the raw spot list. + SnoutPosition (float): Snout position in centimeters. + FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the post-processed final spot list. + RawSpotList (IonSpotParametersCollection): Gets a cached copy of the raw spot list. + SnoutPosition (float): Snout position in centimeters. + + Note: + To apply the parameters, call the ApplyParameters method of the Beam class. Because the parameters are simple copies, they do not reflect the current state of the data model. + """ + def __init__(self) -> None: ... + + FinalSpotList: IonSpotParametersCollection + + RawSpotList: IonSpotParametersCollection + + SnoutPosition: float + + FinalSpotList: IonSpotParametersCollection + + RawSpotList: IonSpotParametersCollection + + SnoutPosition: float + + +class IonSpot: + """ + The proton scanning spot interface that contains the 3D spot position and spot weight. + + Attributes: + Position (VVector): Read-only spot position in X, Y, and Z directions. + Weight (float): Read-only spot weight. + Position (VVector): Read-only spot position in X, Y, and Z directions. + Weight (float): Read-only spot weight. + """ + def __init__(self) -> None: ... + + Position: VVector + + Weight: float + + Position: VVector + + Weight: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonSpotCollection: + """ + Interface for the proton scanning spot list. + + Attributes: + Count (int): The number of scanning spots in this collection (spot list). + Count (int): The number of scanning spots in this collection (spot list). + """ + def __init__(self) -> None: ... + + Count: int + + Count: int + + # Retrieves enumerator for IonSpots in the collection. + def GetEnumerator(self) -> Iterable[IonSpot]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Retrieves enumerator for IonSpots in the collection. + def GetEnumerator(self) -> Iterable[IonSpot]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonSpotParameters: + """ + Interface for the proton scanning spot that contains the 3D spot position and spot weight. + + Attributes: + Weight (float): Editable spot weight. + X (float): Editable X position. + Y (float): Editable Y position. + Weight (float): Editable spot weight. + X (float): Editable X position. + Y (float): Editable Y position. + """ + def __init__(self) -> None: ... + + Weight: float + + X: float + + Y: float + + Weight: float + + X: float + + Y: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonSpotParametersCollection: + """ + Interface for the editable proton scanning spot list. + + Attributes: + Count (int): The number of editable scanning spots in this collection (spot list). + Count (int): The number of editable scanning spots in this collection (spot list). + """ + def __init__(self) -> None: ... + + Count: int + + Count: int + + # Retrieves enumerator for IonSpotParameterss in the collection. + def GetEnumerator(self) -> Iterable[IonSpotParameters]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Retrieves enumerator for IonSpotParameterss in the collection. + def GetEnumerator(self) -> Iterable[IonSpotParameters]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class LateralSpreadingDevice: + """ + The lateral spreading device. + + Attributes: + Type (LateralSpreadingDeviceType): The type of the device. + Type (LateralSpreadingDeviceType): The type of the device. + """ + def __init__(self) -> None: ... + + Type: LateralSpreadingDeviceType + + Type: LateralSpreadingDeviceType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class LateralSpreadingDeviceSettings: + """ + Settings for the lateral spreading device. + + Attributes: + IsocenterToLateralSpreadingDeviceDistance (float): Distance from the isocenter to the downstream edge of the lateral spreading device (mm) at the current control point. + LateralSpreadingDeviceSetting (str): Machine-specific setting. + LateralSpreadingDeviceWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the lateral spreading device at the central axis for the beam energy incident upon the device. + ReferencedLateralSpreadingDevice (LateralSpreadingDevice): The referenced lateral spreading device. + IsocenterToLateralSpreadingDeviceDistance (float): Distance from the isocenter to the downstream edge of the lateral spreading device (mm) at the current control point. + LateralSpreadingDeviceSetting (str): Machine-specific setting. + LateralSpreadingDeviceWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the lateral spreading device at the central axis for the beam energy incident upon the device. + ReferencedLateralSpreadingDevice (LateralSpreadingDevice): The referenced lateral spreading device. + """ + def __init__(self) -> None: ... + + IsocenterToLateralSpreadingDeviceDistance: float + + LateralSpreadingDeviceSetting: str + + LateralSpreadingDeviceWaterEquivalentThickness: float + + ReferencedLateralSpreadingDevice: LateralSpreadingDevice + + IsocenterToLateralSpreadingDeviceDistance: float + + LateralSpreadingDeviceSetting: str + + LateralSpreadingDeviceWaterEquivalentThickness: float + + ReferencedLateralSpreadingDevice: LateralSpreadingDevice + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationEUDObjective: + """ + A gEUD objective is an exact, upper or lower objective. An exact gEUD objective defines an exact dose value that a target structure should receive. An upper gEUD objective defines the maximum dose value that a structure should receive. A lower gEUD objective defines the minimum dose value that a target structure should receive. Generalized Equivalent Uniform Dose (gEUD) is a uniform dose that, if delivered over the same number of fractions, yields the same radiobiological effect as the non-uniform dose distribution of interest. + + Attributes: + Dose (DoseValue): The dose value for the objective. + ParameterA (float): A tissue-specific parameter that illustrates the effect of the volume on the dose. + Dose (DoseValue): The dose value for the objective. + ParameterA (float): A tissue-specific parameter that illustrates the effect of the volume on the dose. + """ + def __init__(self) -> None: ... + + Dose: DoseValue + + ParameterA: float + + Dose: DoseValue + + ParameterA: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationExcludeStructureParameter: + """ + Structures that have this parameter are excluded from the optimization. + + Attributes: + Structure (Structure): The structure to be excluded. + Structure (Structure): The structure to be excluded. + """ + def __init__(self) -> None: ... + + Structure: Structure + + Structure: Structure + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationIMRTBeamParameter: + """ + Beam-specific optimization parameter for IMRT optimization. + + Attributes: + Beam (Beam): The beam to which this parameter belongs. + BeamId (str): The identifier of the beam. + Excluded (bool): True if the beam is excluded from the optimization. + FixedJaws (bool): If true, the collimator jaw positions of the beam remain the same during the optimization. + SmoothX (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. + SmoothY (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. + Beam (Beam): The beam to which this parameter belongs. + BeamId (str): The identifier of the beam. + Excluded (bool): True if the beam is excluded from the optimization. + FixedJaws (bool): If true, the collimator jaw positions of the beam remain the same during the optimization. + SmoothX (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. + SmoothY (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. + """ + def __init__(self) -> None: ... + + Beam: Beam + + BeamId: str + + Excluded: bool + + FixedJaws: bool + + SmoothX: float + + SmoothY: float + + Beam: Beam + + BeamId: str + + Excluded: bool + + FixedJaws: bool + + SmoothX: float + + SmoothY: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationJawTrackingUsedParameter: + """ + An optimization parameter for using jaw tracking in VMAT optimization. The parameter exists if OptimizationSetup.UseJawTracking has been set to true. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationLineObjective: + """ + A line objective is a collection of point objectives that have the same priority. It is used to limit the dose in a given structure. + + Attributes: + CurveData (Array[DVHPoint]): The points in the line objective. + CurveData (Array[DVHPoint]): The points in the line objective. + """ + def __init__(self) -> None: ... + + CurveData: Array[DVHPoint] + + CurveData: Array[DVHPoint] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationMeanDoseObjective: + """ + A mean objective defines the mean dose that should not be exceeded. The mean objective is used to decrease the dose that a structure receives. + + Attributes: + Dose (DoseValue): The dose value for the objective. + Dose (DoseValue): The dose value for the objective. + """ + def __init__(self) -> None: ... + + Dose: DoseValue + + Dose: DoseValue + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationNormalTissueParameter: + """ + An optimization parameter for the normal tissue objective. + + Attributes: + DistanceFromTargetBorderInMM (float): Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + EndDosePercentage (float): Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + FallOff (float): Determines the steepness of the normal tissue objective fall-off. The value is positive. + IsAutomatic (bool): Returns True if an automatic normal tissue objective (NTO) is used. The automatic NTO adapts to the patient anatomy and the optimization objectives, and automatically determines the dose fall-off criteria. When an automatic NTO is used, the other properties of this object, except Priority, are not used. + IsAutomaticSbrt (bool): Returns True if an automatic SBRT normal tissue objective (NTO) is used. When an automatic SBRT NTO is used, the other properties of this object, except Priority, are not used. + IsAutomaticSrs (bool): Returns True if an automatic SRS normal tissue objective (NTO) is used. When an automatic SRS NTO is used, the other properties of this object, except Priority, are not used. + Priority (float): Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + StartDosePercentage (float): Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + DistanceFromTargetBorderInMM (float): Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + EndDosePercentage (float): Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + FallOff (float): Determines the steepness of the normal tissue objective fall-off. The value is positive. + IsAutomatic (bool): Returns True if an automatic normal tissue objective (NTO) is used. The automatic NTO adapts to the patient anatomy and the optimization objectives, and automatically determines the dose fall-off criteria. When an automatic NTO is used, the other properties of this object, except Priority, are not used. + IsAutomaticSbrt (bool): Returns True if an automatic SBRT normal tissue objective (NTO) is used. When an automatic SBRT NTO is used, the other properties of this object, except Priority, are not used. + IsAutomaticSrs (bool): Returns True if an automatic SRS normal tissue objective (NTO) is used. When an automatic SRS NTO is used, the other properties of this object, except Priority, are not used. + Priority (float): Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + StartDosePercentage (float): Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + """ + def __init__(self) -> None: ... + + DistanceFromTargetBorderInMM: float + + EndDosePercentage: float + + FallOff: float + + IsAutomatic: bool + + IsAutomaticSbrt: bool + + IsAutomaticSrs: bool + + Priority: float + + StartDosePercentage: float + + DistanceFromTargetBorderInMM: float + + EndDosePercentage: float + + FallOff: float + + IsAutomatic: bool + + IsAutomaticSbrt: bool + + IsAutomaticSrs: bool + + Priority: float + + StartDosePercentage: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationObjective: + """ + Provides a common base type for all structure-specific optimization objectives. + + Attributes: + Operator (OptimizationObjectiveOperator): Specifies the type of the objective (upper, lower, exact). + Priority (float): The priority of the objective as a positive double. + Structure (Structure): The structure to which this optimization objective belongs. + StructureId (str): The identifier of the structure. + Operator (OptimizationObjectiveOperator): Specifies the type of the objective (upper, lower, exact). + Priority (float): The priority of the objective as a positive double. + Structure (Structure): The structure to which this optimization objective belongs. + StructureId (str): The identifier of the structure. + """ + def __init__(self) -> None: ... + + Operator: OptimizationObjectiveOperator + + Priority: float + + Structure: Structure + + StructureId: str + + Operator: OptimizationObjectiveOperator + + Priority: float + + Structure: Structure + + StructureId: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Determines whether the specified object is equal to the current object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: The object to compare with the current object. + """ + ... + + + # Serves as a hash function for a particular type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Determines whether the specified object is equal to the current object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: The object to compare with the current object. + """ + ... + + + # Serves as a hash function for a particular type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + +class OptimizationParameter: + """ + Provides a common base type for all optimization parameters. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Determines whether the specified object is equal to the current object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: The object to compare with the current object. + """ + ... + + + # Serves as a hash function for a particular type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Determines whether the specified object is equal to the current object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: The object to compare with the current object. + """ + ... + + + # Serves as a hash function for a particular type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + +class OptimizationPointCloudParameter: + """ + Structure-specific parameter for point cloud optimization. Relevant if the optimization algorithm uses a point cloud. The point cloud parameters are automatically created with default values when you add other structure-specific parameters or objectives in the optimization setup. + + Attributes: + PointResolutionInMM (float): The point cloud resolution. + Structure (Structure): The structure whose parameters these are. + PointResolutionInMM (float): The point cloud resolution. + Structure (Structure): The structure whose parameters these are. + """ + def __init__(self) -> None: ... + + PointResolutionInMM: float + + Structure: Structure + + PointResolutionInMM: float + + Structure: Structure + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationPointObjective: + """ + A point objective is either an upper or lower objective. An upper objective is used to limit the dose in a given structure. A lower objective is used to define the desired dose levels in target structures. + + Attributes: + Dose (DoseValue): The dose value for the objective. + Volume (float): Percentage of the structure volume (0-100 %) to receive the dose. + Dose (DoseValue): The dose value for the objective. + Volume (float): Percentage of the structure volume (0-100 %) to receive the dose. + """ + def __init__(self) -> None: ... + + Dose: DoseValue + + Volume: float + + Dose: DoseValue + + Volume: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationVMATAvoidanceSectors: + """ + Beam-specific optimization parameter for VMAT Avoidance sectors. + + Attributes: + AvoidanceSector1 (OptimizationAvoidanceSector): Avoidance Sector 1. + AvoidanceSector2 (OptimizationAvoidanceSector): Avoidance Sector 2. + Beam (Beam): The beam to which this parameter belongs. + IsValid (bool): Is Avoidance Sectors valid. + ValidationError (str): Validation error if any. + AvoidanceSector1 (OptimizationAvoidanceSector): Avoidance Sector 1. + AvoidanceSector2 (OptimizationAvoidanceSector): Avoidance Sector 2. + Beam (Beam): The beam to which this parameter belongs. + IsValid (bool): Is Avoidance Sectors valid. + ValidationError (str): Validation error if any. + """ + def __init__(self) -> None: ... + + AvoidanceSector1: OptimizationAvoidanceSector + + AvoidanceSector2: OptimizationAvoidanceSector + + Beam: Beam + + IsValid: bool + + ValidationError: str + + AvoidanceSector1: OptimizationAvoidanceSector + + AvoidanceSector2: OptimizationAvoidanceSector + + Beam: Beam + + IsValid: bool + + ValidationError: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PatientSupportDevice: + """ + Represents a proton patient support device. + + Attributes: + PatientSupportAccessoryCode (str): Patient support device accessory code. + PatientSupportDeviceType (str): Type of the patient support device. + PatientSupportAccessoryCode (str): Patient support device accessory code. + PatientSupportDeviceType (str): Type of the patient support device. + """ + def __init__(self) -> None: ... + + PatientSupportAccessoryCode: str + + PatientSupportDeviceType: str + + PatientSupportAccessoryCode: str + + PatientSupportDeviceType: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PlanningItemDose: + """ + Represents a dose that is connected to a plan setup or a plan sum. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PlanSumComponent: + """ + Represents a component plan of a plan sum. + + Attributes: + PlanSetupId (str): The unique identification of the plan within the course. + PlanSumOperation (PlanSumOperation): The summing operation (+ or -) that defines how the dose of a component plan contributes to the plan sum. + PlanWeight (float): The weight of a component plan included in the plan sum. + PlanSetupId (str): The unique identification of the plan within the course. + PlanSumOperation (PlanSumOperation): The summing operation (+ or -) that defines how the dose of a component plan contributes to the plan sum. + PlanWeight (float): The weight of a component plan included in the plan sum. + """ + def __init__(self) -> None: ... + + PlanSetupId: str + + PlanSumOperation: PlanSumOperation + + PlanWeight: float + + PlanSetupId: str + + PlanSumOperation: PlanSumOperation + + PlanWeight: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PlanTreatmentSession: + """ + Plan in the treatment session. + + Attributes: + PlanSetup (PlanSetup): Scheduled or treated plan. + Status (TreatmentSessionStatus): Plan status in the treatment session. + TreatmentSession (TreatmentSession): Treatment session. + PlanSetup (PlanSetup): Scheduled or treated plan. + Status (TreatmentSessionStatus): Plan status in the treatment session. + TreatmentSession (TreatmentSession): Treatment session. + """ + def __init__(self) -> None: ... + + PlanSetup: PlanSetup + + Status: TreatmentSessionStatus + + TreatmentSession: TreatmentSession + + PlanSetup: PlanSetup + + Status: TreatmentSessionStatus + + TreatmentSession: TreatmentSession + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PlanUncertainty: + """ + Provides access to Plan Uncertainty parameters. For more information, see Eclipse Photon and Electron Instructions for Use. + + Attributes: + BeamUncertainties (List[BeamUncertainty]): Collection of beam uncertainty doses. + CalibrationCurveError (float): The calibration curve error of the plan uncertainty in percentage. Returns 100 for 100%. NaN if not defined. + DisplayName (str): The display name of the plan variation, including the parameter values. + Dose (Dose): The dose of this plan variation. + IsocenterShift (VVector): The isocenter shift of the plan uncertainty. + UncertaintyType (PlanUncertaintyType): Type of uncertainty, which determines how and in what context the defined parameters are to be used. + BeamUncertainties (List[BeamUncertainty]): Collection of beam uncertainty doses. + CalibrationCurveError (float): The calibration curve error of the plan uncertainty in percentage. Returns 100 for 100%. NaN if not defined. + DisplayName (str): The display name of the plan variation, including the parameter values. + Dose (Dose): The dose of this plan variation. + IsocenterShift (VVector): The isocenter shift of the plan uncertainty. + UncertaintyType (PlanUncertaintyType): Type of uncertainty, which determines how and in what context the defined parameters are to be used. + """ + def __init__(self) -> None: ... + + BeamUncertainties: List[BeamUncertainty] + + CalibrationCurveError: float + + DisplayName: str + + Dose: Dose + + IsocenterShift: VVector + + UncertaintyType: PlanUncertaintyType + + BeamUncertainties: List[BeamUncertainty] + + CalibrationCurveError: float + + DisplayName: str + + Dose: Dose + + IsocenterShift: VVector + + UncertaintyType: PlanUncertaintyType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns cumulative Dose Volume Histogram (DVH) data for this uncertainty plan. + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """ + Args: + structure: Structure, for which the DVH data is requested. + dosePresentation: Requested dose presentation mode (absolute or relative). Note that only absolute dose is supported for PlanSums. + volumePresentation: Requested volume presentation mode. + binWidth: Requested width of the bin. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns cumulative Dose Volume Histogram (DVH) data for this uncertainty plan. + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """ + Args: + structure: Structure, for which the DVH data is requested. + dosePresentation: Requested dose presentation mode (absolute or relative). Note that only absolute dose is supported for PlanSums. + volumePresentation: Requested volume presentation mode. + binWidth: Requested width of the bin. + """ + ... + + + +class RadioactiveSource: + """ + Represents a radioactive source installed into a + + Attributes: + CalibrationDate (Optional[datetime]): The calibration date for the strength of this radioactive source. + NominalActivity (bool): Defines whether source decay is accounted for in treatment planning. If the value is true, the dose calculation uses the source at its calibration activity (nominal activity). If the value is false, the source strength is decayed to the treatment activity based on the treatment date of the plan where the source is used. + RadioactiveSourceModel (RadioactiveSourceModel): The brachytherapy radioactive source model associated with this radioactive source. + SerialNumber (str): The serial number of this radioactive source. + Strength (float): The source strength for the radioactive source on the calibration date in cGy cm^2/h. + CalibrationDate (Optional[datetime]): The calibration date for the strength of this radioactive source. + NominalActivity (bool): Defines whether source decay is accounted for in treatment planning. If the value is true, the dose calculation uses the source at its calibration activity (nominal activity). If the value is false, the source strength is decayed to the treatment activity based on the treatment date of the plan where the source is used. + RadioactiveSourceModel (RadioactiveSourceModel): The brachytherapy radioactive source model associated with this radioactive source. + SerialNumber (str): The serial number of this radioactive source. + Strength (float): The source strength for the radioactive source on the calibration date in cGy cm^2/h. + """ + def __init__(self) -> None: ... + + CalibrationDate: Optional[datetime] + + NominalActivity: bool + + RadioactiveSourceModel: RadioactiveSourceModel + + SerialNumber: str + + Strength: float + + CalibrationDate: Optional[datetime] + + NominalActivity: bool + + RadioactiveSourceModel: RadioactiveSourceModel + + SerialNumber: str + + Strength: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RadioactiveSourceModel: + """ + The radioactive source model represents the details of the radioactive source used in brachytherapy. It encapsulates the source isotope, dimensions, and dose calculation parameters. + + Attributes: + ActiveSize (VVector): The active size of the modeled radioactive source in x, y, and z dimensions in millimeters. x represents the source width, y represents the source height, and z the source length. + ActivityConversionFactor (float): The activity-kerma conversion factor is used for converting activity (in mCi) to air-kerma strength (in U = cGy cm^2 / h). The unit of the factor is [U / mCi]. + CalculationModel (str): The dose calculation type used with this source model. Possible values are "Point source" and "Linear source". + DoseRateConstant (float): A conversion factor from the air-kerma strength to the dose rate in tissue. The unit of the dose rate constant is cGy / (h U). + HalfLife (float): The half life of the isotope in seconds. + LiteratureReference (str): The reference to the scientific publications on which the source model is based. + Manufacturer (str): The manufacturer of the modeled radioactive source. + SourceType (str): The DICOM source type. Possible values are "Point", "Line", "Cylinder", and "Sphere". + Status (str): The status of this source model. The status can be either "Unapproved", "Commissioning", "Approved", or "Retired". + StatusDate (Optional[datetime]): The time when the status of the source model was set. + StatusUserName (str): The name of the user who last set the status of the source model. + ActiveSize (VVector): The active size of the modeled radioactive source in x, y, and z dimensions in millimeters. x represents the source width, y represents the source height, and z the source length. + ActivityConversionFactor (float): The activity-kerma conversion factor is used for converting activity (in mCi) to air-kerma strength (in U = cGy cm^2 / h). The unit of the factor is [U / mCi]. + CalculationModel (str): The dose calculation type used with this source model. Possible values are "Point source" and "Linear source". + DoseRateConstant (float): A conversion factor from the air-kerma strength to the dose rate in tissue. The unit of the dose rate constant is cGy / (h U). + HalfLife (float): The half life of the isotope in seconds. + LiteratureReference (str): The reference to the scientific publications on which the source model is based. + Manufacturer (str): The manufacturer of the modeled radioactive source. + SourceType (str): The DICOM source type. Possible values are "Point", "Line", "Cylinder", and "Sphere". + Status (str): The status of this source model. The status can be either "Unapproved", "Commissioning", "Approved", or "Retired". + StatusDate (Optional[datetime]): The time when the status of the source model was set. + StatusUserName (str): The name of the user who last set the status of the source model. + """ + def __init__(self) -> None: ... + + ActiveSize: VVector + + ActivityConversionFactor: float + + CalculationModel: str + + DoseRateConstant: float + + HalfLife: float + + LiteratureReference: str + + Manufacturer: str + + SourceType: str + + Status: str + + StatusDate: Optional[datetime] + + StatusUserName: str + + ActiveSize: VVector + + ActivityConversionFactor: float + + CalculationModel: str + + DoseRateConstant: float + + HalfLife: float + + LiteratureReference: str + + Manufacturer: str + + SourceType: str + + Status: str + + StatusDate: Optional[datetime] + + StatusUserName: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RangeModulator: + """ + The range modulator device. + + Attributes: + Type (RangeModulatorType): The type of the device. + Type (RangeModulatorType): The type of the device. + """ + def __init__(self) -> None: ... + + Type: RangeModulatorType + + Type: RangeModulatorType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RangeModulatorSettings: + """ + Range modulator settings. + + Attributes: + IsocenterToRangeModulatorDistance (float): Distance from the isocenter to the downstream edge of the range modulator (mm) at the current control point. + RangeModulatorGatingStartValue (float): Start position defines the range modulator position at which the beam is switched on. + RangeModulatorGatingStarWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Start Value. + RangeModulatorGatingStopValue (float): Stop position defines the range modulator position at which the beam is switched off. + RangeModulatorGatingStopWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Stop Value. + ReferencedRangeModulator (RangeModulator): The referenced range modulator. + IsocenterToRangeModulatorDistance (float): Distance from the isocenter to the downstream edge of the range modulator (mm) at the current control point. + RangeModulatorGatingStartValue (float): Start position defines the range modulator position at which the beam is switched on. + RangeModulatorGatingStarWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Start Value. + RangeModulatorGatingStopValue (float): Stop position defines the range modulator position at which the beam is switched off. + RangeModulatorGatingStopWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Stop Value. + ReferencedRangeModulator (RangeModulator): The referenced range modulator. + """ + def __init__(self) -> None: ... + + IsocenterToRangeModulatorDistance: float + + RangeModulatorGatingStartValue: float + + RangeModulatorGatingStarWaterEquivalentThickness: float + + RangeModulatorGatingStopValue: float + + RangeModulatorGatingStopWaterEquivalentThickness: float + + ReferencedRangeModulator: RangeModulator + + IsocenterToRangeModulatorDistance: float + + RangeModulatorGatingStartValue: float + + RangeModulatorGatingStarWaterEquivalentThickness: float + + RangeModulatorGatingStopValue: float + + RangeModulatorGatingStopWaterEquivalentThickness: float + + ReferencedRangeModulator: RangeModulator + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RangeShifter: + """ + The range shifter device. + + Attributes: + Type (RangeShifterType): The type of the device. + Type (RangeShifterType): The type of the device. + """ + def __init__(self) -> None: ... + + Type: RangeShifterType + + Type: RangeShifterType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RangeShifterSettings: + """ + Range shifter settings. + + Attributes: + IsocenterToRangeShifterDistance (float): Distance from the isocenter to the downstream edge of the range shifter (mm) at the current control point. + RangeShifterSetting (str): Machine-specific setting. + RangeShifterWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range shifter at the central axis for the beam energy incident upon the device. + ReferencedRangeShifter (RangeShifter): The referenced range shifter. + IsocenterToRangeShifterDistance (float): Distance from the isocenter to the downstream edge of the range shifter (mm) at the current control point. + RangeShifterSetting (str): Machine-specific setting. + RangeShifterWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range shifter at the central axis for the beam energy incident upon the device. + ReferencedRangeShifter (RangeShifter): The referenced range shifter. + """ + def __init__(self) -> None: ... + + IsocenterToRangeShifterDistance: float + + RangeShifterSetting: str + + RangeShifterWaterEquivalentThickness: float + + ReferencedRangeShifter: RangeShifter + + IsocenterToRangeShifterDistance: float + + RangeShifterSetting: str + + RangeShifterWaterEquivalentThickness: float + + ReferencedRangeShifter: RangeShifter + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RTPrescription: + """ + Represents a prescription. + + Attributes: + BolusFrequency (str): Bolus frequency (how often the bolus is present in the field). For example, daily. + BolusThickness (str): Thickness of the bolus to be used. + Energies (List[str]): The energies in the prescription. + EnergyModes (List[str]): The energy modes in the prescription. + Gating (str): Gating information. + LatestRevision (RTPrescription): Gets the latest revision of the current RT prescription. + Notes (str): Additional notes. + NumberOfFractions (Optional[int]): Number of fractions, optional. + OrgansAtRisk (List[RTPrescriptionOrganAtRisk]): Gets the organs at risk of the current RT prescription. + PhaseType (str): Type of the phase (primary/boost). + PredecessorPrescription (RTPrescription): Gets the previous version of the RT prescription if it exists. + RevisionNumber (int): Revision number of the prescription. + SimulationNeeded (Optional[bool]): Indicates if simulations need to be done before treatment planning. + Site (str): The treatment site in the prescription. + Status (str): Prescription status. + TargetConstraintsWithoutTargetLevel (List[RTPrescriptionTargetConstraints]): Coverage constraints for targets with no prescribed dose. + Targets (List[RTPrescriptionTarget]): Gets the targets of the current prescription. + Technique (str): Treatment technique to be used. + BolusFrequency (str): Bolus frequency (how often the bolus is present in the field). For example, daily. + BolusThickness (str): Thickness of the bolus to be used. + Energies (List[str]): The energies in the prescription. + EnergyModes (List[str]): The energy modes in the prescription. + Gating (str): Gating information. + LatestRevision (RTPrescription): Gets the latest revision of the current RT prescription. + Notes (str): Additional notes. + NumberOfFractions (Optional[int]): Number of fractions, optional. + OrgansAtRisk (List[RTPrescriptionOrganAtRisk]): Gets the organs at risk of the current RT prescription. + PhaseType (str): Type of the phase (primary/boost). + PredecessorPrescription (RTPrescription): Gets the previous version of the RT prescription if it exists. + RevisionNumber (int): Revision number of the prescription. + SimulationNeeded (Optional[bool]): Indicates if simulations need to be done before treatment planning. + Site (str): The treatment site in the prescription. + Status (str): Prescription status. + TargetConstraintsWithoutTargetLevel (List[RTPrescriptionTargetConstraints]): Coverage constraints for targets with no prescribed dose. + Targets (List[RTPrescriptionTarget]): Gets the targets of the current prescription. + Technique (str): Treatment technique to be used. + """ + def __init__(self) -> None: ... + + BolusFrequency: str + + BolusThickness: str + + Energies: List[str] + + EnergyModes: List[str] + + Gating: str + + LatestRevision: RTPrescription + + Notes: str + + NumberOfFractions: Optional[int] + + OrgansAtRisk: List[RTPrescriptionOrganAtRisk] + + PhaseType: str + + PredecessorPrescription: RTPrescription + + RevisionNumber: int + + SimulationNeeded: Optional[bool] + + Site: str + + Status: str + + TargetConstraintsWithoutTargetLevel: List[RTPrescriptionTargetConstraints] + + Targets: List[RTPrescriptionTarget] + + Technique: str + + BolusFrequency: str + + BolusThickness: str + + Energies: List[str] + + EnergyModes: List[str] + + Gating: str + + LatestRevision: RTPrescription + + Notes: str + + NumberOfFractions: Optional[int] + + OrgansAtRisk: List[RTPrescriptionOrganAtRisk] + + PhaseType: str + + PredecessorPrescription: RTPrescription + + RevisionNumber: int + + SimulationNeeded: Optional[bool] + + Site: str + + Status: str + + TargetConstraintsWithoutTargetLevel: List[RTPrescriptionTargetConstraints] + + Targets: List[RTPrescriptionTarget] + + Technique: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RTPrescriptionConstraint: + """ + Represents a coverage constraint for an RT prescription. + + Attributes: + ConstraintType (RTPrescriptionConstraintType): Type of the constraint. + Unit1 (str): Gy, %, or null + Unit2 (str): Gy, %, or null + Value1 (str): First numerical (or free text) part of the constraint. + Value2 (str): Second numerical (or free text) part of the constraint. + ConstraintType (RTPrescriptionConstraintType): Type of the constraint. + Unit1 (str): Gy, %, or null + Unit2 (str): Gy, %, or null + Value1 (str): First numerical (or free text) part of the constraint. + Value2 (str): Second numerical (or free text) part of the constraint. + """ + def __init__(self) -> None: ... + + ConstraintType: RTPrescriptionConstraintType + + Unit1: str + + Unit2: str + + Value1: str + + Value2: str + + ConstraintType: RTPrescriptionConstraintType + + Unit1: str + + Unit2: str + + Value1: str + + Value2: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RTPrescriptionOrganAtRisk: + """ + Represents an organ at risk structure. + + Attributes: + Constraints (List[RTPrescriptionConstraint]): Constraints. + OrganAtRiskId (str): Structure identifier of the organ at risk. + Constraints (List[RTPrescriptionConstraint]): Constraints. + OrganAtRiskId (str): Structure identifier of the organ at risk. + """ + def __init__(self) -> None: ... + + Constraints: List[RTPrescriptionConstraint] + + OrganAtRiskId: str + + Constraints: List[RTPrescriptionConstraint] + + OrganAtRiskId: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RTPrescriptionTarget: + """ + Represents a prescription target. + + Attributes: + Constraints (List[RTPrescriptionConstraint]): Coverage constraints. + DosePerFraction (DoseValue): Dose per fraction for this target. + NumberOfFractions (int): The number of fractions in the prescription. + TargetId (str): The ID of the target volume. + Type (RTPrescriptionTargetType): Type of the prescription target. It can be Isocenter, IsodoseLine, Volume or Depth. + Value (float): Defined when the target type is IsodoseLine or Depth. Unit is % for IsodoseLine or mm for Depth. Not defined for other prescription types. + Constraints (List[RTPrescriptionConstraint]): Coverage constraints. + DosePerFraction (DoseValue): Dose per fraction for this target. + NumberOfFractions (int): The number of fractions in the prescription. + TargetId (str): The ID of the target volume. + Type (RTPrescriptionTargetType): Type of the prescription target. It can be Isocenter, IsodoseLine, Volume or Depth. + Value (float): Defined when the target type is IsodoseLine or Depth. Unit is % for IsodoseLine or mm for Depth. Not defined for other prescription types. + """ + def __init__(self) -> None: ... + + Constraints: List[RTPrescriptionConstraint] + + DosePerFraction: DoseValue + + NumberOfFractions: int + + TargetId: str + + Type: RTPrescriptionTargetType + + Value: float + + Constraints: List[RTPrescriptionConstraint] + + DosePerFraction: DoseValue + + NumberOfFractions: int + + TargetId: str + + Type: RTPrescriptionTargetType + + Value: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RTPrescriptionTargetConstraints: + """ + Represents target structure constraints. + + Attributes: + Constraints (List[RTPrescriptionConstraint]): Constraints. + TargetId (str): Identifier of the target structure. + Constraints (List[RTPrescriptionConstraint]): Constraints. + TargetId (str): Identifier of the target structure. + """ + def __init__(self) -> None: ... + + Constraints: List[RTPrescriptionConstraint] + + TargetId: str + + Constraints: List[RTPrescriptionConstraint] + + TargetId: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class SearchBodyParameters: + """ + Parameters for the Search Body feature. + + Attributes: + FillAllCavities (bool): Defines whether all cavities are filled. + KeepLargestParts (bool): Defines whether the largest part(s) of the Body structure are kept. + LowerHUThreshold (int): The lower threshold of the Hounsfield Unit value in the CT for the Search Body feature. + MREdgeThresholdHigh (int): Higher edge threshold for MR images. + MREdgeThresholdLow (int): Lower edge threshold for MR images. + NumberOfLargestPartsToKeep (int): The number of the largest parts in the Body structure that are kept. + PreCloseOpenings (bool): Defines whether to connect structure parts before extraction. + PreCloseOpeningsRadius (float): Radius setting for PreCloseOpenings. + PreDisconnect (bool): Defines whether to disconnect structure parts before extraction. + PreDisconnectRadius (float): Radius setting for PreDisconnect. + Smoothing (bool): Whether to do smoothing. + SmoothingLevel (int): Smoothing levels. + FillAllCavities (bool): Defines whether all cavities are filled. + KeepLargestParts (bool): Defines whether the largest part(s) of the Body structure are kept. + LowerHUThreshold (int): The lower threshold of the Hounsfield Unit value in the CT for the Search Body feature. + MREdgeThresholdHigh (int): Higher edge threshold for MR images. + MREdgeThresholdLow (int): Lower edge threshold for MR images. + NumberOfLargestPartsToKeep (int): The number of the largest parts in the Body structure that are kept. + PreCloseOpenings (bool): Defines whether to connect structure parts before extraction. + PreCloseOpeningsRadius (float): Radius setting for PreCloseOpenings. + PreDisconnect (bool): Defines whether to disconnect structure parts before extraction. + PreDisconnectRadius (float): Radius setting for PreDisconnect. + Smoothing (bool): Whether to do smoothing. + SmoothingLevel (int): Smoothing levels. + """ + def __init__(self) -> None: ... + + FillAllCavities: bool + + KeepLargestParts: bool + + LowerHUThreshold: int + + MREdgeThresholdHigh: int + + MREdgeThresholdLow: int + + NumberOfLargestPartsToKeep: int + + PreCloseOpenings: bool + + PreCloseOpeningsRadius: float + + PreDisconnect: bool + + PreDisconnectRadius: float + + Smoothing: bool + + SmoothingLevel: int + + FillAllCavities: bool + + KeepLargestParts: bool + + LowerHUThreshold: int + + MREdgeThresholdHigh: int + + MREdgeThresholdLow: int + + NumberOfLargestPartsToKeep: int + + PreCloseOpenings: bool + + PreCloseOpeningsRadius: float + + PreDisconnect: bool + + PreDisconnectRadius: float + + Smoothing: bool + + SmoothingLevel: int + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Loads the default values of the Search Body parameters. + def LoadDefaults(self) -> None: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Loads the default values of the Search Body parameters. + def LoadDefaults(self) -> None: + ... + + + +class SegmentVolume: + """ + The volumetric representation of a structure. This object is used when defining margins for structures, or when performing Boolean operations on structures. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to both this segment volume and another segment volume, that is, the intersection of this and the other segment volume. + def And(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this segment volume. + """ + ... + + + # Expands or shrinks this segment volume with the specified margins, aligned to the axes of the image coordinate system. + def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: + """ + Args: + margins: The margins in millimeters. The maximum is 50. + """ + ... + + + # Creates a new segment volume by expanding or shrinking this segment volume with the specified margin (in millimeters). A positive value creates an outer margin. A negative value creates an inner margin. + def Margin(self, marginInMM: float) -> SegmentVolume: + """ + Args: + marginInMM: The used margin in millimeters. The maximum is 50. + """ + ... + + + # Creates a combination of segment volumes. Does not modify this segment volume. The combination includes the area that covers everything else but this segment volume. + def Not(self) -> SegmentVolume: + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to this segment volume, to another segment volume, or both, that is, the union of this and the other segment volume. + def Or(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the area that belongs to this segment volume, but not to the other segment volume. + def Sub(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is subtracted from this segment volume. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong either to this segment volume or to another segment volume, but not to both of them. + def Xor(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to both this segment volume and another segment volume, that is, the intersection of this and the other segment volume. + def And(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this segment volume. + """ + ... + + + # Expands or shrinks this segment volume with the specified margins, aligned to the axes of the image coordinate system. + def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: + """ + Args: + margins: The margins in millimeters. The maximum is 50. + """ + ... + + + # Creates a new segment volume by expanding or shrinking this segment volume with the specified margin (in millimeters). A positive value creates an outer margin. A negative value creates an inner margin. + def Margin(self, marginInMM: float) -> SegmentVolume: + """ + Args: + marginInMM: The used margin in millimeters. The maximum is 50. + """ + ... + + + # Creates a combination of segment volumes. Does not modify this segment volume. The combination includes the area that covers everything else but this segment volume. + def Not(self) -> SegmentVolume: + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to this segment volume, to another segment volume, or both, that is, the union of this and the other segment volume. + def Or(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the area that belongs to this segment volume, but not to the other segment volume. + def Sub(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is subtracted from this segment volume. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong either to this segment volume or to another segment volume, but not to both of them. + def Xor(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + +class StandardWedge: + """ + A standard wedge is a physical piece of material with an angle that is static during treatment. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class BeamCalculationLog: + """ + Represents a beam calculation log. + + Attributes: + Beam (Beam): Used for navigating to parent Beam + Category (str): The log category, for example, "Dose", or "Optimization". + MessageLines (List[str]): The log as an array of lines. + Beam (Beam): Used for navigating to parent Beam + Category (str): The log category, for example, "Dose", or "Optimization". + MessageLines (List[str]): The log as an array of lines. + """ + def __init__(self) -> None: ... + + Beam: Beam + + Category: str + + MessageLines: List[str] + + Beam: Beam + + Category: str + + MessageLines: List[str] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Block: + """ + Represents a block add-on, a custom-made beam collimating material fixed to a tray, used to shape the beam. + + Attributes: + AddOnMaterial (AddOnMaterial): The dosimetric material of the block. + IsDiverging (bool): Checks if the block cut is diverging. + Outline (Array[Array[Windows.Point]]): The block outline points in field coordinates. + TransmissionFactor (float): The transmission factor of the selected material. + Tray (Tray): The tray on which the block is installed. + TrayTransmissionFactor (float): The transmission factor of the selected tray. + Type (BlockType): The type of the block: shielding or aperture. + AddOnMaterial (AddOnMaterial): The dosimetric material of the block. + IsDiverging (bool): Checks if the block cut is diverging. + Outline (Array[Array[Windows.Point]]): The block outline points in field coordinates. + TransmissionFactor (float): The transmission factor of the selected material. + Tray (Tray): The tray on which the block is installed. + TrayTransmissionFactor (float): The transmission factor of the selected tray. + Type (BlockType): The type of the block: shielding or aperture. + """ + def __init__(self) -> None: ... + + AddOnMaterial: AddOnMaterial + + IsDiverging: bool + + Outline: Array[Array[Windows.Point]] + + TransmissionFactor: float + + Tray: Tray + + TrayTransmissionFactor: float + + Type: BlockType + + AddOnMaterial: AddOnMaterial + + IsDiverging: bool + + Outline: Array[Array[Windows.Point]] + + TransmissionFactor: float + + Tray: Tray + + TrayTransmissionFactor: float + + Type: BlockType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Bolus: + """ + Represents a bolus, which is custom-made material that is usually fixed to the patient's skin for treatment. The bolus is used to modulate the depth dose profile of a beam. + + Attributes: + Id (str): The identifier of the bolus. + MaterialCTValue (float): The CT value of the bolus material (HU). + Name (str): The name of the bolus. + Id (str): The identifier of the bolus. + MaterialCTValue (float): The CT value of the bolus material (HU). + Name (str): The name of the bolus. + """ + def __init__(self) -> None: ... + + Id: str + + MaterialCTValue: float + + Name: str + + Id: str + + MaterialCTValue: float + + Name: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Compensator: + """ + Represents a beam compensator add-on, a custom-made beam modulating material fixed to a tray, used to modulate the beam's intensity. + + Attributes: + Material (AddOnMaterial): The dosimetric material used in the compensator. + Slot (Slot): The slot into which the tray is inserted. + Tray (Tray): The tray to which the compensator is connected. + Material (AddOnMaterial): The dosimetric material used in the compensator. + Slot (Slot): The slot into which the tray is inserted. + Tray (Tray): The tray to which the compensator is connected. + """ + def __init__(self) -> None: ... + + Material: AddOnMaterial + + Slot: Slot + + Tray: Tray + + Material: AddOnMaterial + + Slot: Slot + + Tray: Tray + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ControlPoint: + """ + Represents a point in a planned sequence of treatment beam parameters. See the definition of control points in a DICOM RT Beam. + + Attributes: + Beam (Beam): Used for navigating to parent beam + CollimatorAngle (float): The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + GantryAngle (float): The gantry angle of the radiation source. In other words, the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. + JawPositions (VRect[float]): The positions of the beam collimator jaws (in mm) in the IEC BEAM LIMITING DEVICE coordinates. + LeafPositions (Array[float]): The positions of the beam collimator leaf pairs (in mm) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If there is no MLC, a (0,0)-length array is returned. + MetersetWeight (float): The cumulative meterset weight to this control point. The cumulative meterset weight for the first item in a control point sequence is zero. + PatientSupportAngle (float): The patient support angle. In other words, the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. + Beam (Beam): Used for navigating to parent beam + CollimatorAngle (float): The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + GantryAngle (float): The gantry angle of the radiation source. In other words, the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. + JawPositions (VRect[float]): The positions of the beam collimator jaws (in mm) in the IEC BEAM LIMITING DEVICE coordinates. + LeafPositions (Array[float]): The positions of the beam collimator leaf pairs (in mm) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If there is no MLC, a (0,0)-length array is returned. + MetersetWeight (float): The cumulative meterset weight to this control point. The cumulative meterset weight for the first item in a control point sequence is zero. + PatientSupportAngle (float): The patient support angle. In other words, the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. + + Note: + Control points are discussed in DICOM PS 3.3 C.8.8.14. All beams have at least two control points. Note that some values may be NaN if they are not applicable to the treatment plan in question. + """ + def __init__(self) -> None: ... + + Beam: Beam + + CollimatorAngle: float + + GantryAngle: float + + Index: int + + JawPositions: VRect[float] + + LeafPositions: Array[float] + + MetersetWeight: float + + PatientSupportAngle: float + + TableTopLateralPosition: float + + TableTopLongitudinalPosition: float + + TableTopVerticalPosition: float + + Beam: Beam + + CollimatorAngle: float + + GantryAngle: float + + Index: int + + JawPositions: VRect[float] + + LeafPositions: Array[float] + + MetersetWeight: float + + PatientSupportAngle: float + + TableTopLateralPosition: float + + TableTopLongitudinalPosition: float + + TableTopVerticalPosition: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ControlPointCollection: + """ + Represents a collection of machine parameters that describe the planned treatment beam. + + Attributes: + Count (int): The number of control points in the collection. + Count (int): The number of control points in the collection. + """ + def __init__(self) -> None: ... + + Count: int + + Count: int + + # Retrieves enumerator for ControlPoints in the collection. + def GetEnumerator(self) -> Iterable[ControlPoint]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Retrieves enumerator for ControlPoints in the collection. + def GetEnumerator(self) -> Iterable[ControlPoint]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ApiDataObject: + """ + The base class of objects in the Eclipse Scripting API. + + Attributes: + Id (str): The identifier of the object. + Name (str): The name of the object. + Comment (str): A comment about the object. + HistoryUserName (str): The identifier of the last user who modified this object. + HistoryUserDisplayName (str): The name of the last user who modified this object. + HistoryDateTime (datetime): The date when this object was last modified. + Id (str): The identifier of the object. + Name (str): The name of the object. + Comment (str): A comment about the object. + HistoryUserName (str): The identifier of the last user who modified this object. + HistoryUserDisplayName (str): The name of the last user who modified this object. + HistoryDateTime (datetime): The date when this object was last modified. + """ + def __init__(self) -> None: ... + + Id: str + + Name: str + + Comment: str + + HistoryUserName: str + + HistoryUserDisplayName: str + + HistoryDateTime: datetime + + Id: str + + Name: str + + Comment: str + + HistoryUserName: str + + HistoryUserDisplayName: str + + HistoryDateTime: datetime + + # Returns a string that represents the current object. + def ToString(self) -> str: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream to which the object is serialized. + """ + ... + + + # Determines whether the specified Object is equal to the current Object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: Object to compare with the current object + """ + ... + + + # Serves as a hash function for this type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: ApiDataObject, b: ApiDataObject) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: ApiDataObject, b: ApiDataObject) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPIClinicalModifyingMethodGuard(self, param1: str) -> Any: + ... + + + # Throws an exception if the caller tries to add more scripting objects of certain types than a preset maximum limit allows. + def EnforceObjectLimits(self, callerMemberName: str) -> Any: + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPINonClinicalModifyingMethodGuard(self, param1: str) -> Any: + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPIClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: + """ + Args: + dataObj: The data object that is modified. + explicitCallerName: The API member that calls. + callerMemberName: The member that calls. + """ + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPINonClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: + """ + Args: + dataObj: The data object that is modified. + explicitCallerName: The API member that calls. + callerMemberName: The member that calls. + """ + ... + + + # Returns a string that represents the current object. + def ToString(self) -> str: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream to which the object is serialized. + """ + ... + + + # Determines whether the specified Object is equal to the current Object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: Object to compare with the current object + """ + ... + + + # Serves as a hash function for this type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: ApiDataObject, b: ApiDataObject) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: ApiDataObject, b: ApiDataObject) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPIClinicalModifyingMethodGuard(self, param1: str) -> Any: + ... + + + # Throws an exception if the caller tries to add more scripting objects of certain types than a preset maximum limit allows. + def EnforceObjectLimits(self, callerMemberName: str) -> Any: + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPINonClinicalModifyingMethodGuard(self, param1: str) -> Any: + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPIClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: + """ + Args: + dataObj: The data object that is modified. + explicitCallerName: The API member that calls. + callerMemberName: The member that calls. + """ + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPINonClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: + """ + Args: + dataObj: The data object that is modified. + explicitCallerName: The API member that calls. + callerMemberName: The member that calls. + """ + ... + + + +class Application: + """ + The main application interface. + + Attributes: + CurrentUser (User): The user who is currently logged on. + PatientSummaries (List[PatientSummary]): Fetches patient summaries from the database. + Calculation (Calculation): Calculation related functions + StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. + Equipment (Equipment): Provides access to clinical devices and accessories. + ScriptEnvironment (ScriptEnvironment): Gets the script environment. + CurrentUser (User): The user who is currently logged on. + PatientSummaries (List[PatientSummary]): Fetches patient summaries from the database. + Calculation (Calculation): Calculation related functions + StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. + Equipment (Equipment): Provides access to clinical devices and accessories. + ScriptEnvironment (ScriptEnvironment): Gets the script environment. + """ + def __init__(self) -> None: ... + + CurrentUser: User + + PatientSummaries: List[PatientSummary] + + Calculation: Calculation + + StructureCodes: ActiveStructureCodeDictionaries + + Equipment: Equipment + + ScriptEnvironment: ScriptEnvironment + + CurrentUser: User + + PatientSummaries: List[PatientSummary] + + Calculation: Calculation + + StructureCodes: ActiveStructureCodeDictionaries + + Equipment: Equipment + + ScriptEnvironment: ScriptEnvironment + + # Releases all unmanaged resources of this object. + def Dispose(self) -> None: + ... + + + # Called only if user forgot to call Dispose() + def Finalize(self) -> Any: + ... + + + # Creates an application instance and logs into the system. + def CreateApplication(self, username: str, password: str) -> Application: + """ + Args: + username: Username for logging in or null value to invoke an interactive login dialog. + password: Password for logging in or null value to invoke an interactive login dialog. + """ + ... + + + # Creates an application instance for a standalone script and logs into the system. + def CreateApplication(self) -> Application: + ... + + + # Opens a patient. + def OpenPatient(self, patientSummary: PatientSummary) -> Patient: + """ + Args: + patientSummary: Patient summary. + """ + ... + + + # Opens a patient by using a patient identifier. + def OpenPatientById(self, id: str) -> Patient: + """ + Args: + id: Patient ID + """ + ... + + + # Closes the current patient. If the script tries to access the data of a closed patient, an access violation exception occurs. + def ClosePatient(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Saves data modifications to the database if saving is allowed. Note: Calling this method can cause a multi-user warning dialog box to appear if the same patient is modified by other parties. + def SaveModifications(self) -> None: + ... + + + # Add HIPAA log record if HIPAA is enabled + def LogExportToHipaa(self, patientId: str) -> Any: + ... + + + # CTRL+BREAK handler, stops script execution + def ConsoleEventHandler(self, eventCode: ConsoleHandlerEventCode) -> Any: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Releases all unmanaged resources of this object. + def Dispose(self) -> None: + ... + + + # Called only if user forgot to call Dispose() + def Finalize(self) -> Any: + ... + + + # Creates an application instance and logs into the system. + def CreateApplication(self, username: str, password: str) -> Application: + """ + Args: + username: Username for logging in or null value to invoke an interactive login dialog. + password: Password for logging in or null value to invoke an interactive login dialog. + """ + ... + + + # Creates an application instance for a standalone script and logs into the system. + def CreateApplication(self) -> Application: + ... + + + # Opens a patient. + def OpenPatient(self, patientSummary: PatientSummary) -> Patient: + """ + Args: + patientSummary: Patient summary. + """ + ... + + + # Opens a patient by using a patient identifier. + def OpenPatientById(self, id: str) -> Patient: + """ + Args: + id: Patient ID + """ + ... + + + # Closes the current patient. If the script tries to access the data of a closed patient, an access violation exception occurs. + def ClosePatient(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Saves data modifications to the database if saving is allowed. Note: Calling this method can cause a multi-user warning dialog box to appear if the same patient is modified by other parties. + def SaveModifications(self) -> None: + ... + + + # Add HIPAA log record if HIPAA is enabled + def LogExportToHipaa(self, patientId: str) -> Any: + ... + + + # CTRL+BREAK handler, stops script execution + def ConsoleEventHandler(self, eventCode: ConsoleHandlerEventCode) -> Any: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Globals: + """ + This class is internal to the Eclipse Scripting API. + + Attributes: + AbortNow (bool): The flag that aborts script execution the next time any property or method of the Eclipse Scripting API is accessed. + DefaultMaximumNumberOfLoggedApiCalls (int): The default maximum number of API calls that are saved in the script execution log. + AbortNow (bool): The flag that aborts script execution the next time any property or method of the Eclipse Scripting API is accessed. + DefaultMaximumNumberOfLoggedApiCalls (int): The default maximum number of API calls that are saved in the script execution log. + """ + # Constructor + @overload + def __init__(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: + ... + + + # Constructor + @overload + def __init__(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: + ... + + + AbortNow: bool + + DefaultMaximumNumberOfLoggedApiCalls: int + + AbortNow: bool + + DefaultMaximumNumberOfLoggedApiCalls: int + + # Initialize custom log + def Initialize(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: + ... + + + # Checks if abort is needed and stops execution. + def CheckAbort(self) -> Any: + ... + + + # Uses System.Diagnostics.Trace with re-entrancy check for the Scripting API. + def Trace(self, message: str) -> Any: + ... + + + # Sets the maximum number of the API calls that are saved in the script execution log. This will clear the existing log entries. + def SetMaximumNumberOfLoggedApiCalls(self, apiLogCacheSize: int) -> None: + """ + Args: + apiLogCacheSize: The cache size for API call logs. Setting the value to zero disables logging. + """ + ... + + + # Returns the last called properties and methods. The oldest cached call is the first. The maximum number of logged calls is set by calling SetMaximumNumberOfLoggedApiCalls. + def GetLoggedApiCalls(self) -> List[str]: + ... + + + # Enables the getting of access information for API members through .NET trace listener. + def EnableApiAccessTrace(self) -> None: + ... + + + # Disables the getting of access information for API members through .NET trace listener. + def DisableApiAccessTrace(self) -> None: + ... + + + # Adds a log entry to custom script log file. + def AddCustomLogEntry(self, message: str, logSeverity: LogSeverity) -> None: + ... + + + # Initialize custom log + def Initialize(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: + ... + + + # Checks if abort is needed and stops execution. + def CheckAbort(self) -> Any: + ... + + + # Uses System.Diagnostics.Trace with re-entrancy check for the Scripting API. + def Trace(self, message: str) -> Any: + ... + + + # Sets the maximum number of the API calls that are saved in the script execution log. This will clear the existing log entries. + def SetMaximumNumberOfLoggedApiCalls(self, apiLogCacheSize: int) -> None: + """ + Args: + apiLogCacheSize: The cache size for API call logs. Setting the value to zero disables logging. + """ + ... + + + # Returns the last called properties and methods. The oldest cached call is the first. The maximum number of logged calls is set by calling SetMaximumNumberOfLoggedApiCalls. + def GetLoggedApiCalls(self) -> List[str]: + ... + + + # Enables the getting of access information for API members through .NET trace listener. + def EnableApiAccessTrace(self) -> None: + ... + + + # Disables the getting of access information for API members through .NET trace listener. + def DisableApiAccessTrace(self) -> None: + ... + + + # Adds a log entry to custom script log file. + def AddCustomLogEntry(self, message: str, logSeverity: LogSeverity) -> None: + ... + + + +class DVHData: + """ + Represents Dose Volume Histogram (DVH) data. + + Attributes: + Coverage (float): The dose coverage of the target, normalized to 0.0 .. 1.0. + CurveData (Array[DVHPoint]): The points of the Dose Volume Histogram (DVH) curve. + MaxDose (DoseValue): The maximum dose. + MaxDosePosition (VVector): The position of the maximum dose. + MeanDose (DoseValue): The mean dose. + MedianDose (DoseValue): The median dose. + MinDose (DoseValue): The minimum dose. + MinDosePosition (VVector): The position of the minimum dose. + SamplingCoverage (float): The sampling coverage. + StdDev (float): The standard deviation. + Volume (float): The volume of the structure in cubic centimeters. + Coverage (float): The dose coverage of the target, normalized to 0.0 .. 1.0. + CurveData (Array[DVHPoint]): The points of the Dose Volume Histogram (DVH) curve. + MaxDose (DoseValue): The maximum dose. + MaxDosePosition (VVector): The position of the maximum dose. + MeanDose (DoseValue): The mean dose. + MedianDose (DoseValue): The median dose. + MinDose (DoseValue): The minimum dose. + MinDosePosition (VVector): The position of the minimum dose. + SamplingCoverage (float): The sampling coverage. + StdDev (float): The standard deviation. + Volume (float): The volume of the structure in cubic centimeters. + """ + def __init__(self) -> None: ... + + Coverage: float + + CurveData: Array[DVHPoint] + + MaxDose: DoseValue + + MaxDosePosition: VVector + + MeanDose: DoseValue + + MedianDose: DoseValue + + MinDose: DoseValue + + MinDosePosition: VVector + + SamplingCoverage: float + + StdDev: float + + Volume: float + + Coverage: float + + CurveData: Array[DVHPoint] + + MaxDose: DoseValue + + MaxDosePosition: VVector + + MeanDose: DoseValue + + MedianDose: DoseValue + + MinDose: DoseValue + + MinDosePosition: VVector + + SamplingCoverage: float + + StdDev: float + + Volume: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class DynamicWedge: + """ + A Dynamic Wedge is formed by a moving jaw of a standard collimator during irradiation. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class EnhancedDynamicWedge: + """ + An Enhanced Dynamic Wedge is similar to a Dynamic Wedge, but it features more wedge angles than a simple Dynamic Wedge. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class FieldReferencePoint: + """ + This object links a treatment beam to a reference point. + + Attributes: + EffectiveDepth (float): The effective depth of the field reference point. For arc fields this is the average value over the span of the arc. + FieldDose (DoseValue): The field dose. + IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. + IsPrimaryReferencePoint (bool): Checks if the reference point is primary. + ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. + RefPointLocation (VVector): The location of the reference point. + SSD (float): The Source-to-Skin Distance (SSD) of the reference point. For arc fields this is the average value over the span of the arc. + EffectiveDepth (float): The effective depth of the field reference point. For arc fields this is the average value over the span of the arc. + FieldDose (DoseValue): The field dose. + IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. + IsPrimaryReferencePoint (bool): Checks if the reference point is primary. + ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. + RefPointLocation (VVector): The location of the reference point. + SSD (float): The Source-to-Skin Distance (SSD) of the reference point. For arc fields this is the average value over the span of the arc. + """ + def __init__(self) -> None: ... + + EffectiveDepth: float + + FieldDose: DoseValue + + IsFieldDoseNominal: bool + + IsPrimaryReferencePoint: bool + + ReferencePoint: ReferencePoint + + RefPointLocation: VVector + + SSD: float + + EffectiveDepth: float + + FieldDose: DoseValue + + IsFieldDoseNominal: bool + + IsPrimaryReferencePoint: bool + + ReferencePoint: ReferencePoint + + RefPointLocation: VVector + + SSD: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Hospital: + """ + Represents a hospital. + + Attributes: + CreationDateTime (Optional[datetime]): The date when this object was created. + Location (str): The location of the hospital. + CreationDateTime (Optional[datetime]): The date when this object was created. + Location (str): The location of the hospital. + """ + def __init__(self) -> None: ... + + CreationDateTime: Optional[datetime] + + Location: str + + CreationDateTime: Optional[datetime] + + Location: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ScriptContext: + """ + Contains the runtime context information of the active application for the script. + + Attributes: + CurrentUser (User): The current user of the application. + Course (Course): The course. The value may be null if the context has no course. + Image (Image): The 3D image. The value may be null if the context has no image. + StructureSet (StructureSet): The structure set. The value may be null if the context has no structure set. + Calculation (Calculation): Calculation related functions + StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. + Equipment (Equipment): Provides access to clinical devices and accessories. + Patient (Patient): The patient. The value may be null if the context has no patient. + PlanSetup (PlanSetup): The plan setup. The value may be null if the context has no plan setup. + ExternalPlanSetup (ExternalPlanSetup): The active external beam plan setup. The value is null if the active object is not an external beam plan setup. + BrachyPlanSetup (BrachyPlanSetup): The active brachytherapy plan setup. The value is null if the active object is not a brachytherapy plan setup. + IonPlanSetup (IonPlanSetup): The active proton plan setup. The value is null if the active object is not a proton plan setup. + PlansInScope (List[PlanSetup]): Retrieves a list of all plans in the Scope window. + ExternalPlansInScope (List[ExternalPlanSetup]): Retrieves a list of all external beam plans in the Scope window. + BrachyPlansInScope (List[BrachyPlanSetup]): Retrieves a list of all brachytherapy plans in the Scope window. + IonPlansInScope (List[IonPlanSetup]): Retrieves a list of all proton plans in the Scope window. + PlanSumsInScope (List[PlanSum]): Retrieves a list of all plan sums in the Scope window. + PlanSum (PlanSum): Retrieves the active plan sum. + ActiveStructure (Any): Retrieves the active structure. + ApplicationName (str): The name of the active application. + VersionInfo (str): The version number of Eclipse. + CurrentUser (User): The current user of the application. + Course (Course): The course. The value may be null if the context has no course. + Image (Image): The 3D image. The value may be null if the context has no image. + StructureSet (StructureSet): The structure set. The value may be null if the context has no structure set. + Calculation (Calculation): Calculation related functions + StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. + Equipment (Equipment): Provides access to clinical devices and accessories. + Patient (Patient): The patient. The value may be null if the context has no patient. + PlanSetup (PlanSetup): The plan setup. The value may be null if the context has no plan setup. + ExternalPlanSetup (ExternalPlanSetup): The active external beam plan setup. The value is null if the active object is not an external beam plan setup. + BrachyPlanSetup (BrachyPlanSetup): The active brachytherapy plan setup. The value is null if the active object is not a brachytherapy plan setup. + IonPlanSetup (IonPlanSetup): The active proton plan setup. The value is null if the active object is not a proton plan setup. + PlansInScope (List[PlanSetup]): Retrieves a list of all plans in the Scope window. + ExternalPlansInScope (List[ExternalPlanSetup]): Retrieves a list of all external beam plans in the Scope window. + BrachyPlansInScope (List[BrachyPlanSetup]): Retrieves a list of all brachytherapy plans in the Scope window. + IonPlansInScope (List[IonPlanSetup]): Retrieves a list of all proton plans in the Scope window. + PlanSumsInScope (List[PlanSum]): Retrieves a list of all plan sums in the Scope window. + PlanSum (PlanSum): Retrieves the active plan sum. + ActiveStructure (Any): Retrieves the active structure. + ApplicationName (str): The name of the active application. + VersionInfo (str): The version number of Eclipse. + """ + # Provides scripts an access to the current data context. A context instance is given as a parameter in the Execute function of the script. The script itself does not instantiate the context. + @overload + def __init__(self, context: Any, user: Any, dvhEstimation: Any, appName: str) -> None: + """ + Args: + context: The internal data context. + user: The internal user object. + dvhEstimation: The internal dvh estimation model library object. + appName: The application name. + """ + ... + + + # Provides scripts an access to the current data context. A context instance is given as a parameter in the Execute function of the script. The script itself does not instantiate the context. + @overload + def __init__(self, context: Any, user: Any, dvhEstimation: Any, appName: str) -> None: + """ + Args: + context: The internal data context. + user: The internal user object. + dvhEstimation: The internal dvh estimation model library object. + appName: The application name. + """ + ... + + + CurrentUser: User + + Course: Course + + Image: Image + + StructureSet: StructureSet + + Calculation: Calculation + + StructureCodes: ActiveStructureCodeDictionaries + + Equipment: Equipment + + Patient: Patient + + PlanSetup: PlanSetup + + ExternalPlanSetup: ExternalPlanSetup + + BrachyPlanSetup: BrachyPlanSetup + + IonPlanSetup: IonPlanSetup + + PlansInScope: List[PlanSetup] + + ExternalPlansInScope: List[ExternalPlanSetup] + + BrachyPlansInScope: List[BrachyPlanSetup] + + IonPlansInScope: List[IonPlanSetup] + + PlanSumsInScope: List[PlanSum] + + PlanSum: PlanSum + + ActiveStructure: Any + + ApplicationName: str + + VersionInfo: str + + CurrentUser: User + + Course: Course + + Image: Image + + StructureSet: StructureSet + + Calculation: Calculation + + StructureCodes: ActiveStructureCodeDictionaries + + Equipment: Equipment + + Patient: Patient + + PlanSetup: PlanSetup + + ExternalPlanSetup: ExternalPlanSetup + + BrachyPlanSetup: BrachyPlanSetup + + IonPlanSetup: IonPlanSetup + + PlansInScope: List[PlanSetup] + + ExternalPlansInScope: List[ExternalPlanSetup] + + BrachyPlansInScope: List[BrachyPlanSetup] + + IonPlansInScope: List[IonPlanSetup] + + PlanSumsInScope: List[PlanSum] + + PlanSum: PlanSum + + ActiveStructure: Any + + ApplicationName: str + + VersionInfo: str + + +class Isodose: + """ + Represents an isodose level for a fixed absolute or relative dose value. + + Attributes: + Color (Windows.Media.Color): The color of the isodose. + Level (DoseValue): The dose value of the isodose level. + MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The triangle mesh of the isodose. Returned for those isodose levels that are rendered in 3D in Eclipse. + Color (Windows.Media.Color): The color of the isodose. + Level (DoseValue): The dose value of the isodose level. + MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The triangle mesh of the isodose. Returned for those isodose levels that are rendered in 3D in Eclipse. + """ + def __init__(self) -> None: ... + + Color: Windows.Media.Color + + Level: DoseValue + + MeshGeometry: Windows.Media.Media3D.MeshGeometry3D + + Color: Windows.Media.Color + + Level: DoseValue + + MeshGeometry: Windows.Media.Media3D.MeshGeometry3D + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class MLC: + """ + Represents a Multileaf Collimator (MLC) add-on. + + Attributes: + ManufacturerName (str): The name of the manufacturer of the Multileaf Collimator (MLC). + MinDoseDynamicLeafGap (float): For dose-dynamic treatments, the minimum gap (mm) between moving, open leaf pairs that the Multileaf Collimator (MLC) hardware can handle. + Model (str): The number or name of the Multileaf Collimator (MLC) model. + SerialNumber (str): The serial number given to the Multileaf Collimator (MLC) by the factory. + ManufacturerName (str): The name of the manufacturer of the Multileaf Collimator (MLC). + MinDoseDynamicLeafGap (float): For dose-dynamic treatments, the minimum gap (mm) between moving, open leaf pairs that the Multileaf Collimator (MLC) hardware can handle. + Model (str): The number or name of the Multileaf Collimator (MLC) model. + SerialNumber (str): The serial number given to the Multileaf Collimator (MLC) by the factory. + """ + def __init__(self) -> None: ... + + ManufacturerName: str + + MinDoseDynamicLeafGap: float + + Model: str + + SerialNumber: str + + ManufacturerName: str + + MinDoseDynamicLeafGap: float + + Model: str + + SerialNumber: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class MotorizedWedge: + """ + A motorized wedge is a standard wedge placed in the beam for a user-defined fraction of the total treatment time. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OmniWedge: + """ + An OmniWedge is a special type of wedge that combines an open field, a motorized wedge, and a virtual wedge to create the desired wedge effect. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Patient: + """ + Represents a patient. + + Attributes: + Courses (List[Course]): A collection of the patient's courses. + CreationDateTime (Optional[datetime]): The date when this object was created. + DateOfBirth (Optional[datetime]): The date of birth of the patient. + DefaultDepartment (str): The default department name. + FirstName (str): The first name of the patient. + HasModifiedData (bool): Returns true if the patient object tree has been modified. + Hospital (Hospital): The hospital. + Id2 (str): The patient ID2. + LastName (str): The last name of the patient. + MiddleName (str): The middle name of the patient. + PrimaryOncologistId (str): The identifier of the primary oncologist. + PrimaryOncologistName (str): The primary oncologist name. + ReferencePoints (List[ReferencePoint]): Collection of all reference points for the patient. + Registrations (List[Registration]): A collection of registrations. + Sex (str): The gender of the patient. + SSN (str): The Social Security Account Number (SSN) of the patient. + StructureSets (List[StructureSet]): A collection of structure sets. + Studies (List[Study]): A collection of studies. + Courses (List[Course]): A collection of the patient's courses. + CreationDateTime (Optional[datetime]): The date when this object was created. + DateOfBirth (Optional[datetime]): The date of birth of the patient. + DefaultDepartment (str): The default department name. + FirstName (str): The first name of the patient. + HasModifiedData (bool): Returns true if the patient object tree has been modified. + Hospital (Hospital): The hospital. + Id2 (str): The patient ID2. + LastName (str): The last name of the patient. + MiddleName (str): The middle name of the patient. + PrimaryOncologistId (str): The identifier of the primary oncologist. + PrimaryOncologistName (str): The primary oncologist name. + ReferencePoints (List[ReferencePoint]): Collection of all reference points for the patient. + Registrations (List[Registration]): A collection of registrations. + Sex (str): The gender of the patient. + SSN (str): The Social Security Account Number (SSN) of the patient. + StructureSets (List[StructureSet]): A collection of structure sets. + Studies (List[Study]): A collection of studies. + """ + def __init__(self) -> None: ... + + Courses: List[Course] + + CreationDateTime: Optional[datetime] + + DateOfBirth: Optional[datetime] + + DefaultDepartment: str + + FirstName: str + + HasModifiedData: bool + + Hospital: Hospital + + Id2: str + + LastName: str + + MiddleName: str + + PrimaryOncologistId: str + + PrimaryOncologistName: str + + ReferencePoints: List[ReferencePoint] + + Registrations: List[Registration] + + Sex: str + + SSN: str + + StructureSets: List[StructureSet] + + Studies: List[Study] + + Courses: List[Course] + + CreationDateTime: Optional[datetime] + + DateOfBirth: Optional[datetime] + + DefaultDepartment: str + + FirstName: str + + HasModifiedData: bool + + Hospital: Hospital + + Id2: str + + LastName: str + + MiddleName: str + + PrimaryOncologistId: str + + PrimaryOncologistName: str + + ReferencePoints: List[ReferencePoint] + + Registrations: List[Registration] + + Sex: str + + SSN: str + + StructureSets: List[StructureSet] + + Studies: List[Study] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new course to this patient. + def AddCourse(self) -> Course: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds an empty phantom image to the patient. The empty image is created in a new study. A new structure set is created for the image. + def AddEmptyPhantom(self, imageId: str, orientation: PatientOrientation, xSizePixel: int, ySizePixel: int, widthMM: float, heightMM: float, nrOfPlanes: int, planeSepMM: float) -> StructureSet: + """ + Args: + imageId: The identifier for the empty image to be created. The value must not be empty. + orientation: The patient orientation in the image. + xSizePixel: The x size of the image in pixels. The expected value is from 23 to 2048 pixels. + ySizePixel: The y size of the image in pixels. The expected value is from 23 to 2048 pixels. + widthMM: The height of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. + heightMM: The width of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. + nrOfPlanes: The number of planes in the image. The expected value is from 1 to 10000. + planeSepMM: The distance between the planes in millimeters. The expected value is from 0.1 to 200.0 millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add reference point to a patient + def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: + """ + Args: + target: True if point being added is for target volume + id: Identifier for the new reference point + """ + ... + + + # Enables write-access to the data model from the Scripting API. This function must be called for each patient the script modifies. If this function is not called, the data in the database cannot be modified. + def BeginModifications(self) -> None: + ... + + + # Checks if a new course can be added to the patient. + def CanAddCourse(self) -> bool: + ... + + + # Checks if an empty phantom can be added to the patient. The user should have the appropriate permissions to perform the operation. + def CanAddEmptyPhantom(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If phantom adding is not permitted, contains the error message. + """ + ... + + + # Checks if the image can be copied from the other patient. + def CanCopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str, errorMessage: str) -> bool: + """ + Args: + targetStudy: The target study for the new image series, or null. + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + errorMessage: If copying the image is not permitted, contains the error message. + """ + ... + + + # Returns true if the script can modify patient data in the database. + def CanModifyData(self) -> bool: + ... + + + # Checks if the course can be removed from the patient. + def CanRemoveCourse(self, course: Course) -> bool: + """ + Args: + course: The course to be removed. + """ + ... + + + # Checks if the image can be removed. The image to be removed and the associated structure set should be empty. + def CanRemoveEmptyPhantom(self, structureset: StructureSet, errorMessage: str) -> bool: + """ + Args: + structureset: The structure set to be removed. + errorMessage: If the image and associated structure set cannot be removed, contains the error message. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to this patient. A new study and series is created for the image. The method + def CopyImageFromOtherPatient(self, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: + """ + Args: + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to the given study. A new series is created for the image. The method + def CopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: + """ + Args: + targetStudy: The target study for the new image series. + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the course from the patient and deletes it. + def RemoveCourse(self, course: Course) -> None: + """ + Args: + course: The course that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes an empty image from the patient. The associated structure set is also removed. The image to be removed and the associated structure set should be empty. + def RemoveEmptyPhantom(self, structureset: StructureSet) -> None: + """ + Args: + structureset: The structure set to be removed. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new course to this patient. + def AddCourse(self) -> Course: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds an empty phantom image to the patient. The empty image is created in a new study. A new structure set is created for the image. + def AddEmptyPhantom(self, imageId: str, orientation: PatientOrientation, xSizePixel: int, ySizePixel: int, widthMM: float, heightMM: float, nrOfPlanes: int, planeSepMM: float) -> StructureSet: + """ + Args: + imageId: The identifier for the empty image to be created. The value must not be empty. + orientation: The patient orientation in the image. + xSizePixel: The x size of the image in pixels. The expected value is from 23 to 2048 pixels. + ySizePixel: The y size of the image in pixels. The expected value is from 23 to 2048 pixels. + widthMM: The height of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. + heightMM: The width of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. + nrOfPlanes: The number of planes in the image. The expected value is from 1 to 10000. + planeSepMM: The distance between the planes in millimeters. The expected value is from 0.1 to 200.0 millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add reference point to a patient + def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: + """ + Args: + target: True if point being added is for target volume + id: Identifier for the new reference point + """ + ... + + + # Enables write-access to the data model from the Scripting API. This function must be called for each patient the script modifies. If this function is not called, the data in the database cannot be modified. + def BeginModifications(self) -> None: + ... + + + # Checks if a new course can be added to the patient. + def CanAddCourse(self) -> bool: + ... + + + # Checks if an empty phantom can be added to the patient. The user should have the appropriate permissions to perform the operation. + def CanAddEmptyPhantom(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If phantom adding is not permitted, contains the error message. + """ + ... + + + # Checks if the image can be copied from the other patient. + def CanCopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str, errorMessage: str) -> bool: + """ + Args: + targetStudy: The target study for the new image series, or null. + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + errorMessage: If copying the image is not permitted, contains the error message. + """ + ... + + + # Returns true if the script can modify patient data in the database. + def CanModifyData(self) -> bool: + ... + + + # Checks if the course can be removed from the patient. + def CanRemoveCourse(self, course: Course) -> bool: + """ + Args: + course: The course to be removed. + """ + ... + + + # Checks if the image can be removed. The image to be removed and the associated structure set should be empty. + def CanRemoveEmptyPhantom(self, structureset: StructureSet, errorMessage: str) -> bool: + """ + Args: + structureset: The structure set to be removed. + errorMessage: If the image and associated structure set cannot be removed, contains the error message. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to this patient. A new study and series is created for the image. The method + def CopyImageFromOtherPatient(self, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: + """ + Args: + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to the given study. A new series is created for the image. The method + def CopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: + """ + Args: + targetStudy: The target study for the new image series. + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the course from the patient and deletes it. + def RemoveCourse(self, course: Course) -> None: + """ + Args: + course: The course that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes an empty image from the patient. The associated structure set is also removed. The image to be removed and the associated structure set should be empty. + def RemoveEmptyPhantom(self, structureset: StructureSet) -> None: + """ + Args: + structureset: The structure set to be removed. + """ + ... + + + +class PatientSummary: + """ + Basic information about the patient. + + Attributes: + CreationDateTime (Optional[datetime]): The date when the patient object was created. + DateOfBirth (Optional[datetime]): The date of birth of the patient. + FirstName (str): The first name of the patient. + Id (str): The patient ID. + Id2 (str): The patient ID2. + LastName (str): The last name of the patient. + MiddleName (str): The middle name of the patient. + Sex (str): The gender of the patient. + SSN (str): The Social Security Account Number (SSN) of the patient. + CreationDateTime (Optional[datetime]): The date when the patient object was created. + DateOfBirth (Optional[datetime]): The date of birth of the patient. + FirstName (str): The first name of the patient. + Id (str): The patient ID. + Id2 (str): The patient ID2. + LastName (str): The last name of the patient. + MiddleName (str): The middle name of the patient. + Sex (str): The gender of the patient. + SSN (str): The Social Security Account Number (SSN) of the patient. + """ + def __init__(self) -> None: ... + + CreationDateTime: Optional[datetime] + + DateOfBirth: Optional[datetime] + + FirstName: str + + Id: str + + Id2: str + + LastName: str + + MiddleName: str + + Sex: str + + SSN: str + + CreationDateTime: Optional[datetime] + + DateOfBirth: Optional[datetime] + + FirstName: str + + Id: str + + Id2: str + + LastName: str + + MiddleName: str + + Sex: str + + SSN: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PlanningItem: + """ + Common properties of a treatment plan and a plan sum. + + Attributes: + Course (Course): Used for navigating to parent course. + CreationDateTime (Optional[datetime]): The date when this object was created. + Dose (PlanningItemDose): The total dose. The total dose is the dose of all planned fractions together. + DoseValuePresentation (DoseValuePresentation): The presentation of the dose as absolute or relative. + StructureSet (StructureSet): The structure set. + StructuresSelectedForDvh (List[Structure]): The collection of the structures that have been selected for DVH evaluation in Eclipse. + Course (Course): Used for navigating to parent course. + CreationDateTime (Optional[datetime]): The date when this object was created. + Dose (PlanningItemDose): The total dose. The total dose is the dose of all planned fractions together. + DoseValuePresentation (DoseValuePresentation): The presentation of the dose as absolute or relative. + StructureSet (StructureSet): The structure set. + StructuresSelectedForDvh (List[Structure]): The collection of the structures that have been selected for DVH evaluation in Eclipse. + """ + def __init__(self) -> None: ... + + Course: Course + + CreationDateTime: Optional[datetime] + + Dose: PlanningItemDose + + DoseValuePresentation: DoseValuePresentation + + StructureSet: StructureSet + + StructuresSelectedForDvh: List[Structure] + + Course: Course + + CreationDateTime: Optional[datetime] + + Dose: PlanningItemDose + + DoseValuePresentation: DoseValuePresentation + + StructureSet: StructureSet + + StructuresSelectedForDvh: List[Structure] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Get the list of clinical goals assigned to a planning item. + def GetClinicalGoals(self) -> List[ClinicalGoal]: + ... + + + # Returns cumulative Dose Volume Histogram (DVH) data. + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """ + Args: + structure: Structure for which the DVH data is requested. + dosePresentation: Requested dose presentation mode (absolute or relative). Note, that only absolute dose is supported for PlanSums. + volumePresentation: Requested volume presentation mode. + binWidth: Requested width of the bin. + """ + ... + + + # Gets the dose at a volume. + def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: + """ + Args: + structure: Structure for which the value is requested. + volume: Volume at which the dose is requested. + volumePresentation: Presentation mode of the volume parameter. + requestedDosePresentation: Requested dose presentation mode (absolute or relative). + """ + ... + + + # Gets the volume at the dose. + def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: + """ + Args: + structure: Structure for which the value is requested. + dose: Dose at which the volume is requested. + requestedVolumePresentation: Requested volume presentation mode. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Get the list of clinical goals assigned to a planning item. + def GetClinicalGoals(self) -> List[ClinicalGoal]: + ... + + + # Returns cumulative Dose Volume Histogram (DVH) data. + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """ + Args: + structure: Structure for which the DVH data is requested. + dosePresentation: Requested dose presentation mode (absolute or relative). Note, that only absolute dose is supported for PlanSums. + volumePresentation: Requested volume presentation mode. + binWidth: Requested width of the bin. + """ + ... + + + # Gets the dose at a volume. + def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: + """ + Args: + structure: Structure for which the value is requested. + volume: Volume at which the dose is requested. + volumePresentation: Presentation mode of the volume parameter. + requestedDosePresentation: Requested dose presentation mode (absolute or relative). + """ + ... + + + # Gets the volume at the dose. + def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: + """ + Args: + structure: Structure for which the value is requested. + dose: Dose at which the volume is requested. + requestedVolumePresentation: Requested volume presentation mode. + """ + ... + + + +class PlanSum: + """ + A plan sum describes the cumulative dose summation of several treatment plans. It can be used, for example, to evaluate the dose the patient received from a treatment plan and boost plan together. + + Attributes: + PlanSumComponents (List[PlanSumComponent]): A collection of plans in a plan sum. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSum. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the PlanSum. + PlanSetups (List[PlanSetup]): A collection of plan setups. + PlanSumComponents (List[PlanSumComponent]): A collection of plans in a plan sum. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSum. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the PlanSum. + PlanSetups (List[PlanSetup]): A collection of plan setups. + """ + def __init__(self) -> None: ... + + PlanSumComponents: List[PlanSumComponent] + + Id: str + + Name: str + + PlanSetups: List[PlanSetup] + + PlanSumComponents: List[PlanSumComponent] + + Id: str + + Name: str + + PlanSetups: List[PlanSetup] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum with default parameters ( + def AddItem(self, pi: PlanningItem) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum. If item to be added is a plan sum, all plans of the plan sum will be added. + def AddItem(self, pi: PlanningItem, operation: PlanSumOperation, planWeight: float) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + operation: The summing operation of the plan in the plan sum. + planWeight: Plan weight + """ + ... + + + # Returns the summing operation of the plan in the plan sum. + def GetPlanSumOperation(self, planSetupInPlanSum: PlanSetup) -> PlanSumOperation: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + """ + ... + + + # Returns the weight of the plan included in the sum. + def GetPlanWeight(self, planSetupInPlanSum: PlanSetup) -> float: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove a planning item from the plan sum. If item to be removed is a plan sum, all plans of the plan sum will be removed. + def RemoveItem(self, pi: PlanningItem) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the summing operation for the plan in the plan sum. + def SetPlanSumOperation(self, planSetupInPlanSum: PlanSetup, operation: PlanSumOperation) -> None: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + operation: The summing operation of the plan in the plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the weight of the plan included in the sum. + def SetPlanWeight(self, planSetupInPlanSum: PlanSetup, weight: float) -> None: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + weight: Plan weight + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum with default parameters ( + def AddItem(self, pi: PlanningItem) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum. If item to be added is a plan sum, all plans of the plan sum will be added. + def AddItem(self, pi: PlanningItem, operation: PlanSumOperation, planWeight: float) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + operation: The summing operation of the plan in the plan sum. + planWeight: Plan weight + """ + ... + + + # Returns the summing operation of the plan in the plan sum. + def GetPlanSumOperation(self, planSetupInPlanSum: PlanSetup) -> PlanSumOperation: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + """ + ... + + + # Returns the weight of the plan included in the sum. + def GetPlanWeight(self, planSetupInPlanSum: PlanSetup) -> float: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove a planning item from the plan sum. If item to be removed is a plan sum, all plans of the plan sum will be removed. + def RemoveItem(self, pi: PlanningItem) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the summing operation for the plan in the plan sum. + def SetPlanSumOperation(self, planSetupInPlanSum: PlanSetup, operation: PlanSumOperation) -> None: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + operation: The summing operation of the plan in the plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the weight of the plan included in the sum. + def SetPlanWeight(self, planSetupInPlanSum: PlanSetup, weight: float) -> None: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + weight: Plan weight + """ + ... + + + +class SerializableObject: + """ + Base class for objects that can be serialized. + """ + def __init__(self) -> None: ... + + # This member is internal to the Eclipse Scripting API. + def GetSchema(self) -> Xml.Schema.XmlSchema: + ... + + + # This member is internal to the Eclipse Scripting API. + def ReadXml(self, reader: Xml.XmlReader) -> None: + """ + Args: + reader: XmlReader + """ + ... + + + # Serializes this object to the given XmlWriter. + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: XmlWriter where this object is serialized. + """ + ... + + + # Serializes everything except IEnumerable. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Any) -> None: + """ + Args: + writer: XmlWriter + name: Name. + obj: Object. + """ + ... + + + # Serializes a string. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: str) -> None: + """ + Args: + writer: XmlWriter. + name: Name. + obj: String. + """ + ... + + + # Serializes IEnumerable. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: IEnumerable[T]) -> None: + ... + + + # Serializes IDictionary. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Dict[T, T2]) -> None: + ... + + + # Must be called at the beginning of serialization + def StartSerialization(self, typeName: str, typeId: str) -> Any: + """ + Args: + typeName: Name of the type to serialize. + typeId: Id of the object. + """ + ... + + + # Must be called at the end of serialization. Clear history records and type names. + def EndSerialization(self) -> Any: + ... + + + # Check if history contains information about class + def IsTypeSerialized(self) -> Any: + ... + + + # Add history record + def AddTypeToHistory(self) -> Any: + ... + + + # This member is internal to the Eclipse Scripting API. + def ClearSerializationHistory(self) -> None: + ... + + + # This member is internal to the Eclipse Scripting API. + def GetSchema(self) -> Xml.Schema.XmlSchema: + ... + + + # This member is internal to the Eclipse Scripting API. + def ReadXml(self, reader: Xml.XmlReader) -> None: + """ + Args: + reader: XmlReader + """ + ... + + + # Serializes this object to the given XmlWriter. + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: XmlWriter where this object is serialized. + """ + ... + + + # Serializes everything except IEnumerable. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Any) -> None: + """ + Args: + writer: XmlWriter + name: Name. + obj: Object. + """ + ... + + + # Serializes a string. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: str) -> None: + """ + Args: + writer: XmlWriter. + name: Name. + obj: String. + """ + ... + + + # Serializes IEnumerable. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: IEnumerable[T]) -> None: + ... + + + # Serializes IDictionary. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Dict[T, T2]) -> None: + ... + + + # Must be called at the beginning of serialization + def StartSerialization(self, typeName: str, typeId: str) -> Any: + """ + Args: + typeName: Name of the type to serialize. + typeId: Id of the object. + """ + ... + + + # Must be called at the end of serialization. Clear history records and type names. + def EndSerialization(self) -> Any: + ... + + + # Check if history contains information about class + def IsTypeSerialized(self) -> Any: + ... + + + # Add history record + def AddTypeToHistory(self) -> Any: + ... + + + # This member is internal to the Eclipse Scripting API. + def ClearSerializationHistory(self) -> None: + ... + + + +class Registration: + """ + Represents the spatial registration matrix between two frames of reference. + + Attributes: + CreationDateTime (Optional[datetime]): The date when this object was created. + RegisteredFOR (str): The frame of reference UID of the registered coordinate system. + SourceFOR (str): The frame of reference UID of the source coordinate system. + Status (RegistrationApprovalStatus): The current approval status of the registration. + StatusDateTime (Optional[datetime]): The approval status date and time. + StatusUserDisplayName (str): Full user name of user who changed the approval status. + StatusUserName (str): User ID of the user who changed the approval status. + TransformationMatrix (Array[float]): The elements of the 4x4 transformation matrix. + UID (str): The SOP Instance UID of this registration object. + CreationDateTime (Optional[datetime]): The date when this object was created. + RegisteredFOR (str): The frame of reference UID of the registered coordinate system. + SourceFOR (str): The frame of reference UID of the source coordinate system. + Status (RegistrationApprovalStatus): The current approval status of the registration. + StatusDateTime (Optional[datetime]): The approval status date and time. + StatusUserDisplayName (str): Full user name of user who changed the approval status. + StatusUserName (str): User ID of the user who changed the approval status. + TransformationMatrix (Array[float]): The elements of the 4x4 transformation matrix. + UID (str): The SOP Instance UID of this registration object. + """ + def __init__(self) -> None: ... + + CreationDateTime: Optional[datetime] + + RegisteredFOR: str + + SourceFOR: str + + Status: RegistrationApprovalStatus + + StatusDateTime: Optional[datetime] + + StatusUserDisplayName: str + + StatusUserName: str + + TransformationMatrix: Array[float] + + UID: str + + CreationDateTime: Optional[datetime] + + RegisteredFOR: str + + SourceFOR: str + + Status: RegistrationApprovalStatus + + StatusDateTime: Optional[datetime] + + StatusUserDisplayName: str + + StatusUserName: str + + TransformationMatrix: Array[float] + + UID: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Transforms a point in the inverse direction, that is, from the coordinate system of the RegisteredFOR to the coordinate system of the SourceFOR. + def InverseTransformPoint(self, pt: VVector) -> VVector: + """ + Args: + pt: Point in the RegisteredFOR coordinate system. + """ + ... + + + # Transforms a point from the SourceFOR coordinate system to the RegisteredFOR coordinate system. + def TransformPoint(self, pt: VVector) -> VVector: + """ + Args: + pt: Point in the SourceFOR coordinate system. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Transforms a point in the inverse direction, that is, from the coordinate system of the RegisteredFOR to the coordinate system of the SourceFOR. + def InverseTransformPoint(self, pt: VVector) -> VVector: + """ + Args: + pt: Point in the RegisteredFOR coordinate system. + """ + ... + + + # Transforms a point from the SourceFOR coordinate system to the RegisteredFOR coordinate system. + def TransformPoint(self, pt: VVector) -> VVector: + """ + Args: + pt: Point in the SourceFOR coordinate system. + """ + ... + + + +class Series: + """ + A series is a collection of radiation therapy objects of a patient. The series is part of a study. See the definition of a DICOM Series for more information. + + Attributes: + FOR (str): The UID of the frame of reference. + Images (List[Image]): A collection of images that belong to the series. + ImagingDeviceDepartment (str): The assigned department of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device department is not defined. + ImagingDeviceId (str): The identifier of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device identifier is not defined. + ImagingDeviceManufacturer (str): The manufacturer of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device manufacturer is not defined. + ImagingDeviceModel (str): The model of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device model is not defined. + ImagingDeviceSerialNo (str): The serial number of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device serial number is not defined. + Modality (SeriesModality): The modality of the series. + Study (Study): Used for navigating to parent study. + UID (str): The DICOM UID. + FOR (str): The UID of the frame of reference. + Images (List[Image]): A collection of images that belong to the series. + ImagingDeviceDepartment (str): The assigned department of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device department is not defined. + ImagingDeviceId (str): The identifier of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device identifier is not defined. + ImagingDeviceManufacturer (str): The manufacturer of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device manufacturer is not defined. + ImagingDeviceModel (str): The model of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device model is not defined. + ImagingDeviceSerialNo (str): The serial number of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device serial number is not defined. + Modality (SeriesModality): The modality of the series. + Study (Study): Used for navigating to parent study. + UID (str): The DICOM UID. + """ + def __init__(self) -> None: ... + + FOR: str + + Images: List[Image] + + ImagingDeviceDepartment: str + + ImagingDeviceId: str + + ImagingDeviceManufacturer: str + + ImagingDeviceModel: str + + ImagingDeviceSerialNo: str + + Modality: SeriesModality + + Study: Study + + UID: str + + FOR: str + + Images: List[Image] + + ImagingDeviceDepartment: str + + ImagingDeviceId: str + + ImagingDeviceManufacturer: str + + ImagingDeviceModel: str + + ImagingDeviceSerialNo: str + + Modality: SeriesModality + + Study: Study + + UID: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the imaging device for the image series based on the identifier of the imaging device. If the imaging device identifier is not found, an exception is thrown. + def SetImagingDevice(self, imagingDeviceId: str) -> None: + """ + Args: + imagingDeviceId: Identifier of the imaging device. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the imaging device for the image series based on the identifier of the imaging device. If the imaging device identifier is not found, an exception is thrown. + def SetImagingDevice(self, imagingDeviceId: str) -> None: + """ + Args: + imagingDeviceId: Identifier of the imaging device. + """ + ... + + + +class Slot: + """ + A slot is the location (typically on the collimator head of the gantry) where an add-on, such as a wedge or block, is mounted. + + Attributes: + Number (int): The slot number is unique within an instance of a treatment machine. + Number (int): The slot number is unique within an instance of a treatment machine. + """ + def __init__(self) -> None: ... + + Number: int + + Number: int + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Study: + """ + A study is a collection of series. + + Attributes: + CreationDateTime (Optional[datetime]): The date when this object was created. + Images3D (List[Image]): A collection of 3D images in a study. + Series (List[Series]): A collection of series. + UID (str): The DICOM UID. + CreationDateTime (Optional[datetime]): The date when this object was created. + Images3D (List[Image]): A collection of 3D images in a study. + Series (List[Series]): A collection of series. + UID (str): The DICOM UID. + """ + def __init__(self) -> None: ... + + CreationDateTime: Optional[datetime] + + Images3D: List[Image] + + Series: List[Series] + + UID: str + + CreationDateTime: Optional[datetime] + + Images3D: List[Image] + + Series: List[Series] + + UID: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Technique: + """ + Treatment technique used for a beam. Can be, for example, static or arc, or (for proton beams) modulated scanning. + + Attributes: + IsArc (bool): Returns the value true if the beam technique is 'ARC' or 'SRS ARC'. + IsModulatedScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING'. + IsProton (bool): Returns the value true if it is a proton beam. + IsScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING' or 'UNIFORM_SCANNING'. + IsStatic (bool): Returns the value true if the beam technique is 'STATIC' or 'SRS STATIC'. + IsArc (bool): Returns the value true if the beam technique is 'ARC' or 'SRS ARC'. + IsModulatedScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING'. + IsProton (bool): Returns the value true if it is a proton beam. + IsScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING' or 'UNIFORM_SCANNING'. + IsStatic (bool): Returns the value true if the beam technique is 'STATIC' or 'SRS STATIC'. + """ + def __init__(self) -> None: ... + + IsArc: bool + + IsModulatedScanning: bool + + IsProton: bool + + IsScanning: bool + + IsStatic: bool + + IsArc: bool + + IsModulatedScanning: bool + + IsProton: bool + + IsScanning: bool + + IsStatic: bool + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class TradeoffObjective: + """ + Trade-off objective interface that consists of a set of optimization objectives. + + Attributes: + Id (int): Identifier of the trade-off objective. + OptimizationObjectives (List[OptimizationObjective]): The collection of objectives that this trade-off objective represents. + Structure (Structure): Structure that this trade-off objective represents. + Id (int): Identifier of the trade-off objective. + OptimizationObjectives (List[OptimizationObjective]): The collection of objectives that this trade-off objective represents. + Structure (Structure): Structure that this trade-off objective represents. + """ + def __init__(self) -> None: ... + + Id: int + + OptimizationObjectives: List[OptimizationObjective] + + Structure: Structure + + Id: int + + OptimizationObjectives: List[OptimizationObjective] + + Structure: Structure + + +class Tray: + """ + A tray add-on is a plate where blocks, compensators, and other beam modifying materials can be fixed to. The tray is inserted into a slot during the treatment of a beam. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class TreatmentPhase: + """ + Treatment phase. + + Attributes: + OtherInfo (str): Other info (notes). + PhaseGapNumberOfDays (int): Number of days between phases. + Prescriptions (List[RTPrescription]): A collection of RT prescriptions in the course. + TimeGapType (str): Type of the time gap. + OtherInfo (str): Other info (notes). + PhaseGapNumberOfDays (int): Number of days between phases. + Prescriptions (List[RTPrescription]): A collection of RT prescriptions in the course. + TimeGapType (str): Type of the time gap. + """ + def __init__(self) -> None: ... + + OtherInfo: str + + PhaseGapNumberOfDays: int + + Prescriptions: List[RTPrescription] + + TimeGapType: str + + OtherInfo: str + + PhaseGapNumberOfDays: int + + Prescriptions: List[RTPrescription] + + TimeGapType: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class TreatmentSession: + """ + Treatment session. + + Attributes: + SessionNumber (int): Treatment session number. + SessionPlans (List[PlanTreatmentSession]): Plans in this treatment session. + SessionNumber (int): Treatment session number. + SessionPlans (List[PlanTreatmentSession]): Plans in this treatment session. + """ + def __init__(self) -> None: ... + + SessionNumber: int + + SessionPlans: List[PlanTreatmentSession] + + SessionNumber: int + + SessionPlans: List[PlanTreatmentSession] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class TreatmentUnitOperatingLimit: + """ + Describes the limits of a treatment unit parameter and provides descriptive information related to it. + + Attributes: + Label (str): Gets the descriptive name of the operating limit parameter. + MaxValue (float): Gets the maximum allowed value for the operating limit parameter. + MinValue (float): Gets the minimum allowed value for the operating limit parameter. + Precision (Optional[int]): Gets the number of decimal places to display for the operating limit parameter. + UnitString (str): Gets the string that describes the unit of the operating limit parameter. + Label (str): Gets the descriptive name of the operating limit parameter. + MaxValue (float): Gets the maximum allowed value for the operating limit parameter. + MinValue (float): Gets the minimum allowed value for the operating limit parameter. + Precision (Optional[int]): Gets the number of decimal places to display for the operating limit parameter. + UnitString (str): Gets the string that describes the unit of the operating limit parameter. + """ + def __init__(self) -> None: ... + + Label: str + + MaxValue: float + + MinValue: float + + Precision: Optional[int] + + UnitString: str + + Label: str + + MaxValue: float + + MinValue: float + + Precision: Optional[int] + + UnitString: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class TreatmentUnitOperatingLimits: + """ + Provides operating limit information for treatment unit parameters. + + Attributes: + CollimatorAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the collimator angle parameter. + GantryAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the gantry angle parameter. + MU (TreatmentUnitOperatingLimit): Gets the operating limit information for the monitor unit (MU) parameter. + PatientSupportAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the patient support angle parameter. + CollimatorAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the collimator angle parameter. + GantryAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the gantry angle parameter. + MU (TreatmentUnitOperatingLimit): Gets the operating limit information for the monitor unit (MU) parameter. + PatientSupportAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the patient support angle parameter. + """ + def __init__(self) -> None: ... + + CollimatorAngle: TreatmentUnitOperatingLimit + + GantryAngle: TreatmentUnitOperatingLimit + + MU: TreatmentUnitOperatingLimit + + PatientSupportAngle: TreatmentUnitOperatingLimit + + CollimatorAngle: TreatmentUnitOperatingLimit + + GantryAngle: TreatmentUnitOperatingLimit + + MU: TreatmentUnitOperatingLimit + + PatientSupportAngle: TreatmentUnitOperatingLimit + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Wedge: + """ + A wedge is a beam modulating add-on that modifies the dose intensity over all or a part of a treatment beam. + + Attributes: + Direction (float): The wedge orientation with respect to the beam orientation, in degrees. + WedgeAngle (float): The wedge angle. + Direction (float): The wedge orientation with respect to the beam orientation, in degrees. + WedgeAngle (float): The wedge angle. + + Note: + Use run-time type information via operator + """ + def __init__(self) -> None: ... + + Direction: float + + WedgeAngle: float + + Direction: float + + WedgeAngle: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class AddOn: + """ + Represents an add-on, which is a beam modifying device that is inserted into a beam in an accessory slot of the external beam machine. An add-on is used to shape the beam or modulate its intensity or both. Add-ons are blocks, MLCs, wedges, compensators, applicators, a tray, and other devices or materials that can be fixed to a tray to be mounted into an accessory slot. + + Attributes: + CreationDateTime (Optional[datetime]): The date when this object was created. + CreationDateTime (Optional[datetime]): The date when this object was created. + """ + def __init__(self) -> None: ... + + CreationDateTime: Optional[datetime] + + CreationDateTime: Optional[datetime] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class AddOnMaterial: + """ + Add-on material describes the dosimetric and physical properties of the metal alloy or other substance used to create the add-on. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ApplicationPackage: + """ + Presents the application package information in the system. Note: not all methods are necessarily Published at the moment. + + Attributes: + ApprovalStatus (ApplicationScriptApprovalStatus): The status of the application package. Possible values are defined by a lookup RT_APP_EXTENSION_STATUS. + Description (str): Description of functionality provided by the package. + ExpirationDate (Optional[datetime]): An optional expiration date of the package. The package cannot be executed after expiration date. The date is presented in UTC. + PackageId (str): Unique Package ID. + PackageName (str): The full name of the package. + PackageVersion (str): The version number of the package. + PublisherData (str): Optional JSON data that can be used by package internally, e.g. customer key. + PublisherName (str): The name of the organization or author that created the package. This is a free text that can be set by the approver. + ApprovalStatus (ApplicationScriptApprovalStatus): The status of the application package. Possible values are defined by a lookup RT_APP_EXTENSION_STATUS. + Description (str): Description of functionality provided by the package. + ExpirationDate (Optional[datetime]): An optional expiration date of the package. The package cannot be executed after expiration date. The date is presented in UTC. + PackageId (str): Unique Package ID. + PackageName (str): The full name of the package. + PackageVersion (str): The version number of the package. + PublisherData (str): Optional JSON data that can be used by package internally, e.g. customer key. + PublisherName (str): The name of the organization or author that created the package. This is a free text that can be set by the approver. + """ + def __init__(self) -> None: ... + + ApprovalStatus: ApplicationScriptApprovalStatus + + Description: str + + ExpirationDate: Optional[datetime] + + PackageId: str + + PackageName: str + + PackageVersion: str + + PublisherData: str + + PublisherName: str + + ApprovalStatus: ApplicationScriptApprovalStatus + + Description: str + + ExpirationDate: Optional[datetime] + + PackageId: str + + PackageName: str + + PackageVersion: str + + PublisherData: str + + PublisherName: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ApplicationScript: + """ + Presents the application script information in the system. The location of the script file is not stored in the system. + + Attributes: + ApprovalStatus (ApplicationScriptApprovalStatus): The status of the script. + ApprovalStatusDisplayText (str): The display text of the approval status. + AssemblyName (Reflection.AssemblyName): The full name of the script assembly. + ExpirationDate (Optional[datetime]): An optional expiration date of the script. The script cannot be executed after expiration date. The date is presented in UTC. + IsReadOnlyScript (bool): Returns true if the script is intended only to read patient data. + IsWriteableScript (bool): Returns true if the script is intended to modify persistent data. + PublisherName (str): The name of the organization or author that created the script. This is a free text that can be set by the approver. + ScriptType (ApplicationScriptType): The type of the application script. + StatusDate (Optional[datetime]): A timestamp of the last approval status modification. + StatusUserIdentity (UserIdentity): The identity of the user who last modified the approval status. + ApprovalStatus (ApplicationScriptApprovalStatus): The status of the script. + ApprovalStatusDisplayText (str): The display text of the approval status. + AssemblyName (Reflection.AssemblyName): The full name of the script assembly. + ExpirationDate (Optional[datetime]): An optional expiration date of the script. The script cannot be executed after expiration date. The date is presented in UTC. + IsReadOnlyScript (bool): Returns true if the script is intended only to read patient data. + IsWriteableScript (bool): Returns true if the script is intended to modify persistent data. + PublisherName (str): The name of the organization or author that created the script. This is a free text that can be set by the approver. + ScriptType (ApplicationScriptType): The type of the application script. + StatusDate (Optional[datetime]): A timestamp of the last approval status modification. + StatusUserIdentity (UserIdentity): The identity of the user who last modified the approval status. + """ + def __init__(self) -> None: ... + + ApprovalStatus: ApplicationScriptApprovalStatus + + ApprovalStatusDisplayText: str + + AssemblyName: Reflection.AssemblyName + + ExpirationDate: Optional[datetime] + + IsReadOnlyScript: bool + + IsWriteableScript: bool + + PublisherName: str + + ScriptType: ApplicationScriptType + + StatusDate: Optional[datetime] + + StatusUserIdentity: UserIdentity + + ApprovalStatus: ApplicationScriptApprovalStatus + + ApprovalStatusDisplayText: str + + AssemblyName: Reflection.AssemblyName + + ExpirationDate: Optional[datetime] + + IsReadOnlyScript: bool + + IsWriteableScript: bool + + PublisherName: str + + ScriptType: ApplicationScriptType + + StatusDate: Optional[datetime] + + StatusUserIdentity: UserIdentity + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ApplicationScriptLog: + """ + The log entry of the application script execution. + + Attributes: + CourseId (str): The identifier of the course that was modified by the script. + PatientId (str): The identifier of the patient that was modified by the script. + PlanSetupId (str): The identifier of the plan that was modified by the script, or an empty string if the script did not modify the plan. + PlanUID (str): The DICOM UID of the plan that was modified by the script, or an empty string if the script did not modify the plan. + Script (ApplicationScript): The script that modified the plan or structure set. + ScriptFullName (str): The full name of the script assembly that modified the plan or structure set. A System.Reflection.AssemblyName object can be created from the string. + StructureSetId (str): The identifier of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. + StructureSetUID (str): The DICOM UID of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. + CourseId (str): The identifier of the course that was modified by the script. + PatientId (str): The identifier of the patient that was modified by the script. + PlanSetupId (str): The identifier of the plan that was modified by the script, or an empty string if the script did not modify the plan. + PlanUID (str): The DICOM UID of the plan that was modified by the script, or an empty string if the script did not modify the plan. + Script (ApplicationScript): The script that modified the plan or structure set. + ScriptFullName (str): The full name of the script assembly that modified the plan or structure set. A System.Reflection.AssemblyName object can be created from the string. + StructureSetId (str): The identifier of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. + StructureSetUID (str): The DICOM UID of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. + """ + def __init__(self) -> None: ... + + CourseId: str + + PatientId: str + + PlanSetupId: str + + PlanUID: str + + Script: ApplicationScript + + ScriptFullName: str + + StructureSetId: str + + StructureSetUID: str + + CourseId: str + + PatientId: str + + PlanSetupId: str + + PlanUID: str + + Script: ApplicationScript + + ScriptFullName: str + + StructureSetId: str + + StructureSetUID: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Applicator: + """ + An applicator add-on, either an electron applicator or cone applicator. + + Attributes: + ApplicatorLengthInMM (float): Applicator length in mm. + DiameterInMM (float): Applicator Diameter in mm. + FieldSizeX (float): The field width in direction X (cm). + FieldSizeY (float): The field width in direction Y (cm). + IsStereotactic (bool): Is stereotactic. + ApplicatorLengthInMM (float): Applicator length in mm. + DiameterInMM (float): Applicator Diameter in mm. + FieldSizeX (float): The field width in direction X (cm). + FieldSizeY (float): The field width in direction Y (cm). + IsStereotactic (bool): Is stereotactic. + """ + def __init__(self) -> None: ... + + ApplicatorLengthInMM: float + + DiameterInMM: float + + FieldSizeX: float + + FieldSizeY: float + + IsStereotactic: bool + + ApplicatorLengthInMM: float + + DiameterInMM: float + + FieldSizeX: float + + FieldSizeY: float + + IsStereotactic: bool + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class BeamDose: + """ + Represents a dose that is connected to a Beam. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts a relative beam dose value into absolute units. This method factors in the field weight, dose prescription, prescribed percentage and plan normalization. + def GetAbsoluteBeamDoseValue(self, relative: DoseValue) -> DoseValue: + """ + Args: + relative: The relative dose value from this beam dose matrix to be converted. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts a relative beam dose value into absolute units. This method factors in the field weight, dose prescription, prescribed percentage and plan normalization. + def GetAbsoluteBeamDoseValue(self, relative: DoseValue) -> DoseValue: + """ + Args: + relative: The relative dose value from this beam dose matrix to be converted. + """ + ... + + + +class BeamParameters: + """ + An editable copy of the parameters of a treatment beam. + + Attributes: + ControlPoints (List[ControlPointParameters]): Editable control point parameters copied from the treatment beam. + GantryDirection (GantryDirection): The direction of gantry rotation (clockwise or counterclockwise). + Isocenter (VVector): A copy of the isocenter position, in millimeters. + WeightFactor (float): The weight factor of the beam. + ControlPoints (List[ControlPointParameters]): Editable control point parameters copied from the treatment beam. + GantryDirection (GantryDirection): The direction of gantry rotation (clockwise or counterclockwise). + Isocenter (VVector): A copy of the isocenter position, in millimeters. + WeightFactor (float): The weight factor of the beam. + + Note: + To apply the parameters, call the + """ + def __init__(self) -> None: ... + + ControlPoints: List[ControlPointParameters] + + GantryDirection: GantryDirection + + Isocenter: VVector + + WeightFactor: float + + ControlPoints: List[ControlPointParameters] + + GantryDirection: GantryDirection + + Isocenter: VVector + + WeightFactor: float + + # Assigns the given leaf positions to each of the control point parameters. + def SetAllLeafPositions(self, leafPositions: Array[float]) -> None: + """ + Args: + leafPositions: The positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. + """ + ... + + + # Assigns the given jaw positions to each of the control point parameters. + def SetJawPositions(self, positions: VRect[float]) -> None: + """ + Args: + positions: A rectangle describing the jaw positions in millimeters in IEC BEAM LIMITING DEVICE coordinates. + """ + ... + + + # Assigns the given leaf positions to each of the control point parameters. + def SetAllLeafPositions(self, leafPositions: Array[float]) -> None: + """ + Args: + leafPositions: The positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. + """ + ... + + + # Assigns the given jaw positions to each of the control point parameters. + def SetJawPositions(self, positions: VRect[float]) -> None: + """ + Args: + positions: A rectangle describing the jaw positions in millimeters in IEC BEAM LIMITING DEVICE coordinates. + """ + ... + + + +class BeamUncertainty: + """ + Access to beam uncertainty. + + Attributes: + Beam (Beam): The beam to which this uncertainty is linked. + BeamNumber (BeamNumber): Beam number of the related beam. + Dose (Dose): Dose of this beam uncertainty. + Beam (Beam): The beam to which this uncertainty is linked. + BeamNumber (BeamNumber): Beam number of the related beam. + Dose (Dose): Dose of this beam uncertainty. + """ + def __init__(self) -> None: ... + + Beam: Beam + + BeamNumber: BeamNumber + + Dose: Dose + + Beam: Beam + + BeamNumber: BeamNumber + + Dose: Dose + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class BrachyFieldReferencePoint: + """ + This object links a Brachy field to a reference point. + + Attributes: + FieldDose (DoseValue): The field dose. + IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. + IsPrimaryReferencePoint (bool): Checks if the reference point is primary. + ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. + RefPointLocation (VVector): The location of the reference point. + FieldDose (DoseValue): The field dose. + IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. + IsPrimaryReferencePoint (bool): Checks if the reference point is primary. + ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. + RefPointLocation (VVector): The location of the reference point. + """ + def __init__(self) -> None: ... + + FieldDose: DoseValue + + IsFieldDoseNominal: bool + + IsPrimaryReferencePoint: bool + + ReferencePoint: ReferencePoint + + RefPointLocation: VVector + + FieldDose: DoseValue + + IsFieldDoseNominal: bool + + IsPrimaryReferencePoint: bool + + ReferencePoint: ReferencePoint + + RefPointLocation: VVector + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class BrachyPlanSetup: + """ + Represents a brachytherapy treatment plan. + + Attributes: + ApplicationSetupType (str): The application setup type of this brachytherapy plan. Possible types are: "FLETCHER_SUIT", "DELCLOS", "BLOEDORN", "JOSLIN_FLYNN", "CHANDIGARH", "MANCHESTER", "HENSCHKE", "NASOPHARYNGEAL", "OESOPHAGEAL", "ENDOBRONCHIAL", "SYED_NEBLETT", "ENDORECTAL", "PERINEAL", "HAM_FLAB", "EYE_PLAQUE", and "OTHER". + BrachyTreatmentTechnique (BrachyTreatmentTechniqueType): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". + Catheters (List[Catheter]): The catheters or applicator channel centerlines of this brachytherapy plan, including any catheters associated with + NumberOfPdrPulses (Optional[int]): The number of pulses in a brachytherapy Pulse Dose Rate (PDR) treatment. Null if the plan is not for a PDR treatment. + PdrPulseInterval (Optional[float]): The pulse interval in a brachytherapy Pulse Dose Rate (PDR) treatment in seconds. Null if the plan is not for a PDR treatment. + ReferenceLines (List[Structure]): Collection of reference lines in the plan. + SeedCollections (List[SeedCollection]): The seed collections of this brachytherapy plan. + SolidApplicators (List[BrachySolidApplicator]): The solid applicator parts of this brachytherapy plan. + TreatmentTechnique (str): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". + TreatmentDateTime (Optional[datetime]): The treatment date of this brachytherapy plan. + ApplicationSetupType (str): The application setup type of this brachytherapy plan. Possible types are: "FLETCHER_SUIT", "DELCLOS", "BLOEDORN", "JOSLIN_FLYNN", "CHANDIGARH", "MANCHESTER", "HENSCHKE", "NASOPHARYNGEAL", "OESOPHAGEAL", "ENDOBRONCHIAL", "SYED_NEBLETT", "ENDORECTAL", "PERINEAL", "HAM_FLAB", "EYE_PLAQUE", and "OTHER". + BrachyTreatmentTechnique (BrachyTreatmentTechniqueType): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". + Catheters (List[Catheter]): The catheters or applicator channel centerlines of this brachytherapy plan, including any catheters associated with + NumberOfPdrPulses (Optional[int]): The number of pulses in a brachytherapy Pulse Dose Rate (PDR) treatment. Null if the plan is not for a PDR treatment. + PdrPulseInterval (Optional[float]): The pulse interval in a brachytherapy Pulse Dose Rate (PDR) treatment in seconds. Null if the plan is not for a PDR treatment. + ReferenceLines (List[Structure]): Collection of reference lines in the plan. + SeedCollections (List[SeedCollection]): The seed collections of this brachytherapy plan. + SolidApplicators (List[BrachySolidApplicator]): The solid applicator parts of this brachytherapy plan. + TreatmentTechnique (str): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". + TreatmentDateTime (Optional[datetime]): The treatment date of this brachytherapy plan. + """ + def __init__(self) -> None: ... + + ApplicationSetupType: str + + BrachyTreatmentTechnique: BrachyTreatmentTechniqueType + + Catheters: List[Catheter] + + NumberOfPdrPulses: Optional[int] + + PdrPulseInterval: Optional[float] + + ReferenceLines: List[Structure] + + SeedCollections: List[SeedCollection] + + SolidApplicators: List[BrachySolidApplicator] + + TreatmentTechnique: str + + TreatmentDateTime: Optional[datetime] + + ApplicationSetupType: str + + BrachyTreatmentTechnique: BrachyTreatmentTechniqueType + + Catheters: List[Catheter] + + NumberOfPdrPulses: Optional[int] + + PdrPulseInterval: Optional[float] + + ReferenceLines: List[Structure] + + SeedCollections: List[SeedCollection] + + SolidApplicators: List[BrachySolidApplicator] + + TreatmentTechnique: str + + TreatmentDateTime: Optional[datetime] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new brachyterapy applicator to the plan. + def AddCatheter(self, catheterId: str, treatmentUnit: BrachyTreatmentUnit, outputDiagnostics: Text.StringBuilder, appendChannelNumToId: bool, channelNum: int) -> Catheter: + """ + Args: + catheterId: Id of the catheter. + treatmentUnit: The + outputDiagnostics: Additional information about brachytherapy applicator creation. + appendChannelNumToId: If true, channel number will be appended to the given catheterId. + channelNum: Channel number of the catheter. 0 assigns next available free channel number. -1 assigns empty channel number. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add location to reference point. + def AddLocationToExistingReferencePoint(self, location: VVector, referencePoint: ReferencePoint) -> None: + """ + Args: + location: Reference point location in mm. + referencePoint: Reference point. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point without location. Created reference point is linked to the plan. + def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: + """ + Args: + target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). + id: Reference point ID. + """ + ... + + + # Calculates and returns the dose profile. Profile is calculated on the fly with TG-43 formalism. + def CalculateAccurateTG43DoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Changes the brachy treatment unit for all applicators in the brachy plan. + def ChangeTreatmentUnit(self, treatmentUnit: BrachyTreatmentUnit, messages: bool, keepDoseIntact: List[str]) -> ChangeBrachyTreatmentUnitResult: + """ + Args: + treatmentUnit: The + messages: An output parameter that may be populated with 1..n messages of additional information. + keepDoseIntact: If true, the dwell times are scaled to keep the dose intact. If false, dwell times are not scaled, and the dose may be invalidated. + """ + ... + + + # Calculates 3D dose using the TG-43 brachy calculator. + def CalculateTG43Dose(self) -> CalculateBrachy3DDoseResult: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new brachyterapy applicator to the plan. + def AddCatheter(self, catheterId: str, treatmentUnit: BrachyTreatmentUnit, outputDiagnostics: Text.StringBuilder, appendChannelNumToId: bool, channelNum: int) -> Catheter: + """ + Args: + catheterId: Id of the catheter. + treatmentUnit: The + outputDiagnostics: Additional information about brachytherapy applicator creation. + appendChannelNumToId: If true, channel number will be appended to the given catheterId. + channelNum: Channel number of the catheter. 0 assigns next available free channel number. -1 assigns empty channel number. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add location to reference point. + def AddLocationToExistingReferencePoint(self, location: VVector, referencePoint: ReferencePoint) -> None: + """ + Args: + location: Reference point location in mm. + referencePoint: Reference point. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point without location. Created reference point is linked to the plan. + def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: + """ + Args: + target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). + id: Reference point ID. + """ + ... + + + # Calculates and returns the dose profile. Profile is calculated on the fly with TG-43 formalism. + def CalculateAccurateTG43DoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Changes the brachy treatment unit for all applicators in the brachy plan. + def ChangeTreatmentUnit(self, treatmentUnit: BrachyTreatmentUnit, messages: bool, keepDoseIntact: List[str]) -> ChangeBrachyTreatmentUnitResult: + """ + Args: + treatmentUnit: The + messages: An output parameter that may be populated with 1..n messages of additional information. + keepDoseIntact: If true, the dwell times are scaled to keep the dose intact. If false, dwell times are not scaled, and the dose may be invalidated. + """ + ... + + + # Calculates 3D dose using the TG-43 brachy calculator. + def CalculateTG43Dose(self) -> CalculateBrachy3DDoseResult: + ... + + + +class BrachySolidApplicator: + """ + Represents a brachytherapy solid applicator part, such as a tandem or ovoid in a Fletcher Suit Delclos (FSD) applicator set. This class holds only the metadata related to the solid applicator part, and links to the + + Attributes: + ApplicatorSetName (str): The name of the solid applicator set to which this part belongs. + ApplicatorSetType (str): The type of the solid applicator set to which this part belongs. + Category (str): The category of the solid applicator set to which this part belongs. + Catheters (List[Catheter]): The channel(s) of this solid applicator part. + GroupNumber (int): Applicator Group number. + Note (str): A note or short description of the solid applicator part. + PartName (str): The name of the solid applicator part. + PartNumber (str): The part number of the solid applicator. + Summary (str): A summary of the solid applicator set to which this part belongs. + UID (str): The unique identifier of the solid applicator part. + Vendor (str): The vendor of the solid applicator set to which this part belongs. + Version (str): The version of the solid applicator part. + ApplicatorSetName (str): The name of the solid applicator set to which this part belongs. + ApplicatorSetType (str): The type of the solid applicator set to which this part belongs. + Category (str): The category of the solid applicator set to which this part belongs. + Catheters (List[Catheter]): The channel(s) of this solid applicator part. + GroupNumber (int): Applicator Group number. + Note (str): A note or short description of the solid applicator part. + PartName (str): The name of the solid applicator part. + PartNumber (str): The part number of the solid applicator. + Summary (str): A summary of the solid applicator set to which this part belongs. + UID (str): The unique identifier of the solid applicator part. + Vendor (str): The vendor of the solid applicator set to which this part belongs. + Version (str): The version of the solid applicator part. + """ + def __init__(self) -> None: ... + + ApplicatorSetName: str + + ApplicatorSetType: str + + Category: str + + Catheters: List[Catheter] + + GroupNumber: int + + Note: str + + PartName: str + + PartNumber: str + + Summary: str + + UID: str + + Vendor: str + + Version: str + + ApplicatorSetName: str + + ApplicatorSetType: str + + Category: str + + Catheters: List[Catheter] + + GroupNumber: int + + Note: str + + PartName: str + + PartNumber: str + + Summary: str + + UID: str + + Vendor: str + + Version: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class BrachyTreatmentUnit: + """ + Represents a brachytherapy afterloader. + + Attributes: + DoseRateMode (str): The dose rate mode of this treatment unit. Supported modes are "HDR", "PDR", "MDR", and "LDR". + DwellTimeResolution (float): The dwell time resolution supported by this treatment unit in seconds. + MachineInterface (str): The interface type for communicating with this brachytherapy treatment unit. Possible types are "GammaMed12i", "GammaMedPlus", "VariSource", "Other", and "Omnitron" (obsolete type). + MachineModel (str): The model identifier for this treatment unit. Possible models are "VariSource_5", "VariSource_10", "Remote_Afterloading", "Manual_Loading", "GammaMed12i", and "GammaMedPlus". + MaxDwellTimePerChannel (float): The maximum combined dwell time in a single channel in seconds. + MaxDwellTimePerPos (float): The maximum dwell time in a single dwell position in seconds. + MaxDwellTimePerTreatment (float): The maximum combined dwell time in all the channels during a single treatment session. The value is in seconds. + MaximumChannelLength (float): The maximum channel length supported by this treatment unit in millimeters. + MaximumDwellPositionsPerChannel (int): The maximum number of dwell positions per channel supported by this treatment unit. + MaximumStepSize (float): The maximum distance between adjacent source positions in millimeters. + MinAllowedSourcePos (float): The minimum allowed distance (in millimeters) from the tip of the inner lumen of the applicator to the center of the first dwell position. In other words, no source positions should be placed within this distance from the tip of the inner lumen. + MinimumChannelLength (float): The minimum channel length supported by this treatment unit in millimeters. + MinimumStepSize (float): The minimum distance between adjacent source positions in millimeters. + NumberOfChannels (int): The number of channels in this treatment unit. + SourceCenterOffsetFromTip (float): The offset distance (in millimeters) from the tip of the applicator to the center of the source at its first possible dwell position. In other words, the offset accounts for half of the active source length and encapsulation. + SourceMovementType (str): The source movement type as defined in DICOM. Possible types are "STEPWISE", "FIXED", and "OSCILLATING". + StepSizeResolution (float): The default step size resolution for this treatment unit in millimeters. + DoseRateMode (str): The dose rate mode of this treatment unit. Supported modes are "HDR", "PDR", "MDR", and "LDR". + DwellTimeResolution (float): The dwell time resolution supported by this treatment unit in seconds. + MachineInterface (str): The interface type for communicating with this brachytherapy treatment unit. Possible types are "GammaMed12i", "GammaMedPlus", "VariSource", "Other", and "Omnitron" (obsolete type). + MachineModel (str): The model identifier for this treatment unit. Possible models are "VariSource_5", "VariSource_10", "Remote_Afterloading", "Manual_Loading", "GammaMed12i", and "GammaMedPlus". + MaxDwellTimePerChannel (float): The maximum combined dwell time in a single channel in seconds. + MaxDwellTimePerPos (float): The maximum dwell time in a single dwell position in seconds. + MaxDwellTimePerTreatment (float): The maximum combined dwell time in all the channels during a single treatment session. The value is in seconds. + MaximumChannelLength (float): The maximum channel length supported by this treatment unit in millimeters. + MaximumDwellPositionsPerChannel (int): The maximum number of dwell positions per channel supported by this treatment unit. + MaximumStepSize (float): The maximum distance between adjacent source positions in millimeters. + MinAllowedSourcePos (float): The minimum allowed distance (in millimeters) from the tip of the inner lumen of the applicator to the center of the first dwell position. In other words, no source positions should be placed within this distance from the tip of the inner lumen. + MinimumChannelLength (float): The minimum channel length supported by this treatment unit in millimeters. + MinimumStepSize (float): The minimum distance between adjacent source positions in millimeters. + NumberOfChannels (int): The number of channels in this treatment unit. + SourceCenterOffsetFromTip (float): The offset distance (in millimeters) from the tip of the applicator to the center of the source at its first possible dwell position. In other words, the offset accounts for half of the active source length and encapsulation. + SourceMovementType (str): The source movement type as defined in DICOM. Possible types are "STEPWISE", "FIXED", and "OSCILLATING". + StepSizeResolution (float): The default step size resolution for this treatment unit in millimeters. + """ + def __init__(self) -> None: ... + + DoseRateMode: str + + DwellTimeResolution: float + + MachineInterface: str + + MachineModel: str + + MaxDwellTimePerChannel: float + + MaxDwellTimePerPos: float + + MaxDwellTimePerTreatment: float + + MaximumChannelLength: float + + MaximumDwellPositionsPerChannel: int + + MaximumStepSize: float + + MinAllowedSourcePos: float + + MinimumChannelLength: float + + MinimumStepSize: float + + NumberOfChannels: int + + SourceCenterOffsetFromTip: float + + SourceMovementType: str + + StepSizeResolution: float + + DoseRateMode: str + + DwellTimeResolution: float + + MachineInterface: str + + MachineModel: str + + MaxDwellTimePerChannel: float + + MaxDwellTimePerPos: float + + MaxDwellTimePerTreatment: float + + MaximumChannelLength: float + + MaximumDwellPositionsPerChannel: int + + MaximumStepSize: float + + MinAllowedSourcePos: float + + MinimumChannelLength: float + + MinimumStepSize: float + + NumberOfChannels: int + + SourceCenterOffsetFromTip: float + + SourceMovementType: str + + StepSizeResolution: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns the active radioactive source of this treatment unit. + def GetActiveRadioactiveSource(self) -> RadioactiveSource: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns the active radioactive source of this treatment unit. + def GetActiveRadioactiveSource(self) -> RadioactiveSource: + ... + + + +class CalculateBrachy3DDoseResult: + """ + Brachy 3D dose calculation result + + Attributes: + Errors (List[str]): Error messages if "Success" is false. + RoundedDwellTimeAdjustRatio (float): The ratio with which the dwell times were adjusted to meet the resolution of the treatment unit. A value of zero (0.0) means no adjustment to dwell times was made. Value is undefined if "Success" is false + Success (bool): Was the dose calculation successful? + Errors (List[str]): Error messages if "Success" is false. + RoundedDwellTimeAdjustRatio (float): The ratio with which the dwell times were adjusted to meet the resolution of the treatment unit. A value of zero (0.0) means no adjustment to dwell times was made. Value is undefined if "Success" is false + Success (bool): Was the dose calculation successful? + """ + def __init__(self) -> None: ... + + Errors: List[str] + + RoundedDwellTimeAdjustRatio: float + + Success: bool + + Errors: List[str] + + RoundedDwellTimeAdjustRatio: float + + Success: bool + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Calculation: + """ + Contains a calculation specific functions + + Attributes: + AlgorithmsRootPath (str): Algorithms Root Path + AlgorithmsRootPath (str): Algorithms Root Path + """ + # Calculation object constructor + @overload + def __init__(self, dvhEstimationModelLibrary: IDVHEstimationModelLibrary) -> None: + """ + Args: + dvhEstimationModelLibrary: DVH Estimation Model Library + """ + ... + + + # Calculation object constructor + @overload + def __init__(self, dvhEstimationModelLibrary: IDVHEstimationModelLibrary) -> None: + """ + Args: + dvhEstimationModelLibrary: DVH Estimation Model Library + """ + ... + + + AlgorithmsRootPath: str + + AlgorithmsRootPath: str + + # Installed Algorithms + def GetInstalledAlgorithms(self) -> List[Calculation+Algorithm]: + ... + + + # Retrieves calculation models + def GetCalculationModels(self) -> List[Calculation+CalculationModel]: + ... + + + # Retrieves the list of DVH Estimation Model structures + def GetDvhEstimationModelStructures(self, modelId: Guid) -> List[DVHEstimationModelStructure]: + """ + Args: + modelId: Model ID. + """ + ... + + + # List of DVH Estimation Model summaries. + def GetDvhEstimationModelSummaries(self) -> List[DVHEstimationModelSummary]: + ... + + + # Installed Algorithms + def GetInstalledAlgorithms(self) -> List[Calculation+Algorithm]: + ... + + + # Retrieves calculation models + def GetCalculationModels(self) -> List[Calculation+CalculationModel]: + ... + + + # Retrieves the list of DVH Estimation Model structures + def GetDvhEstimationModelStructures(self, modelId: Guid) -> List[DVHEstimationModelStructure]: + """ + Args: + modelId: Model ID. + """ + ... + + + # List of DVH Estimation Model summaries. + def GetDvhEstimationModelSummaries(self) -> List[DVHEstimationModelSummary]: + ... + + + +class Catheter: + """ + Represents a brachytherapy catheter or an applicator channel centerline. Catheters are associated with a + + Attributes: + ApplicatorLength (float): The total length from the tip of the catheter to the treatment unit in millimeters. + BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): A collection of brachy field reference points. + BrachySolidApplicatorPartID (int): The unique identifier of the + ChannelNumber (int): The channel number of this catheter. + Color (Windows.Media.Color): The color of the catheter in 2D views. + DeadSpaceLength (float): The total length from the tip of the catheter to the start of the inner lumen in millimeters. + FirstSourcePosition (float): The first source position in millimeters in this catheter. This is the source position closest to the tip of the catheter. + GroupNumber (int): Catheter Group number. + LastSourcePosition (float): The last source position in millimeters in this catheter. This is the source position furthest away from the tip of the catheter. + Shape (Array[VVector]): The DICOM coordinates of the applicator shape starting from the tip. + SourcePositions (List[SourcePosition]): The source positions in the catheter starting from the tip. + StepSize (float): The step size of the catheter in millimeters. + TreatmentUnit (BrachyTreatmentUnit): The brachytherapy treatment unit associated with this catheter. + ApplicatorLength (float): The total length from the tip of the catheter to the treatment unit in millimeters. + BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): A collection of brachy field reference points. + BrachySolidApplicatorPartID (int): The unique identifier of the + ChannelNumber (int): The channel number of this catheter. + Color (Windows.Media.Color): The color of the catheter in 2D views. + DeadSpaceLength (float): The total length from the tip of the catheter to the start of the inner lumen in millimeters. + FirstSourcePosition (float): The first source position in millimeters in this catheter. This is the source position closest to the tip of the catheter. + GroupNumber (int): Catheter Group number. + LastSourcePosition (float): The last source position in millimeters in this catheter. This is the source position furthest away from the tip of the catheter. + Shape (Array[VVector]): The DICOM coordinates of the applicator shape starting from the tip. + SourcePositions (List[SourcePosition]): The source positions in the catheter starting from the tip. + StepSize (float): The step size of the catheter in millimeters. + TreatmentUnit (BrachyTreatmentUnit): The brachytherapy treatment unit associated with this catheter. + """ + def __init__(self) -> None: ... + + ApplicatorLength: float + + BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] + + BrachySolidApplicatorPartID: int + + ChannelNumber: int + + Color: Windows.Media.Color + + DeadSpaceLength: float + + FirstSourcePosition: float + + GroupNumber: int + + LastSourcePosition: float + + Shape: Array[VVector] + + SourcePositions: List[SourcePosition] + + StepSize: float + + TreatmentUnit: BrachyTreatmentUnit + + ApplicatorLength: float + + BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] + + BrachySolidApplicatorPartID: int + + ChannelNumber: int + + Color: Windows.Media.Color + + DeadSpaceLength: float + + FirstSourcePosition: float + + GroupNumber: int + + LastSourcePosition: float + + Shape: Array[VVector] + + SourcePositions: List[SourcePosition] + + StepSize: float + + TreatmentUnit: BrachyTreatmentUnit + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # The distance (in millimeters) from the tip of the catheter (in the first possible source position) to the center of the source position. This is an offset from the actual catheter inner lumen tip by half of the source length and encapsulation. + def GetSourcePosCenterDistanceFromTip(self, sourcePosition: SourcePosition) -> float: + """ + Args: + sourcePosition: The source position for which the distance from the catheter tip is got. + """ + ... + + + # The total dwell time in this catheter in seconds. + def GetTotalDwellTime(self) -> float: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Link reference line to applicator. + def LinkRefLine(self, refLine: Structure) -> None: + """ + Args: + refLine: Reference line to link with applicator. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Link reference point to applicator. + def LinkRefPoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to link with applicator. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the ID of the applicator. + def SetId(self, id: str, message: str) -> bool: + """ + Args: + id: The new ID for the applicator. + message: May be populated with a reason why setting the ID failed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the step size, first source position, and last source position, and resets the source positions of the catheter. + def SetSourcePositions(self, stepSize: float, firstSourcePosition: float, lastSourcePosition: float) -> SetSourcePositionsResult: + """ + Args: + stepSize: Step size in millimeters. + firstSourcePosition: First source position in millimeters. + lastSourcePosition: Last source position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference line from applicator. + def UnlinkRefLine(self, refLine: Structure) -> None: + """ + Args: + refLine: Reference line to unlink from applicator + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference point from applicator. + def UnlinkRefPoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to unlink from applicator + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # The distance (in millimeters) from the tip of the catheter (in the first possible source position) to the center of the source position. This is an offset from the actual catheter inner lumen tip by half of the source length and encapsulation. + def GetSourcePosCenterDistanceFromTip(self, sourcePosition: SourcePosition) -> float: + """ + Args: + sourcePosition: The source position for which the distance from the catheter tip is got. + """ + ... + + + # The total dwell time in this catheter in seconds. + def GetTotalDwellTime(self) -> float: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Link reference line to applicator. + def LinkRefLine(self, refLine: Structure) -> None: + """ + Args: + refLine: Reference line to link with applicator. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Link reference point to applicator. + def LinkRefPoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to link with applicator. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the ID of the applicator. + def SetId(self, id: str, message: str) -> bool: + """ + Args: + id: The new ID for the applicator. + message: May be populated with a reason why setting the ID failed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the step size, first source position, and last source position, and resets the source positions of the catheter. + def SetSourcePositions(self, stepSize: float, firstSourcePosition: float, lastSourcePosition: float) -> SetSourcePositionsResult: + """ + Args: + stepSize: Step size in millimeters. + firstSourcePosition: First source position in millimeters. + lastSourcePosition: Last source position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference line from applicator. + def UnlinkRefLine(self, refLine: Structure) -> None: + """ + Args: + refLine: Reference line to unlink from applicator + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference point from applicator. + def UnlinkRefPoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to unlink from applicator + """ + ... + + + +class ControlPointParameters: + """ + An editable copy of the parameters of a control point. + + Attributes: + CollimatorAngle (float): A copy of the collimator angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. + JawPositions (VRect[float]): A copy of the jaw positions of the treatment beams at this control point in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + LeafPositions (Array[float]): A copy of the positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If no MLC exists, a (0,0)-length array is returned. + PatientSupportAngle (float): A copy of the patient support angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. + GantryAngle (float): A copy of the gantry angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + MetersetWeight (float): A copy of the cumulative meterset weight to this control point. + CollimatorAngle (float): A copy of the collimator angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. + JawPositions (VRect[float]): A copy of the jaw positions of the treatment beams at this control point in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + LeafPositions (Array[float]): A copy of the positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If no MLC exists, a (0,0)-length array is returned. + PatientSupportAngle (float): A copy of the patient support angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. + GantryAngle (float): A copy of the gantry angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + MetersetWeight (float): A copy of the cumulative meterset weight to this control point. + + Note: + To apply the parameters, call the ApplyParameters method of the Beam class. Because the parameters are simple copies, they do not reflect the current state of the data model. + """ + def __init__(self) -> None: ... + + CollimatorAngle: float + + Index: int + + JawPositions: VRect[float] + + LeafPositions: Array[float] + + PatientSupportAngle: float + + TableTopLateralPosition: float + + TableTopLongitudinalPosition: float + + TableTopVerticalPosition: float + + GantryAngle: float + + MetersetWeight: float + + CollimatorAngle: float + + Index: int + + JawPositions: VRect[float] + + LeafPositions: Array[float] + + PatientSupportAngle: float + + TableTopLateralPosition: float + + TableTopLongitudinalPosition: float + + TableTopVerticalPosition: float + + GantryAngle: float + + MetersetWeight: float + + +class AsyncPump: + """ + Provides a pump that supports running asynchronous methods on the current thread. + """ + def __init__(self) -> None: ... + + # Helper for executing an async (Task-returning) function on a single thread. This can be used in cases where calling Wait() or Result on the Task would cause a deadlock, i.e., when the async part of the Task-returning function cannot be executed purely on a background thread. Exceptions thrown by the async function are re-thrown. If the exception is an + def RunAsyncOnCurrentThread(self, asynchronousFunction: Func[Task[T]]) -> Any: + """ + Args: + asynchronousFunction: The async function to be executed + """ + ... + + + # Helper for executing an async (Task-returning) function on a single thread. This can be used in cases where calling Wait() or Result on the Task would cause a deadlock, i.e., when the async part of the Task-returning function cannot be executed purely on a background thread. Exceptions thrown by the async function are re-thrown. If the exception is an + def RunAsyncOnCurrentThread(self, asynchronousFunction: Func[Task[T]]) -> Any: + """ + Args: + asynchronousFunction: The async function to be executed + """ + ... + + + +class Beam: + """ + Represents one beam (also referred to as "field") of an external beam treatment plan. See the definition of DICOM RT Beam for more details. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Beam. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Beam. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] The Beam comment. + Meterset (MetersetValue): The meterset value of the beam. + BeamNumber (int): DICOM RT Beam Number. The value is unique within the plan in which it is created. + Applicator (Applicator): An applicator is a specific add-on used in the beam. + ArcLength (float): The arc length. + AreControlPointJawsMoving (bool): Checks if jaws are moving. + AverageSSD (float): The average Source-to-Skin Distance (SSD) of an arc beam. + BeamTechnique (BeamTechnique): Returns an enumeration that describes the type of the treatment field. + Blocks (List[Block]): A collection of installed blocks. + Boluses (List[Bolus]): A collection of beam boluses. + CalculationLogs (List[BeamCalculationLog]): A collection of beam calculation logs. + CollimatorRotation (float): Collimator rotation + Compensator (Compensator): The compensator. + ControlPoints (ControlPointCollection): An enumerable sequence of machine parameters that describe the planned treatment beam. + CreationDateTime (Optional[datetime]): The date when this object was created. + Dose (BeamDose): The dose for the beam. Returns null if the dose is not calculated. + DoseRate (int): The dose rate of the treatment machine in MU/min. + DosimetricLeafGap (float): The dosimetric leaf gap that has been configured for the Dynamic Multileaf Collimator (DMLC) beams in the system. The dosimetric leaf gap is used for accounting for dose transmission through rounded MLC leaves. + EnergyMode (EnergyMode): Energy mode of the treatment machine. + EnergyModeDisplayName (str): The display name of the energy mode. For example '18E' or '6X-SRS'. + FieldReferencePoints (List[FieldReferencePoint]): A collection of field reference points. + GantryDirection (GantryDirection): The gantry rotation direction: clockwise (CW), counterclockwise (CCW), or none. + HasAllMLCLeavesClosed (bool): Returns true if all MLC leaves are closed. + IsGantryExtended (bool): Checks if the gantry rotation is extended. For arc beams, checks if the gantry rotation is extended at the start angle. + IsGantryExtendedAtStopAngle (bool): Checks if the gantry rotation is extended at the stop angle of an arc beam. + IsImagingTreatmentField (bool): Checks if a beam is an Imaging Treatment Beam, i.e., a beam that is used to take an MV image and whose dose is calculated and taken into account in treatment planning. + IsIMRT (bool): Checks if a beam is IMRT. + IsocenterPosition (VVector): The position of the isocenter. + IsSetupField (bool): Checks if a beam is a setup field. + MetersetPerGy (float): The calculated meterset/Gy value for the beam. + MLC (MLC): Returns a hardware description of the Multileaf Collimator (MLC) used in an MLC plan, or null if no MLC exists. + MLCPlanType (MLCPlanType): The type of the Multileaf Collimator (MLC) plan. + MLCTransmissionFactor (float): The transmission factor of the Multileaf Collimator (MLC) material. + MotionCompensationTechnique (str): DICOM (respiratory) motion compensation technique. Returns an empty string if motion compensation technique is not used. + MotionSignalSource (str): DICOM (respiratory) signal source. Returns an empty string if motion compensation technique is not used. + NormalizationFactor (float): The beam normalization factor. + NormalizationMethod (str): The beam normalization method. + Plan (PlanSetup): Used for navigating to parent Plan + PlannedSSD (float): The Source-to-Skin Distance (SSD) value defined by the user. + ReferenceImage (Image): The reference image of the beam. + SetupNote (str): The setup note of the field. + SetupTechnique (SetupTechnique): The setup technique. + SSD (float): The Source-to-Skin Distance (SSD). For arc beams, the SSD at the start angle. This value is calculated from the geometrical setup of the beam. + SSDAtStopAngle (float): The Source-to-Skin Distance (SSD) at the stop angle of an arc beam. This value is calculated from the geometrical setup of the beam. + Technique (Technique): The technique used in the planning beam. + ToleranceTableLabel (str): User-defined label for the referenced tolerance table, or an empty string if there is no reference to a tolerance table. + Trays (List[Tray]): A collection of installed trays. + TreatmentTime (float): The treatment time set for the beam in seconds. Plan Approval wizard sets this value by default. + TreatmentUnit (ExternalBeamTreatmentUnit): The external beam treatment unit associated with this beam. + Wedges (List[Wedge]): A collection of installed wedges. + WeightFactor (float): The weight factor of the beam. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Beam. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Beam. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] The Beam comment. + Meterset (MetersetValue): The meterset value of the beam. + BeamNumber (int): DICOM RT Beam Number. The value is unique within the plan in which it is created. + Applicator (Applicator): An applicator is a specific add-on used in the beam. + ArcLength (float): The arc length. + AreControlPointJawsMoving (bool): Checks if jaws are moving. + AverageSSD (float): The average Source-to-Skin Distance (SSD) of an arc beam. + BeamTechnique (BeamTechnique): Returns an enumeration that describes the type of the treatment field. + Blocks (List[Block]): A collection of installed blocks. + Boluses (List[Bolus]): A collection of beam boluses. + CalculationLogs (List[BeamCalculationLog]): A collection of beam calculation logs. + CollimatorRotation (float): Collimator rotation + Compensator (Compensator): The compensator. + ControlPoints (ControlPointCollection): An enumerable sequence of machine parameters that describe the planned treatment beam. + CreationDateTime (Optional[datetime]): The date when this object was created. + Dose (BeamDose): The dose for the beam. Returns null if the dose is not calculated. + DoseRate (int): The dose rate of the treatment machine in MU/min. + DosimetricLeafGap (float): The dosimetric leaf gap that has been configured for the Dynamic Multileaf Collimator (DMLC) beams in the system. The dosimetric leaf gap is used for accounting for dose transmission through rounded MLC leaves. + EnergyMode (EnergyMode): Energy mode of the treatment machine. + EnergyModeDisplayName (str): The display name of the energy mode. For example '18E' or '6X-SRS'. + FieldReferencePoints (List[FieldReferencePoint]): A collection of field reference points. + GantryDirection (GantryDirection): The gantry rotation direction: clockwise (CW), counterclockwise (CCW), or none. + HasAllMLCLeavesClosed (bool): Returns true if all MLC leaves are closed. + IsGantryExtended (bool): Checks if the gantry rotation is extended. For arc beams, checks if the gantry rotation is extended at the start angle. + IsGantryExtendedAtStopAngle (bool): Checks if the gantry rotation is extended at the stop angle of an arc beam. + IsImagingTreatmentField (bool): Checks if a beam is an Imaging Treatment Beam, i.e., a beam that is used to take an MV image and whose dose is calculated and taken into account in treatment planning. + IsIMRT (bool): Checks if a beam is IMRT. + IsocenterPosition (VVector): The position of the isocenter. + IsSetupField (bool): Checks if a beam is a setup field. + MetersetPerGy (float): The calculated meterset/Gy value for the beam. + MLC (MLC): Returns a hardware description of the Multileaf Collimator (MLC) used in an MLC plan, or null if no MLC exists. + MLCPlanType (MLCPlanType): The type of the Multileaf Collimator (MLC) plan. + MLCTransmissionFactor (float): The transmission factor of the Multileaf Collimator (MLC) material. + MotionCompensationTechnique (str): DICOM (respiratory) motion compensation technique. Returns an empty string if motion compensation technique is not used. + MotionSignalSource (str): DICOM (respiratory) signal source. Returns an empty string if motion compensation technique is not used. + NormalizationFactor (float): The beam normalization factor. + NormalizationMethod (str): The beam normalization method. + Plan (PlanSetup): Used for navigating to parent Plan + PlannedSSD (float): The Source-to-Skin Distance (SSD) value defined by the user. + ReferenceImage (Image): The reference image of the beam. + SetupNote (str): The setup note of the field. + SetupTechnique (SetupTechnique): The setup technique. + SSD (float): The Source-to-Skin Distance (SSD). For arc beams, the SSD at the start angle. This value is calculated from the geometrical setup of the beam. + SSDAtStopAngle (float): The Source-to-Skin Distance (SSD) at the stop angle of an arc beam. This value is calculated from the geometrical setup of the beam. + Technique (Technique): The technique used in the planning beam. + ToleranceTableLabel (str): User-defined label for the referenced tolerance table, or an empty string if there is no reference to a tolerance table. + Trays (List[Tray]): A collection of installed trays. + TreatmentTime (float): The treatment time set for the beam in seconds. Plan Approval wizard sets this value by default. + TreatmentUnit (ExternalBeamTreatmentUnit): The external beam treatment unit associated with this beam. + Wedges (List[Wedge]): A collection of installed wedges. + WeightFactor (float): The weight factor of the beam. + """ + def __init__(self) -> None: ... + + Id: str + + Name: str + + Comment: str + + Meterset: MetersetValue + + BeamNumber: int + + Applicator: Applicator + + ArcLength: float + + AreControlPointJawsMoving: bool + + AverageSSD: float + + BeamTechnique: BeamTechnique + + Blocks: List[Block] + + Boluses: List[Bolus] + + CalculationLogs: List[BeamCalculationLog] + + CollimatorRotation: float + + Compensator: Compensator + + ControlPoints: ControlPointCollection + + CreationDateTime: Optional[datetime] + + Dose: BeamDose + + DoseRate: int + + DosimetricLeafGap: float + + EnergyMode: EnergyMode + + EnergyModeDisplayName: str + + FieldReferencePoints: List[FieldReferencePoint] + + GantryDirection: GantryDirection + + HasAllMLCLeavesClosed: bool + + IsGantryExtended: bool + + IsGantryExtendedAtStopAngle: bool + + IsImagingTreatmentField: bool + + IsIMRT: bool + + IsocenterPosition: VVector + + IsSetupField: bool + + MetersetPerGy: float + + MLC: MLC + + MLCPlanType: MLCPlanType + + MLCTransmissionFactor: float + + MotionCompensationTechnique: str + + MotionSignalSource: str + + NormalizationFactor: float + + NormalizationMethod: str + + Plan: PlanSetup + + PlannedSSD: float + + ReferenceImage: Image + + SetupNote: str + + SetupTechnique: SetupTechnique + + SSD: float + + SSDAtStopAngle: float + + Technique: Technique + + ToleranceTableLabel: str + + Trays: List[Tray] + + TreatmentTime: float + + TreatmentUnit: ExternalBeamTreatmentUnit + + Wedges: List[Wedge] + + WeightFactor: float + + Id: str + + Name: str + + Comment: str + + Meterset: MetersetValue + + BeamNumber: int + + Applicator: Applicator + + ArcLength: float + + AreControlPointJawsMoving: bool + + AverageSSD: float + + BeamTechnique: BeamTechnique + + Blocks: List[Block] + + Boluses: List[Bolus] + + CalculationLogs: List[BeamCalculationLog] + + CollimatorRotation: float + + Compensator: Compensator + + ControlPoints: ControlPointCollection + + CreationDateTime: Optional[datetime] + + Dose: BeamDose + + DoseRate: int + + DosimetricLeafGap: float + + EnergyMode: EnergyMode + + EnergyModeDisplayName: str + + FieldReferencePoints: List[FieldReferencePoint] + + GantryDirection: GantryDirection + + HasAllMLCLeavesClosed: bool + + IsGantryExtended: bool + + IsGantryExtendedAtStopAngle: bool + + IsImagingTreatmentField: bool + + IsIMRT: bool + + IsocenterPosition: VVector + + IsSetupField: bool + + MetersetPerGy: float + + MLC: MLC + + MLCPlanType: MLCPlanType + + MLCTransmissionFactor: float + + MotionCompensationTechnique: str + + MotionSignalSource: str + + NormalizationFactor: float + + NormalizationMethod: str + + Plan: PlanSetup + + PlannedSSD: float + + ReferenceImage: Image + + SetupNote: str + + SetupTechnique: SetupTechnique + + SSD: float + + SSDAtStopAngle: float + + Technique: Technique + + ToleranceTableLabel: str + + Trays: List[Tray] + + TreatmentTime: float + + TreatmentUnit: ExternalBeamTreatmentUnit + + Wedges: List[Wedge] + + WeightFactor: float + + # [Availability of this property depends on your Eclipse Scripting API license] Adds a link to bolus. + def AddBolus(self, bolus: Bolus) -> None: + """ + Args: + bolus: The bolus to add. + """ + ... + + + # [Availability of this property depends on your Eclipse Scripting API license] Removes the link to bolus. + def RemoveBolus(self, bolus: Bolus) -> bool: + """ + Args: + bolus: The bolus to remove from the beam. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a link to bolus. + def AddBolus(self, bolusId: str) -> None: + """ + Args: + bolusId: The ID of the bolus to add. The bolus structure must exist in the plan's structure set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a flattening sequence to a static Halcyon field. Throws an exception if the field is not a Halcyon field. + def AddFlatteningSequence(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Modifies the beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. + def ApplyParameters(self, beamParams: BeamParameters) -> None: + """ + Args: + beamParams: The parameters to apply to the beam. + """ + ... + + + # Calculate and get Average Leaf Pair Opening values. ALPO values are calculated on the fly (not serialized). Returns a Dictionary. Key element is the index of carriage group in the field and value element is the ALPO value for that carriage group. + def CalculateAverageLeafPairOpenings(self) -> Dict[int, float]: + ... + + + # Checks if optimal fluence can be set for this beam. + def CanSetOptimalFluence(self, fluence: Fluence, message: str) -> bool: + """ + Args: + fluence: The optimal fluence for the beam. + message: If the optimal fluence cannot be set, contains information about the reason. + """ + ... + + + # Converts the given collimator angle value from the internal IEC scale to the user facing scale of the machine. + def CollimatorAngleToUser(self, val: float) -> float: + """ + Args: + val: Collimator angle value + """ + ... + + + # Counts and returns Subfield count. + def CountSubfields(self) -> int: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the DRR. + def CreateOrReplaceDRR(self, parameters: DRRCalculationParameters) -> Image: + """ + Args: + parameters: DRR calculation parameters + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the collimator to the specified structure + def FitCollimatorToStructure(self, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) -> None: + """ + Args: + margins: Margins used to fit to structure + structure: Structure to fit to + useAsymmetricXJaws: Flag of using asymmetric x jaws + useAsymmetricYJaws: Flag of uisng asymmetric y jaws + optimizeCollimatorRotation: Flag of optimizing collimator angles as fitting result + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with default settings, or with settings from previous fit. + def FitMLCToOutline(self, outline: Array[Array[Windows.Point]]) -> None: + """ + Args: + outline: The shape to fit the MLC leaves to, for example, Block.Outline. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with specified options. + def FitMLCToOutline(self, outline: Array[Array[Windows.Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """ + Args: + outline: The shape to fit the MLC leaves to, for example, Block.Outline. + optimizeCollimatorRotation: Specifies if the MLC rotation is optimized. + jawFit: Controls whether the collimator jaws are positioned to match the MLC outline and how it is done. + olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). + clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves in the beam to a structure with the default settings, or with settings from the previous fit. The margin is zero. + def FitMLCToStructure(self, structure: Structure) -> None: + """ + Args: + structure: The structure to fit the MLC leaves to. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a structure projection on the isocenter plane with the specified margin. + def FitMLCToStructure(self, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """ + Args: + margins: Specifies the margin in all directions. + structure: The structure to fit the MLC leaves to. + optimizeCollimatorRotation: Specify if the MLC rotation is optimized. + jawFit: Controls whether and how the collimator jaws are positioned to match the MLC outline. + olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). + clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). + """ + ... + + + # Converts the given gantry rotation value from the internal IEC scale to the user facing scale of the machine. + def GantryAngleToUser(self, val: float) -> float: + """ + Args: + val: Gantry rotation value + """ + ... + + + # CAX path length in bolus is calculated along the vector spanning from radiation source to first skin contact (as defined by SSD). + def GetCAXPathLengthInBolus(self, bolus: Bolus) -> float: + ... + + + # Returns an editable copy of the beam parameters. The returned BeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another BeamParameters object. + def GetEditableParameters(self) -> BeamParameters: + ... + + + # Gets the optimal fluence for this beam. Returns null if optimal fluence does not exist. + def GetOptimalFluence(self) -> Fluence: + ... + + + # Returns the location of the radiation source at a given gantry angle of the beam. + def GetSourceLocation(self, gantryAngle: float) -> VVector: + """ + Args: + gantryAngle: Gantry angle + """ + ... + + + # Calculates Source To Bolus distance in mm. + def GetSourceToBolusDistance(self, bolus: Bolus) -> float: + ... + + + # If the structure has a segment, gets the outline of the structure on the isocenter plane of the beam. + def GetStructureOutlines(self, structure: Structure, inBEV: bool) -> Array[Array[Windows.Point]]: + """ + Args: + structure: The structure to be projected to the isocenter plane. + inBEV: If true, outlines are returned in the Beams Eye View (BEV) coordinates, where the collimator angle is 0.0 degrees. If false, outlines are returned in beam coordinates. Suitable for use with FitMLCToOutline(...). + """ + ... + + + # Converts the given jaw positions from the internal IEC scale to a string in the user facing scale of the machine. + def JawPositionsToUserString(self, val: VRect[float]) -> str: + """ + Args: + val: Jaw postitions + """ + ... + + + # Converts the given patient support angle value from the internal IEC scale to the user facing scale of the machine. + def PatientSupportAngleToUser(self, val: float) -> float: + """ + Args: + val: Patient support angle value + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the link to bolus. + def RemoveBolus(self, bolusId: str) -> bool: + """ + Args: + bolusId: The ID of the bolus to remove from the beam. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the flattening sequence from a Halcyon field. Throws an exception if the field is not a Halcyon field. + def RemoveFlatteningSequence(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the optimal fluence for this beam. If the fluence is empty (the fluence is null or the dimensions of the fluence matrix are zero) an ArgumentException will be thrown. Setting the optimal fluence for the beam does not clear DVH Estimations of the plan. + def SetOptimalFluence(self, fluence: Fluence) -> None: + """ + Args: + fluence: The optimal fluence to be set. + """ + ... + + + # [Availability of this property depends on your Eclipse Scripting API license] Adds a link to bolus. + def AddBolus(self, bolus: Bolus) -> None: + """ + Args: + bolus: The bolus to add. + """ + ... + + + # [Availability of this property depends on your Eclipse Scripting API license] Removes the link to bolus. + def RemoveBolus(self, bolus: Bolus) -> bool: + """ + Args: + bolus: The bolus to remove from the beam. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a link to bolus. + def AddBolus(self, bolusId: str) -> None: + """ + Args: + bolusId: The ID of the bolus to add. The bolus structure must exist in the plan's structure set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a flattening sequence to a static Halcyon field. Throws an exception if the field is not a Halcyon field. + def AddFlatteningSequence(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Modifies the beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. + def ApplyParameters(self, beamParams: BeamParameters) -> None: + """ + Args: + beamParams: The parameters to apply to the beam. + """ + ... + + + # Calculate and get Average Leaf Pair Opening values. ALPO values are calculated on the fly (not serialized). Returns a Dictionary. Key element is the index of carriage group in the field and value element is the ALPO value for that carriage group. + def CalculateAverageLeafPairOpenings(self) -> Dict[int, float]: + ... + + + # Checks if optimal fluence can be set for this beam. + def CanSetOptimalFluence(self, fluence: Fluence, message: str) -> bool: + """ + Args: + fluence: The optimal fluence for the beam. + message: If the optimal fluence cannot be set, contains information about the reason. + """ + ... + + + # Converts the given collimator angle value from the internal IEC scale to the user facing scale of the machine. + def CollimatorAngleToUser(self, val: float) -> float: + """ + Args: + val: Collimator angle value + """ + ... + + + # Counts and returns Subfield count. + def CountSubfields(self) -> int: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the DRR. + def CreateOrReplaceDRR(self, parameters: DRRCalculationParameters) -> Image: + """ + Args: + parameters: DRR calculation parameters + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the collimator to the specified structure + def FitCollimatorToStructure(self, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) -> None: + """ + Args: + margins: Margins used to fit to structure + structure: Structure to fit to + useAsymmetricXJaws: Flag of using asymmetric x jaws + useAsymmetricYJaws: Flag of uisng asymmetric y jaws + optimizeCollimatorRotation: Flag of optimizing collimator angles as fitting result + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with default settings, or with settings from previous fit. + def FitMLCToOutline(self, outline: Array[Array[Windows.Point]]) -> None: + """ + Args: + outline: The shape to fit the MLC leaves to, for example, Block.Outline. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with specified options. + def FitMLCToOutline(self, outline: Array[Array[Windows.Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """ + Args: + outline: The shape to fit the MLC leaves to, for example, Block.Outline. + optimizeCollimatorRotation: Specifies if the MLC rotation is optimized. + jawFit: Controls whether the collimator jaws are positioned to match the MLC outline and how it is done. + olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). + clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves in the beam to a structure with the default settings, or with settings from the previous fit. The margin is zero. + def FitMLCToStructure(self, structure: Structure) -> None: + """ + Args: + structure: The structure to fit the MLC leaves to. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a structure projection on the isocenter plane with the specified margin. + def FitMLCToStructure(self, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """ + Args: + margins: Specifies the margin in all directions. + structure: The structure to fit the MLC leaves to. + optimizeCollimatorRotation: Specify if the MLC rotation is optimized. + jawFit: Controls whether and how the collimator jaws are positioned to match the MLC outline. + olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). + clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). + """ + ... + + + # Converts the given gantry rotation value from the internal IEC scale to the user facing scale of the machine. + def GantryAngleToUser(self, val: float) -> float: + """ + Args: + val: Gantry rotation value + """ + ... + + + # CAX path length in bolus is calculated along the vector spanning from radiation source to first skin contact (as defined by SSD). + def GetCAXPathLengthInBolus(self, bolus: Bolus) -> float: + ... + + + # Returns an editable copy of the beam parameters. The returned BeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another BeamParameters object. + def GetEditableParameters(self) -> BeamParameters: + ... + + + # Gets the optimal fluence for this beam. Returns null if optimal fluence does not exist. + def GetOptimalFluence(self) -> Fluence: + ... + + + # Returns the location of the radiation source at a given gantry angle of the beam. + def GetSourceLocation(self, gantryAngle: float) -> VVector: + """ + Args: + gantryAngle: Gantry angle + """ + ... + + + # Calculates Source To Bolus distance in mm. + def GetSourceToBolusDistance(self, bolus: Bolus) -> float: + ... + + + # If the structure has a segment, gets the outline of the structure on the isocenter plane of the beam. + def GetStructureOutlines(self, structure: Structure, inBEV: bool) -> Array[Array[Windows.Point]]: + """ + Args: + structure: The structure to be projected to the isocenter plane. + inBEV: If true, outlines are returned in the Beams Eye View (BEV) coordinates, where the collimator angle is 0.0 degrees. If false, outlines are returned in beam coordinates. Suitable for use with FitMLCToOutline(...). + """ + ... + + + # Converts the given jaw positions from the internal IEC scale to a string in the user facing scale of the machine. + def JawPositionsToUserString(self, val: VRect[float]) -> str: + """ + Args: + val: Jaw postitions + """ + ... + + + # Converts the given patient support angle value from the internal IEC scale to the user facing scale of the machine. + def PatientSupportAngleToUser(self, val: float) -> float: + """ + Args: + val: Patient support angle value + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the link to bolus. + def RemoveBolus(self, bolusId: str) -> bool: + """ + Args: + bolusId: The ID of the bolus to remove from the beam. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the flattening sequence from a Halcyon field. Throws an exception if the field is not a Halcyon field. + def RemoveFlatteningSequence(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the optimal fluence for this beam. If the fluence is empty (the fluence is null or the dimensions of the fluence matrix are zero) an ArgumentException will be thrown. Setting the optimal fluence for the beam does not clear DVH Estimations of the plan. + def SetOptimalFluence(self, fluence: Fluence) -> None: + """ + Args: + fluence: The optimal fluence to be set. + """ + ... + + + +class Course: + """ + A course represents the course of treatment that a patient will be given. Every patient must have a course, and all plans always belong to a course. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Course. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Course. + ExternalPlanSetups (List[ExternalPlanSetup]): A collection of external beam plans for the course. + BrachyPlanSetups (List[BrachyPlanSetup]): A collection of brachytherapy plans for the course. + IonPlanSetups (List[IonPlanSetup]): A collection of proton plans for the course. + ClinicalStatus (CourseClinicalStatus): Clinical Status of Course. + CompletedDateTime (Optional[datetime]): The date and time when the course was completed. + Diagnoses (List[Diagnosis]): The diagnoses that are attached to the course. + Intent (str): The intent of the course. + Patient (Patient): Patient in which the course is defined. + PlanSetups (List[PlanSetup]): A collection of plans for the course. The plans can be of any type (external beam or brachytherapy). + PlanSums (List[PlanSum]): A collection of plan sums for the course. + StartDateTime (Optional[datetime]): The date and time when the course was started. + TreatmentPhases (List[TreatmentPhase]): All treatment phases in the course. + TreatmentSessions (List[TreatmentSession]): Treatment sessions of the course. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Course. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Course. + ExternalPlanSetups (List[ExternalPlanSetup]): A collection of external beam plans for the course. + BrachyPlanSetups (List[BrachyPlanSetup]): A collection of brachytherapy plans for the course. + IonPlanSetups (List[IonPlanSetup]): A collection of proton plans for the course. + ClinicalStatus (CourseClinicalStatus): Clinical Status of Course. + CompletedDateTime (Optional[datetime]): The date and time when the course was completed. + Diagnoses (List[Diagnosis]): The diagnoses that are attached to the course. + Intent (str): The intent of the course. + Patient (Patient): Patient in which the course is defined. + PlanSetups (List[PlanSetup]): A collection of plans for the course. The plans can be of any type (external beam or brachytherapy). + PlanSums (List[PlanSum]): A collection of plan sums for the course. + StartDateTime (Optional[datetime]): The date and time when the course was started. + TreatmentPhases (List[TreatmentPhase]): All treatment phases in the course. + TreatmentSessions (List[TreatmentSession]): Treatment sessions of the course. + """ + def __init__(self) -> None: ... + + Id: str + + Comment: str + + ExternalPlanSetups: List[ExternalPlanSetup] + + BrachyPlanSetups: List[BrachyPlanSetup] + + IonPlanSetups: List[IonPlanSetup] + + ClinicalStatus: CourseClinicalStatus + + CompletedDateTime: Optional[datetime] + + Diagnoses: List[Diagnosis] + + Intent: str + + Patient: Patient + + PlanSetups: List[PlanSetup] + + PlanSums: List[PlanSum] + + StartDateTime: Optional[datetime] + + TreatmentPhases: List[TreatmentPhase] + + TreatmentSessions: List[TreatmentSession] + + Id: str + + Comment: str + + ExternalPlanSetups: List[ExternalPlanSetup] + + BrachyPlanSetups: List[BrachyPlanSetup] + + IonPlanSetups: List[IonPlanSetup] + + ClinicalStatus: CourseClinicalStatus + + CompletedDateTime: Optional[datetime] + + Diagnoses: List[Diagnosis] + + Intent: str + + Patient: Patient + + PlanSetups: List[PlanSetup] + + PlanSums: List[PlanSum] + + StartDateTime: Optional[datetime] + + TreatmentPhases: List[TreatmentPhase] + + TreatmentSessions: List[TreatmentSession] + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan sum from given planning items. + def CreatePlanSum(self, planningItems: List[PlanningItem], image: Image) -> PlanSum: + """ + Args: + planningItems: Items to create sum from. All plans must share the same image, otherwise please use + image: Plan Sum image + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course with target, primary reference point and additional reference points in arguments + def AddExternalPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: List[ReferencePoint]) -> ExternalPlanSetup: + """ + Args: + structureSet: Valid StructureSet to connected with the plan + targetStructure: Target structure, if defined must be from 'structureSet', if left null target will remain unset. + primaryReferencePoint: Valid reference point to be connected as primary. + additionalReferencePoints: Collection of additional valid reference points + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course with the target structure, primary reference point and additional reference points specified in arguments. + def AddBrachyPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: DoseValue, dosePerFraction: BrachyTreatmentTechniqueType, brachyTreatmentTechnique: List[ReferencePoint]) -> BrachyPlanSetup: + """ + Args: + structureSet: Valid StructureSet to be connected to the plan + targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. + primaryReferencePoint: Valid reference point to be connected as primary reference point. + additionalReferencePoints: Collection of additional valid reference points + dosePerFraction: Dose per fraction + brachyTreatmentTechnique: Brachytherapy treatment technique + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. + def AddIonPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, patientSupportDeviceId: ReferencePoint, primaryReferencePoint: str, additionalReferencePoints: List[ReferencePoint]) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. + patientSupportDeviceId: Id of the patient support device. + primaryReferencePoint: Valid reference point to be connected as primary. + additionalReferencePoints: Collection of additional valid reference points + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course. A new primary reference point is always created for the new brachytherapy plan. + def AddBrachyPlanSetup(self, structureSet: StructureSet, dosePerFraction: DoseValue, brachyTreatmentTechnique: BrachyTreatmentTechniqueType) -> BrachyPlanSetup: + """ + Args: + structureSet: A valid StructureSet to be connected to the plan. + dosePerFraction: Dose per fraction + brachyTreatmentTechnique: Brachytherapy treatment technique + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course. A new primary reference point is always created for the new plan. + def AddExternalPlanSetup(self, structureSet: StructureSet) -> ExternalPlanSetup: + """ + Args: + structureSet: A valid structure set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the verified plan and a new plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. + def AddExternalPlanSetupAsVerificationPlan(self, structureSet: StructureSet, verifiedPlan: ExternalPlanSetup) -> ExternalPlanSetup: + """ + Args: + structureSet: A valid structure set. + verifiedPlan: The verified plan. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. + def AddIonPlanSetup(self, structureSet: StructureSet, patientSupportDeviceId: str) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + patientSupportDeviceId: Id of the patient support device. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the proton plan to be verified and the new verification plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. + def AddIonPlanSetupAsVerificationPlan(self, structureSet: StructureSet, patientSupportDeviceId: str, verifiedPlan: IonPlanSetup) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + patientSupportDeviceId: Id of the patient support device. + verifiedPlan: The verified plan. + """ + ... + + + # Checks if a new plan can be added to this course using the given structure set. + def CanAddPlanSetup(self, structureSet: StructureSet) -> bool: + """ + Args: + structureSet: The structure set used by the plan. + """ + ... + + + # Checks if the plan setup can be removed from this course. + def CanRemovePlanSetup(self, planSetup: PlanSetup) -> bool: + """ + Args: + planSetup: The plan setup to check. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan (the planning image will be the same for both plans). + def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: + """ + Args: + sourcePlan: Brachy plan to copy from + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with the primary image of the sourcePlan. First copies image and then changes planning image. + def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: + """ + Args: + sourcePlan: Brachy plan to copy from + structureset: The structure set along with its associated image that will be assigned to the copied plan + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan (the planning image will be the same for both plans). + def CopyPlanSetup(self, sourcePlan: PlanSetup) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. If there are multiple registrations, just copies isocenter locations and shows a message about this. + def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + targetImage: Image to copy plan to + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. + def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, registration: Registration, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + targetImage: Image to copy plan to + registration: Registration to use to map geometry from source to target + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. + def CopyPlanSetup(self, sourcePlan: PlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + structureset: The structure set along with its associated image that will be assigned to the copied plan + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # Checks if the clinical status of the course is completed or restored. + def IsCompleted(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan setup from the database. Use + def RemovePlanSetup(self, planSetup: PlanSetup) -> None: + """ + Args: + planSetup: The plan setup that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan sum from the database. The PlanSum object given as a parameter is not usable anymore after this operation. + def RemovePlanSum(self, planSum: PlanSum) -> None: + """ + Args: + planSum: The plan sum that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan sum from given planning items. + def CreatePlanSum(self, planningItems: List[PlanningItem], image: Image) -> PlanSum: + """ + Args: + planningItems: Items to create sum from. All plans must share the same image, otherwise please use + image: Plan Sum image + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course with target, primary reference point and additional reference points in arguments + def AddExternalPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: List[ReferencePoint]) -> ExternalPlanSetup: + """ + Args: + structureSet: Valid StructureSet to connected with the plan + targetStructure: Target structure, if defined must be from 'structureSet', if left null target will remain unset. + primaryReferencePoint: Valid reference point to be connected as primary. + additionalReferencePoints: Collection of additional valid reference points + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course with the target structure, primary reference point and additional reference points specified in arguments. + def AddBrachyPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: DoseValue, dosePerFraction: BrachyTreatmentTechniqueType, brachyTreatmentTechnique: List[ReferencePoint]) -> BrachyPlanSetup: + """ + Args: + structureSet: Valid StructureSet to be connected to the plan + targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. + primaryReferencePoint: Valid reference point to be connected as primary reference point. + additionalReferencePoints: Collection of additional valid reference points + dosePerFraction: Dose per fraction + brachyTreatmentTechnique: Brachytherapy treatment technique + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. + def AddIonPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, patientSupportDeviceId: ReferencePoint, primaryReferencePoint: str, additionalReferencePoints: List[ReferencePoint]) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. + patientSupportDeviceId: Id of the patient support device. + primaryReferencePoint: Valid reference point to be connected as primary. + additionalReferencePoints: Collection of additional valid reference points + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course. A new primary reference point is always created for the new brachytherapy plan. + def AddBrachyPlanSetup(self, structureSet: StructureSet, dosePerFraction: DoseValue, brachyTreatmentTechnique: BrachyTreatmentTechniqueType) -> BrachyPlanSetup: + """ + Args: + structureSet: A valid StructureSet to be connected to the plan. + dosePerFraction: Dose per fraction + brachyTreatmentTechnique: Brachytherapy treatment technique + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course. A new primary reference point is always created for the new plan. + def AddExternalPlanSetup(self, structureSet: StructureSet) -> ExternalPlanSetup: + """ + Args: + structureSet: A valid structure set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the verified plan and a new plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. + def AddExternalPlanSetupAsVerificationPlan(self, structureSet: StructureSet, verifiedPlan: ExternalPlanSetup) -> ExternalPlanSetup: + """ + Args: + structureSet: A valid structure set. + verifiedPlan: The verified plan. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. + def AddIonPlanSetup(self, structureSet: StructureSet, patientSupportDeviceId: str) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + patientSupportDeviceId: Id of the patient support device. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the proton plan to be verified and the new verification plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. + def AddIonPlanSetupAsVerificationPlan(self, structureSet: StructureSet, patientSupportDeviceId: str, verifiedPlan: IonPlanSetup) -> IonPlanSetup: + """ + Args: + structureSet: A valid structure set. + patientSupportDeviceId: Id of the patient support device. + verifiedPlan: The verified plan. + """ + ... + + + # Checks if a new plan can be added to this course using the given structure set. + def CanAddPlanSetup(self, structureSet: StructureSet) -> bool: + """ + Args: + structureSet: The structure set used by the plan. + """ + ... + + + # Checks if the plan setup can be removed from this course. + def CanRemovePlanSetup(self, planSetup: PlanSetup) -> bool: + """ + Args: + planSetup: The plan setup to check. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan (the planning image will be the same for both plans). + def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: + """ + Args: + sourcePlan: Brachy plan to copy from + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with the primary image of the sourcePlan. First copies image and then changes planning image. + def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: + """ + Args: + sourcePlan: Brachy plan to copy from + structureset: The structure set along with its associated image that will be assigned to the copied plan + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan (the planning image will be the same for both plans). + def CopyPlanSetup(self, sourcePlan: PlanSetup) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. If there are multiple registrations, just copies isocenter locations and shows a message about this. + def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + targetImage: Image to copy plan to + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. + def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, registration: Registration, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + targetImage: Image to copy plan to + registration: Registration to use to map geometry from source to target + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. + def CopyPlanSetup(self, sourcePlan: PlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> PlanSetup: + """ + Args: + sourcePlan: Plan to copy from + structureset: The structure set along with its associated image that will be assigned to the copied plan + outputDiagnostics: Information about copying, this needs to be shown to the user. + """ + ... + + + # Checks if the clinical status of the course is completed or restored. + def IsCompleted(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan setup from the database. Use + def RemovePlanSetup(self, planSetup: PlanSetup) -> None: + """ + Args: + planSetup: The plan setup that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan sum from the database. The PlanSum object given as a parameter is not usable anymore after this operation. + def RemovePlanSum(self, planSum: PlanSum) -> None: + """ + Args: + planSum: The plan sum that is removed. + """ + ... + + + +class CustomScriptExecutable: + """ + A factory class for creating an application object for a custom script executable. + """ + def __init__(self) -> None: ... + + # Creates an application object for a custom executable and logs it into the system. Application object created by this method can be used when the executable itself is not a script. For example, an interpreter of a high level programming language, or a native C++ application that integrates into .NET and uses ESAPI. The scripts executed with this application object are always read-only in a clinical environment, and writable in a non-clinical environment. + def CreateApplication(self, scriptName: str) -> Application: + """ + Args: + scriptName: The script name for logging in. Preferably use the full absolute path. + """ + ... + + + # Creates an application object for a custom executable and logs it into the system. Application object created by this method can be used when the executable itself is not a script. For example, an interpreter of a high level programming language, or a native C++ application that integrates into .NET and uses ESAPI. The scripts executed with this application object are always read-only in a clinical environment, and writable in a non-clinical environment. + def CreateApplication(self, scriptName: str) -> Application: + """ + Args: + scriptName: The script name for logging in. Preferably use the full absolute path. + """ + ... + + + +class IonPlanSetup: + """ + Represents a proton treatment plan. + + Attributes: + IsPostProcessingNeeded (bool): Instructs whether to include the post-processing of scanning spots in proton dose calculation. + CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. + DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by + IonBeams (List[IonBeam]): Gets the proton beams of the plan. + IsPostProcessingNeeded (bool): Instructs whether to include the post-processing of scanning spots in proton dose calculation. + CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. + DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by + IonBeams (List[IonBeam]): Gets the proton beams of the plan. + """ + def __init__(self) -> None: ... + + IsPostProcessingNeeded: bool + + CalculatePlanUncertaintyDose: bool + + DoseAsEvaluationDose: EvaluationDose + + IonBeams: List[IonBeam] + + IsPostProcessingNeeded: bool + + CalculatePlanUncertaintyDose: bool + + DoseAsEvaluationDose: EvaluationDose + + IonBeams: List[IonBeam] + + # [Availability of this property depends on your Eclipse Scripting API license] Creates a new proton verification plan that is a copy of this plan and that has dose calculated using the DECT proton stopping power values calculated based on the input images "rhoImage" and "zImage". + def CreateDectVerificationPlan(self, rhoImage: Image, zImage: Image) -> IonPlanSetup: + """ + Args: + rhoImage: A DECT relative electron density image where the value each voxel is interpreted as rho = 0.001 * (value + 1000). + zImage: A DECT effective atomic number image. + """ + ... + + + # This method is used to remove the temporary DECT objects under the DECT-study that was created for intermediate dose calculation. The method should be called only after the dose calculation is done, otherwise the intermediate dose is disposed too early. The temporary objects should be removed because they contain virtual CT images we do not want ending into the database. + def RemoveTemporaryObjects(self) -> Any: + ... + + + # Checks whether the proton volume dose calculation model attached to this plan is Proton Convolution Superposition. + def CheckDectCompatibleDoseCalcModel(self) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam line for the proton plan. + def CalculateBeamLine(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the proton plan. + def CalculateDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the proton plan. + def CalculatePlanUncertaintyDoses(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs IMPT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeIMPT(self, options: OptimizationOptionsIMPT) -> OptimizerResult: + """ + Args: + options: IMPT optimization options. + """ + ... + + + # Post-processes the proton plan by creating a final spot list, and calculates the dose. + def PostProcessAndCalculateDose(self) -> CalculationResult: + ... + + + # Calculates the dose for a proton plan without post-processing. The existing final spot list is used, and no new list is created during the calculation. + def CalculateDoseWithoutPostProcessing(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam delivery dynamics for the final spot list of a proton plan. + def CalculateBeamDeliveryDynamics(self) -> CalculationResult: + ... + + + # Returns a list of calculation models for the given calculation type. + def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new proton modulated scanning beam to the plan. + def AddModulatedScanningBeam(self, machineParameters: ProtonBeamMachineParameters, snoutId: str, snoutPosition: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See ExternalBeamMachineParameters. + snoutId: Snout ID. + snoutPosition: Snout position in centimeters. + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. + def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: + """ + Args: + existing: The dose matrix is copied from this object. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the + def CreateEvaluationDose(self) -> EvaluationDose: + ... + + + # Get information on whether the plan is optimized using multi-field optimization or single-field optimization. + def GetOptimizationMode(self) -> IonPlanOptimizationMode: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Set the plan normalization. See cref="PlanNormalizationMode" for the supported plan normalization methods. + def SetNormalization(self, normalizationParameters: IonPlanNormalizationParameters) -> None: + """ + Args: + normalizationParameters: Normalization parameters + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Set proton optimization to use either multi-field or single-field optimization. + def SetOptimizationMode(self, mode: IonPlanOptimizationMode) -> None: + """ + Args: + mode: Set the parameter to MultiFieldOptimization to use multi-field optimization and set to SingleFieldOptimization to use single-field optimization. + """ + ... + + + # [Availability of this property depends on your Eclipse Scripting API license] Creates a new proton verification plan that is a copy of this plan and that has dose calculated using the DECT proton stopping power values calculated based on the input images "rhoImage" and "zImage". + def CreateDectVerificationPlan(self, rhoImage: Image, zImage: Image) -> IonPlanSetup: + """ + Args: + rhoImage: A DECT relative electron density image where the value each voxel is interpreted as rho = 0.001 * (value + 1000). + zImage: A DECT effective atomic number image. + """ + ... + + + # This method is used to remove the temporary DECT objects under the DECT-study that was created for intermediate dose calculation. The method should be called only after the dose calculation is done, otherwise the intermediate dose is disposed too early. The temporary objects should be removed because they contain virtual CT images we do not want ending into the database. + def RemoveTemporaryObjects(self) -> Any: + ... + + + # Checks whether the proton volume dose calculation model attached to this plan is Proton Convolution Superposition. + def CheckDectCompatibleDoseCalcModel(self) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam line for the proton plan. + def CalculateBeamLine(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the proton plan. + def CalculateDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the proton plan. + def CalculatePlanUncertaintyDoses(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs IMPT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeIMPT(self, options: OptimizationOptionsIMPT) -> OptimizerResult: + """ + Args: + options: IMPT optimization options. + """ + ... + + + # Post-processes the proton plan by creating a final spot list, and calculates the dose. + def PostProcessAndCalculateDose(self) -> CalculationResult: + ... + + + # Calculates the dose for a proton plan without post-processing. The existing final spot list is used, and no new list is created during the calculation. + def CalculateDoseWithoutPostProcessing(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam delivery dynamics for the final spot list of a proton plan. + def CalculateBeamDeliveryDynamics(self) -> CalculationResult: + ... + + + # Returns a list of calculation models for the given calculation type. + def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new proton modulated scanning beam to the plan. + def AddModulatedScanningBeam(self, machineParameters: ProtonBeamMachineParameters, snoutId: str, snoutPosition: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See ExternalBeamMachineParameters. + snoutId: Snout ID. + snoutPosition: Snout position in centimeters. + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. + def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: + """ + Args: + existing: The dose matrix is copied from this object. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the + def CreateEvaluationDose(self) -> EvaluationDose: + ... + + + # Get information on whether the plan is optimized using multi-field optimization or single-field optimization. + def GetOptimizationMode(self) -> IonPlanOptimizationMode: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Set the plan normalization. See cref="PlanNormalizationMode" for the supported plan normalization methods. + def SetNormalization(self, normalizationParameters: IonPlanNormalizationParameters) -> None: + """ + Args: + normalizationParameters: Normalization parameters + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Set proton optimization to use either multi-field or single-field optimization. + def SetOptimizationMode(self, mode: IonPlanOptimizationMode) -> None: + """ + Args: + mode: Set the parameter to MultiFieldOptimization to use multi-field optimization and set to SingleFieldOptimization to use single-field optimization. + """ + ... + + + +class Dose: + """ + Represents a 3D dose grid. + + Attributes: + DoseMax3D (DoseValue): The maximum dose. + DoseMax3DLocation (VVector): The location of the maximum dose. + Isodoses (List[Isodose]): A collection of isodoses. + Origin (VVector): The origin of the dose matrix. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first dose plane. + Series (Series): Returns the series that contains the dose, or null if the dose is not connected to a series. + SeriesUID (str): Returns the DICOM UID of the series that contains the dose, or an empty string if the dose is not connected to a series. + UID (str): The DICOM UID of the dose. + XDirection (VVector): The direction of the x-axis in the dose matrix. + XRes (float): The dose matrix resolution in X-direction in millimeters. + XSize (int): The dose matrix size in X-direction in voxels. + YDirection (VVector): The direction of the y-axis in the dose matrix. + YRes (float): The dose matrix resolution in Y-direction in millimeters. + YSize (int): The dose matrix size in Y-direction in voxels. + ZDirection (VVector): The direction of the z-axis in the dose matrix. + ZRes (float): The dose matrix resolution in Z-direction in millimeters. + ZSize (int): The dose matrix size in Z-direction in voxels. + DoseMax3D (DoseValue): The maximum dose. + DoseMax3DLocation (VVector): The location of the maximum dose. + Isodoses (List[Isodose]): A collection of isodoses. + Origin (VVector): The origin of the dose matrix. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first dose plane. + Series (Series): Returns the series that contains the dose, or null if the dose is not connected to a series. + SeriesUID (str): Returns the DICOM UID of the series that contains the dose, or an empty string if the dose is not connected to a series. + UID (str): The DICOM UID of the dose. + XDirection (VVector): The direction of the x-axis in the dose matrix. + XRes (float): The dose matrix resolution in X-direction in millimeters. + XSize (int): The dose matrix size in X-direction in voxels. + YDirection (VVector): The direction of the y-axis in the dose matrix. + YRes (float): The dose matrix resolution in Y-direction in millimeters. + YSize (int): The dose matrix size in Y-direction in voxels. + ZDirection (VVector): The direction of the z-axis in the dose matrix. + ZRes (float): The dose matrix resolution in Z-direction in millimeters. + ZSize (int): The dose matrix size in Z-direction in voxels. + """ + def __init__(self) -> None: ... + + DoseMax3D: DoseValue + + DoseMax3DLocation: VVector + + Isodoses: List[Isodose] + + Origin: VVector + + Series: Series + + SeriesUID: str + + UID: str + + XDirection: VVector + + XRes: float + + XSize: int + + YDirection: VVector + + YRes: float + + YSize: int + + ZDirection: VVector + + ZRes: float + + ZSize: int + + DoseMax3D: DoseValue + + DoseMax3DLocation: VVector + + Isodoses: List[Isodose] + + Origin: VVector + + Series: Series + + SeriesUID: str + + UID: str + + XDirection: VVector + + XRes: float + + XSize: int + + YDirection: VVector + + YRes: float + + YSize: int + + ZDirection: VVector + + ZRes: float + + ZSize: int + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Gets the dose profile. + def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # Gets the point dose at a specified location. + def GetDoseToPoint(self, at: VVector) -> DoseValue: + """ + Args: + at: Location + """ + ... + + + # Gets the voxels of the given dose plane. + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """ + Args: + planeIndex: Zero based index of the plane. + preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this dose. + """ + ... + + + # Converts the given raw voxel value to the corresponding dose value. + def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: + """ + Args: + voxelValue: Voxel value. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Gets the dose profile. + def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # Gets the point dose at a specified location. + def GetDoseToPoint(self, at: VVector) -> DoseValue: + """ + Args: + at: Location + """ + ... + + + # Gets the voxels of the given dose plane. + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """ + Args: + planeIndex: Zero based index of the plane. + preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this dose. + """ + ... + + + # Converts the given raw voxel value to the corresponding dose value. + def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: + """ + Args: + voxelValue: Voxel value. + """ + ... + + + +class DVHEstimationModelStructure: + """ + Structure of a DVH estimation model in Planning Model Library + + Attributes: + Id (str): Id of the structure + IsValid (bool): Is Valid + ModelStructureGuid (str): Model Id + StructureCodes (List[StructureCode]): List of structure codes associated with the structure + StructureType (DVHEstimationStructureType): Structure type: PTV or OAR + Id (str): Id of the structure + IsValid (bool): Is Valid + ModelStructureGuid (str): Model Id + StructureCodes (List[StructureCode]): List of structure codes associated with the structure + StructureType (DVHEstimationStructureType): Structure type: PTV or OAR + """ + # Public constructor + @overload + def __init__(self, impl: IDVHEstimationModelStructure) -> None: + """ + Args: + impl: IDVHEstimationModelStructure object + """ + ... + + + # Public constructor + @overload + def __init__(self, impl: IDVHEstimationModelStructure) -> None: + """ + Args: + impl: IDVHEstimationModelStructure object + """ + ... + + + Id: str + + IsValid: bool + + ModelStructureGuid: str + + StructureCodes: List[StructureCode] + + StructureType: DVHEstimationStructureType + + Id: str + + IsValid: bool + + ModelStructureGuid: str + + StructureCodes: List[StructureCode] + + StructureType: DVHEstimationStructureType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Equipment: + """ + Provides access to clinical devices and accessories. + """ + # Equipment object constructor. + @overload + def __init__(self, admin: IAdmin) -> None: + """ + Args: + admin: An IAdmin object for accessing equipment data. + """ + ... + + + # Equipment object constructor. + @overload + def __init__(self, admin: IAdmin) -> None: + """ + Args: + admin: An IAdmin object for accessing equipment data. + """ + ... + + + # Returns the available brachy treatment units. Excludes virtual and deleted ones. + def GetBrachyTreatmentUnits(self) -> List[BrachyTreatmentUnit]: + ... + + + # Returns the available External Beam treatment units. Excludes virtual and deleted ones. + def GetExternalBeamTreatmentUnits(self) -> List[ExternalBeamTreatmentUnit]: + ... + + + # Returns the available brachy treatment units. Excludes virtual and deleted ones. + def GetBrachyTreatmentUnits(self) -> List[BrachyTreatmentUnit]: + ... + + + # Returns the available External Beam treatment units. Excludes virtual and deleted ones. + def GetExternalBeamTreatmentUnits(self) -> List[ExternalBeamTreatmentUnit]: + ... + + + +class ESAPIActionPackAttribute: + """ + Specifies the assembly as an Eclipse visual scripting action pack. Action packs are ESAPI scripts that are used by visual scripts. + + Attributes: + IsWriteable (bool): Returns true if the action pack can modify patient data. + IsWriteable (bool): Returns true if the action pack can modify patient data. + """ + def __init__(self) -> None: ... + + IsWriteable: bool + + IsWriteable: bool + + +class ESAPIScriptAttribute: + """ + Specifies the assembly as an Eclipse Scripting API (ESAPI) script. + + Attributes: + IsWriteable (bool): Returns true if the script can modify patient data. + IsWriteable (bool): Returns true if the script can modify patient data. + """ + def __init__(self) -> None: ... + + IsWriteable: bool + + IsWriteable: bool + + +class OptimizerDVH: + """ + Contains a structure-specific Dose Volume Histogram (DVH) curve generated in optimization. + + Attributes: + CurveData (Array[DVHPoint]): An array of DVH points representing the DVH curve data. + Structure (Structure): The corresponding structure for the DVH curve data. + CurveData (Array[DVHPoint]): An array of DVH points representing the DVH curve data. + Structure (Structure): The corresponding structure for the DVH curve data. + """ + def __init__(self) -> None: ... + + CurveData: Array[DVHPoint] + + Structure: Structure + + CurveData: Array[DVHPoint] + + Structure: Structure + + +class OptimizerObjectiveValue: + """ + The optimizer objective function value for the structure. + + Attributes: + Structure (Structure): The corresponding structure for the objective function value. + Value (float): The objective function value. + Structure (Structure): The corresponding structure for the objective function value. + Value (float): The objective function value. + """ + def __init__(self) -> None: ... + + Structure: Structure + + Value: float + + Structure: Structure + + Value: float + + +class ExternalPlanSetup: + """ + Represents an external beam plan. For more information, see the definition of the DICOM RT Plan. + + Attributes: + TradeoffExplorationContext (TradeoffExplorationContext): [Availability of this property depends on your Eclipse Scripting API license] Gets the + CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. + DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by + TradeoffExplorationContext (TradeoffExplorationContext): [Availability of this property depends on your Eclipse Scripting API license] Gets the + CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. + DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by + """ + def __init__(self) -> None: ... + + TradeoffExplorationContext: TradeoffExplorationContext + + CalculatePlanUncertaintyDose: bool + + DoseAsEvaluationDose: EvaluationDose + + TradeoffExplorationContext: TradeoffExplorationContext + + CalculatePlanUncertaintyDose: bool + + DoseAsEvaluationDose: EvaluationDose + + # Calculates the dose for the plan with preset meterset values. This applies only to IMRT beams. + def CalculateDoseWithPresetValues(self, presetValues: List[KeyValuePair[str, MetersetValue]]) -> CalculationResult: + """ + Args: + presetValues: The list of preset meterset values for the beams. An element of the list should contain a pair consisting of the beam identifier (as the key) and the corresponding preset meterset value for the beam. Each beam in the plan must have one entry in the list. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the plan. + def CalculateDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the photon plan. + def CalculatePlanUncertaintyDoses(self) -> CalculationResult: + ... + + + # Calculate leaf motions and dose using the calculation models defined in the plan setup. + def CalculateLeafMotionsAndDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. + def CalculateLeafMotions(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Leaf Motion Calculator (LMCV). + def CalculateLeafMotions(self, options: LMCVOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the Varian Leaf Motion Calculator (LMCV) algorithm. + """ + ... + + + # Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Smart LMC. + def CalculateLeafMotions(self, options: SmartLMCOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the Varian Smart LMC algorithm. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be MSS Leaf Motion Calculator (LMCMSS). + def CalculateLeafMotions(self, options: LMCMSSOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the MSS Leaf Motion Calculator (LMCMSS) algorithm. + """ + ... + + + # Returns a list of calculation models for the given calculation type. + def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Runs IMRT optimization for the plan setup. All existing optimal fluences are removed from the beams. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + """ + ... + + + # Runs IMRT optimization for the plan setup. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + optimizationOption: Optimization options. + """ + ... + + + # Runs IMRT optimization for the plan setup. You can add the Multileaf Collimator (MLC) as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption, mlcId: str) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + optimizationOption: Optimization option specifying the initial state. + mlcId: The identifier for the Multileaf Collimator (MLC). + """ + ... + + + # Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self) -> OptimizerResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs IMRT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, options: OptimizationOptionsIMRT) -> OptimizerResult: + """ + Args: + options: Options specifying initial state, intermediate dose, and termination upon convergence. + """ + ... + + + # This method is used to remove the temporary copy of the original IPlanSetup object that was created for intermediate dose calculation. The method should be called only after the optimization is done, otherwise the intermediate dose is disposed too early. The temporary copy should be removed because it is copy of an existing plan and this might cause problems when saving other plans to database, e.g., in automated validation tests. The plan is removed in the same way as in the optimization client for Eclipse. + def RemoveTemporaryPlan(self) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. You can add the MLC as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self, mlcId: str) -> OptimizerResult: + """ + Args: + mlcId: The identifier for the Multileaf Collimator (MLC). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self) -> OptimizerResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup using intermediate dose calculation. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self, options: OptimizationOptionsVMAT) -> OptimizerResult: + """ + Args: + options: VMAT optimization options. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam to the plan. + def AddArcBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new conformal arc beam to the plan. + def AddConformalArcBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, controlPointCount: int, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + controlPointCount: The number of control points to use. + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new fixed sequence (flattening sequence) beam to the plan. + def AddFixedSequenceBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, gantryAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds new imaging beam or beams to the plan. First removes the existing imaging beams. If MV imaging beams are involved, the plan should be optimized again. + def AddImagingSetup(self, machineParameters: ExternalBeamMachineParameters, setupParameters: ImagingBeamSetupParameters, targetStructure: Structure) -> bool: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + setupParameters: Setup parameters for the imaging beam. See + targetStructure: Target structure for imaging. If not specified, the target structure in the plan is used. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam with an MLC to the plan. + def AddMLCArcBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam with an MLC to the plan. + def AddMLCBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field with an MLC to the plan. + def AddMLCSetupBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Multiple Static Segments as the delivery technique. + def AddMultipleStaticSegmentBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field to the plan. + def AddSetupBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Sliding Window as the delivery technique. + def AddSlidingWindowBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new sliding window IMRT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. + def AddSlidingWindowBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: Gantry angle in the IEC GANTRY coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static beam to the plan. + def AddStaticBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam to the plan. + def AddVMATBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. + def AddVMATBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryStartAngle: float, gantryStopAngle: float, gantryDir: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryStartAngle: Gantry start angle in the IEC GANTRY coordinate system (in degrees). + gantryStopAngle: Gantry stop angle in the IEC GANTRY coordinate system (in degrees). + gantryDir: Gantry direction + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. + def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: + """ + Args: + existing: The dose matrix is copied from this object. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the + def CreateEvaluationDose(self) -> EvaluationDose: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes a beam from the plan. + def RemoveBeam(self, beam: Beam) -> None: + """ + Args: + beam: The beam that will be removed from the plan. + """ + ... + + + # Calculates the dose for the plan with preset meterset values. This applies only to IMRT beams. + def CalculateDoseWithPresetValues(self, presetValues: List[KeyValuePair[str, MetersetValue]]) -> CalculationResult: + """ + Args: + presetValues: The list of preset meterset values for the beams. An element of the list should contain a pair consisting of the beam identifier (as the key) and the corresponding preset meterset value for the beam. Each beam in the plan must have one entry in the list. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the plan. + def CalculateDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the photon plan. + def CalculatePlanUncertaintyDoses(self) -> CalculationResult: + ... + + + # Calculate leaf motions and dose using the calculation models defined in the plan setup. + def CalculateLeafMotionsAndDose(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. + def CalculateLeafMotions(self) -> CalculationResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Leaf Motion Calculator (LMCV). + def CalculateLeafMotions(self, options: LMCVOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the Varian Leaf Motion Calculator (LMCV) algorithm. + """ + ... + + + # Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Smart LMC. + def CalculateLeafMotions(self, options: SmartLMCOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the Varian Smart LMC algorithm. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be MSS Leaf Motion Calculator (LMCMSS). + def CalculateLeafMotions(self, options: LMCMSSOptions) -> CalculationResult: + """ + Args: + options: Calculation options for the MSS Leaf Motion Calculator (LMCMSS) algorithm. + """ + ... + + + # Returns a list of calculation models for the given calculation type. + def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Runs IMRT optimization for the plan setup. All existing optimal fluences are removed from the beams. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + """ + ... + + + # Runs IMRT optimization for the plan setup. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + optimizationOption: Optimization options. + """ + ... + + + # Runs IMRT optimization for the plan setup. You can add the Multileaf Collimator (MLC) as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption, mlcId: str) -> OptimizerResult: + """ + Args: + maxIterations: The maximum number of iterations. + optimizationOption: Optimization option specifying the initial state. + mlcId: The identifier for the Multileaf Collimator (MLC). + """ + ... + + + # Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self) -> OptimizerResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs IMRT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def Optimize(self, options: OptimizationOptionsIMRT) -> OptimizerResult: + """ + Args: + options: Options specifying initial state, intermediate dose, and termination upon convergence. + """ + ... + + + # This method is used to remove the temporary copy of the original IPlanSetup object that was created for intermediate dose calculation. The method should be called only after the optimization is done, otherwise the intermediate dose is disposed too early. The temporary copy should be removed because it is copy of an existing plan and this might cause problems when saving other plans to database, e.g., in automated validation tests. The plan is removed in the same way as in the optimization client for Eclipse. + def RemoveTemporaryPlan(self) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. You can add the MLC as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self, mlcId: str) -> OptimizerResult: + """ + Args: + mlcId: The identifier for the Multileaf Collimator (MLC). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self) -> OptimizerResult: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup using intermediate dose calculation. Plan normalization method is changed to 'No plan normalization' after successful optimization. + def OptimizeVMAT(self, options: OptimizationOptionsVMAT) -> OptimizerResult: + """ + Args: + options: VMAT optimization options. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam to the plan. + def AddArcBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new conformal arc beam to the plan. + def AddConformalArcBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, controlPointCount: int, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + controlPointCount: The number of control points to use. + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new fixed sequence (flattening sequence) beam to the plan. + def AddFixedSequenceBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, gantryAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds new imaging beam or beams to the plan. First removes the existing imaging beams. If MV imaging beams are involved, the plan should be optimized again. + def AddImagingSetup(self, machineParameters: ExternalBeamMachineParameters, setupParameters: ImagingBeamSetupParameters, targetStructure: Structure) -> bool: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + setupParameters: Setup parameters for the imaging beam. See + targetStructure: Target structure for imaging. If not specified, the target structure in the plan is used. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam with an MLC to the plan. + def AddMLCArcBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam with an MLC to the plan. + def AddMLCBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field with an MLC to the plan. + def AddMLCSetupBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. + jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Multiple Static Segments as the delivery technique. + def AddMultipleStaticSegmentBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field to the plan. + def AddSetupBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Sliding Window as the delivery technique. + def AddSlidingWindowBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new sliding window IMRT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. + def AddSlidingWindowBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: Gantry angle in the IEC GANTRY coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static beam to the plan. + def AddStaticBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam to the plan. + def AddVMATBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + gantryStop: The stop angle of the gantry, in degrees. + gantryDirection: The rotation direction of the arc. + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position, in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. + def AddVMATBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryStartAngle: float, gantryStopAngle: float, gantryDir: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """ + Args: + machineParameters: Configuration of the used treatment unit. See + metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. + collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + gantryStartAngle: Gantry start angle in the IEC GANTRY coordinate system (in degrees). + gantryStopAngle: Gantry stop angle in the IEC GANTRY coordinate system (in degrees). + gantryDir: Gantry direction + patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + isocenter: The isocenter position in millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. + def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: + """ + Args: + existing: The dose matrix is copied from this object. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the + def CreateEvaluationDose(self) -> EvaluationDose: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes a beam from the plan. + def RemoveBeam(self, beam: Beam) -> None: + """ + Args: + beam: The beam that will be removed from the plan. + """ + ... + + + +class ReferencePoint: + """ + A reference point associated with a patient. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Reference Point. + DailyDoseLimit (DoseValue): Daily dose limit of this reference point. + SessionDoseLimit (DoseValue): Session dose limit of this reference point. + TotalDoseLimit (DoseValue): Total dose limit of this reference point. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Reference Point. + DailyDoseLimit (DoseValue): Daily dose limit of this reference point. + SessionDoseLimit (DoseValue): Session dose limit of this reference point. + TotalDoseLimit (DoseValue): Total dose limit of this reference point. + """ + def __init__(self) -> None: ... + + Id: str + + DailyDoseLimit: DoseValue + + SessionDoseLimit: DoseValue + + TotalDoseLimit: DoseValue + + Id: str + + DailyDoseLimit: DoseValue + + SessionDoseLimit: DoseValue + + TotalDoseLimit: DoseValue + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add location for reference point into image 'Image' + def AddLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image into which location is inserted + x: x coordinate + y: y coordinate + z: z coordinate + errorHint: Holder for error message if addition fails + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Change location for reference point into image 'Image' + def ChangeLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image into which location is inserted + x: x coordinate in mm + y: y coordinate in mm + z: z coordinate in mm + errorHint: Holder for error message if location cannot be changed + """ + ... + + + # 3D location of this reference point in mm + def GetReferencePointLocation(self, Image: Image) -> VVector: + """ + Args: + Image: Image for which the location is requested + """ + ... + + + # The location of the reference point in mm. + def GetReferencePointLocation(self, planSetup: PlanSetup) -> VVector: + """ + Args: + planSetup: Plan setup that this reference point is connected to. + """ + ... + + + # Tests if a valid reference point location exists. + def HasLocation(self, planSetup: PlanSetup) -> bool: + """ + Args: + planSetup: Plan setup that this reference point is connected to + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove reference point location from image 'Image' + def RemoveLocation(self, Image: Image, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image from which the location for the reference point is removed + errorHint: Holder for error message if removal fails + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add location for reference point into image 'Image' + def AddLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image into which location is inserted + x: x coordinate + y: y coordinate + z: z coordinate + errorHint: Holder for error message if addition fails + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Change location for reference point into image 'Image' + def ChangeLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image into which location is inserted + x: x coordinate in mm + y: y coordinate in mm + z: z coordinate in mm + errorHint: Holder for error message if location cannot be changed + """ + ... + + + # 3D location of this reference point in mm + def GetReferencePointLocation(self, Image: Image) -> VVector: + """ + Args: + Image: Image for which the location is requested + """ + ... + + + # The location of the reference point in mm. + def GetReferencePointLocation(self, planSetup: PlanSetup) -> VVector: + """ + Args: + planSetup: Plan setup that this reference point is connected to. + """ + ... + + + # Tests if a valid reference point location exists. + def HasLocation(self, planSetup: PlanSetup) -> bool: + """ + Args: + planSetup: Plan setup that this reference point is connected to + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove reference point location from image 'Image' + def RemoveLocation(self, Image: Image, errorHint: Text.StringBuilder) -> bool: + """ + Args: + Image: Image from which the location for the reference point is removed + errorHint: Holder for error message if removal fails + """ + ... + + + +class SeedCollection: + """ + Represents a collection of brachytherapy + + Attributes: + BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): Obsolete. + Color (Windows.Media.Color): The color of the seeds in the seed collection in the views. + SourcePositions (List[SourcePosition]): The source positions in this collection in creation order. + BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): Obsolete. + Color (Windows.Media.Color): The color of the seeds in the seed collection in the views. + SourcePositions (List[SourcePosition]): The source positions in this collection in creation order. + """ + def __init__(self) -> None: ... + + BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] + + Color: Windows.Media.Color + + SourcePositions: List[SourcePosition] + + BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] + + Color: Windows.Media.Color + + SourcePositions: List[SourcePosition] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class SourcePosition: + """ + Represents a brachytherapy source dwell position in a + + Attributes: + DwellTime (float): Dwell time. + DwellTimeLock (Optional[bool]): Identifies if the dwell time is locked. Set dwell time either locked = true, or unlocked = false. Locked when not allowed to change the dwell time. If unlocked, the dwell time can be changed. + NominalDwellTime (float): The nominal dwell time associated with this source position in seconds. + RadioactiveSource (RadioactiveSource): The radioactive source associated with this dwell position. + Transform (Array[float]): The 4x4 transformation matrix represents the orientation and location of the source position in space. The matrix is composed of a 4x3 rotation submatrix and a 4x1 translation vector. Its bottom row indicates scaling and is always [0 0 0 1]. The translation vector indicates the coordinates of the source position center, in millimeters. The third column of the rotation matrix indicates the source axis direction. + Translation (VVector): The translation of this source position. + DwellTime (float): Dwell time. + DwellTimeLock (Optional[bool]): Identifies if the dwell time is locked. Set dwell time either locked = true, or unlocked = false. Locked when not allowed to change the dwell time. If unlocked, the dwell time can be changed. + NominalDwellTime (float): The nominal dwell time associated with this source position in seconds. + RadioactiveSource (RadioactiveSource): The radioactive source associated with this dwell position. + Transform (Array[float]): The 4x4 transformation matrix represents the orientation and location of the source position in space. The matrix is composed of a 4x3 rotation submatrix and a 4x1 translation vector. Its bottom row indicates scaling and is always [0 0 0 1]. The translation vector indicates the coordinates of the source position center, in millimeters. The third column of the rotation matrix indicates the source axis direction. + Translation (VVector): The translation of this source position. + """ + def __init__(self) -> None: ... + + DwellTime: float + + DwellTimeLock: Optional[bool] + + NominalDwellTime: float + + RadioactiveSource: RadioactiveSource + + Transform: Array[float] + + Translation: VVector + + DwellTime: float + + DwellTimeLock: Optional[bool] + + NominalDwellTime: float + + RadioactiveSource: RadioactiveSource + + Transform: Array[float] + + Translation: VVector + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class StructureCode: + """ + Represents a structure code and its coding scheme. + + Attributes: + Code (str): The structure code as defined in the associated coding scheme. + CodeMeaning (str): The meaning of the structure code. + CodingScheme (str): The coding scheme of the structure code. + DisplayName (str): The display name of the code. + IsEncompassStructureCode (bool): Indicates whether the structure code is an encompass structure code. + Code (str): The structure code as defined in the associated coding scheme. + CodeMeaning (str): The meaning of the structure code. + CodingScheme (str): The coding scheme of the structure code. + DisplayName (str): The display name of the code. + IsEncompassStructureCode (bool): Indicates whether the structure code is an encompass structure code. + """ + def __init__(self) -> None: ... + + Code: str + + CodeMeaning: str + + CodingScheme: str + + DisplayName: str + + IsEncompassStructureCode: bool + + Code: str + + CodeMeaning: str + + CodingScheme: str + + DisplayName: str + + IsEncompassStructureCode: bool + + # Returns a StructureCodeInfo object with the same coding scheme and code as in the current structure code object. + def ToStructureCodeInfo(self) -> StructureCodeInfo: + ... + + + # Determines whether this structure code is considered equal to the specified structure code. + def Equals(self, other: StructureCode) -> bool: + ... + + + # Determines whether the current object is considered equal to the specified object. + def Equals(self, obj: StructureCode) -> bool: + ... + + + # The equality operator. + def op_Equality(self, sc1: StructureCode, sc2: StructureCode) -> bool: + ... + + + # The inequality operator. + def op_Inequality(self, sc1: StructureCode, sc2: StructureCode) -> bool: + ... + + + # Returns a string that represents this object. + def ToString(self) -> str: + ... + + + # Returns the hash code for this structure code. + def GetHashCode(self) -> int: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns a StructureCodeInfo object with the same coding scheme and code as in the current structure code object. + def ToStructureCodeInfo(self) -> StructureCodeInfo: + ... + + + # Determines whether this structure code is considered equal to the specified structure code. + def Equals(self, other: StructureCode) -> bool: + ... + + + # Determines whether the current object is considered equal to the specified object. + def Equals(self, obj: StructureCode) -> bool: + ... + + + # The equality operator. + def op_Equality(self, sc1: StructureCode, sc2: StructureCode) -> bool: + ... + + + # The inequality operator. + def op_Inequality(self, sc1: StructureCode, sc2: StructureCode) -> bool: + ... + + + # Returns a string that represents this object. + def ToString(self) -> str: + ... + + + # Returns the hash code for this structure code. + def GetHashCode(self) -> int: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class StructureCodeDictionary: + """ + Represents a set of structure codes as defined by a structure code scheme. The class exposes the structure codes that are available through the implemented + + Attributes: + Name (str): The name of the structure code scheme. + Version (str): The version of the structure code scheme. May be an empty string, if not applicable to the scheme. + Keys (List[str]): Gets a collection containing the structure code identifiers in this structure code dictionary. + Values (List[StructureCode]): Gets a collection containing the structure codes in this structure code dictionary. + Count (int): Gets the number of structure code object key/value pairs in this structure code dictionary. + Name (str): The name of the structure code scheme. + Version (str): The version of the structure code scheme. May be an empty string, if not applicable to the scheme. + Keys (List[str]): Gets a collection containing the structure code identifiers in this structure code dictionary. + Values (List[StructureCode]): Gets a collection containing the structure codes in this structure code dictionary. + Count (int): Gets the number of structure code object key/value pairs in this structure code dictionary. + """ + def __init__(self) -> None: ... + + Name: str + + Version: str + + Keys: List[str] + + Values: List[StructureCode] + + Count: int + + Name: str + + Version: str + + Keys: List[str] + + Values: List[StructureCode] + + Count: int + + # Determines whether the scheme contains the specified key as an active structure code identifier. + def ContainsKey(self, key: str) -> bool: + ... + + + # Gets the structure code object associated with the specified structure code identifier (key). + def TryGetValue(self, key: str, value: StructureCode) -> bool: + """ + Args: + key: The structure code identifier. + value: When the method returns, contains the specified structure code object, if it is found, otherwise null. + """ + ... + + + # Returns an enumerator that iterates through the collection. + def GetEnumerator(self) -> Iterable[KeyValuePair[str, StructureCode]]: + ... + + + # Returns a string that represents this object. + def ToString(self) -> str: + ... + + + # Determines whether the scheme contains the specified key as an active structure code identifier. + def ContainsKey(self, key: str) -> bool: + ... + + + # Gets the structure code object associated with the specified structure code identifier (key). + def TryGetValue(self, key: str, value: StructureCode) -> bool: + """ + Args: + key: The structure code identifier. + value: When the method returns, contains the specified structure code object, if it is found, otherwise null. + """ + ... + + + # Returns an enumerator that iterates through the collection. + def GetEnumerator(self) -> Iterable[KeyValuePair[str, StructureCode]]: + ... + + + # Returns a string that represents this object. + def ToString(self) -> str: + ... + + + +class ActiveStructureCodeDictionaries: + """ + Provides access to the structure code dictionaries with the active structure codes. + + Attributes: + Fma (StructureCodeDictionary): The Foundational Model of Anatomy Ontology structure scheme. + RadLex (StructureCodeDictionary): The RSNA RadLex radiology lexicon structure scheme. + Srt (StructureCodeDictionary): The SNOMED RT structure scheme. + VmsStructCode (StructureCodeDictionary): The Varian 99VMS_STRUCTCODE structure scheme. + Fma (StructureCodeDictionary): The Foundational Model of Anatomy Ontology structure scheme. + RadLex (StructureCodeDictionary): The RSNA RadLex radiology lexicon structure scheme. + Srt (StructureCodeDictionary): The SNOMED RT structure scheme. + VmsStructCode (StructureCodeDictionary): The Varian 99VMS_STRUCTCODE structure scheme. + """ + # Constructs a new ActiveStructureCodeDictionaries instance. + @overload + def __init__(self, providerFunc: Func[str, IReadOnlyDictionary[str, IStructureCode]]) -> None: + ... + + + # Constructs a new ActiveStructureCodeDictionaries instance. + @overload + def __init__(self, providerFunc: Func[str, IReadOnlyDictionary[str, IStructureCode]]) -> None: + ... + + + Fma: StructureCodeDictionary + + RadLex: StructureCodeDictionary + + Srt: StructureCodeDictionary + + VmsStructCode: StructureCodeDictionary + + Fma: StructureCodeDictionary + + RadLex: StructureCodeDictionary + + Srt: StructureCodeDictionary + + VmsStructCode: StructureCodeDictionary + + +class TradeoffPlanGenerationIntermediateDoseMode: + """ + Enumeration that specifies the use of intermediate dose when optimizing a plan collection for trade-off exploring. + """ + def __init__(self) -> None: ... + + +class Image: + """ + Represents a 2D or 3D image, which can be a DRR, a CT, MR, or other volumetric dataset. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the image. + ApprovalHistory (List[ImageApprovalHistoryEntry]): Returns the approval history of the image. + ContrastBolusAgentIngredientName (str): The name of the contrast bolus agent ingredient that is used in the image. If the value has not been specified, returns null. + CreationDateTime (Optional[datetime]): The date when this object was created. + DisplayUnit (str): The name of the display unit in which the voxels of the image are shown in the user interface. + FOR (str): The UID of the frame of reference. + HasUserOrigin (bool): Defines if a user origin has been specified for the image. + ImageType (str): The type of the image as indicated in the properties of the image slices. + ImagingDeviceId (str): Identification of the device that is used to scan the images into the system. + ImagingOrientation (PatientOrientation): The orientation of the patient. + ImagingOrientationAsString (str): The orientation of the patient as a string (localized) + IsProcessed (bool): Returns the value true if an image processing filter is in use for the image. + Level (int): The level setting. The value is given in the internal voxel scale. + Modality (SeriesModality): The modality of the image as indicated in the properties of the image slices. + Origin (VVector): The origin of the image. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first image plane. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + Series (Series): Used for navigating to parent series. + UID (str): Return UID of the first (and the only) slice in case of a 2D Image. Return null in case of a 3D Image. + UserOrigin (VVector): The user origin in DICOM coordinates in millimeter. + UserOriginComments (str): The text typed on the Origin tab in the Image Properties dialog box. + Window (int): The window setting. The value is given in the internal voxel scale. + XDirection (VVector): The direction of the x-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + XRes (float): The image resolution in X-direction in millimeters. + XSize (int): The image size in X-direction in voxels. + YDirection (VVector): The direction of the y-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + YRes (float): The image resolution in Y-direction in millimeters. + YSize (int): The image size in Y-direction in voxels. + ZDirection (VVector): The direction of the z-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + ZRes (float): The image resolution in Z-direction in millimeters. + ZSize (int): The image size in Z-direction in voxels. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the image. + ApprovalHistory (List[ImageApprovalHistoryEntry]): Returns the approval history of the image. + ContrastBolusAgentIngredientName (str): The name of the contrast bolus agent ingredient that is used in the image. If the value has not been specified, returns null. + CreationDateTime (Optional[datetime]): The date when this object was created. + DisplayUnit (str): The name of the display unit in which the voxels of the image are shown in the user interface. + FOR (str): The UID of the frame of reference. + HasUserOrigin (bool): Defines if a user origin has been specified for the image. + ImageType (str): The type of the image as indicated in the properties of the image slices. + ImagingDeviceId (str): Identification of the device that is used to scan the images into the system. + ImagingOrientation (PatientOrientation): The orientation of the patient. + ImagingOrientationAsString (str): The orientation of the patient as a string (localized) + IsProcessed (bool): Returns the value true if an image processing filter is in use for the image. + Level (int): The level setting. The value is given in the internal voxel scale. + Modality (SeriesModality): The modality of the image as indicated in the properties of the image slices. + Origin (VVector): The origin of the image. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first image plane. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + Series (Series): Used for navigating to parent series. + UID (str): Return UID of the first (and the only) slice in case of a 2D Image. Return null in case of a 3D Image. + UserOrigin (VVector): The user origin in DICOM coordinates in millimeter. + UserOriginComments (str): The text typed on the Origin tab in the Image Properties dialog box. + Window (int): The window setting. The value is given in the internal voxel scale. + XDirection (VVector): The direction of the x-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + XRes (float): The image resolution in X-direction in millimeters. + XSize (int): The image size in X-direction in voxels. + YDirection (VVector): The direction of the y-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + YRes (float): The image resolution in Y-direction in millimeters. + YSize (int): The image size in Y-direction in voxels. + ZDirection (VVector): The direction of the z-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. + ZRes (float): The image resolution in Z-direction in millimeters. + ZSize (int): The image size in Z-direction in voxels. + """ + def __init__(self) -> None: ... + + Id: str + + ApprovalHistory: List[ImageApprovalHistoryEntry] + + ContrastBolusAgentIngredientName: str + + CreationDateTime: Optional[datetime] + + DisplayUnit: str + + FOR: str + + HasUserOrigin: bool + + ImageType: str + + ImagingDeviceId: str + + ImagingOrientation: PatientOrientation + + ImagingOrientationAsString: str + + IsProcessed: bool + + Level: int + + Modality: SeriesModality + + Origin: VVector + + Series: Series + + UID: str + + UserOrigin: VVector + + UserOriginComments: str + + Window: int + + XDirection: VVector + + XRes: float + + XSize: int + + YDirection: VVector + + YRes: float + + YSize: int + + ZDirection: VVector + + ZRes: float + + ZSize: int + + Id: str + + ApprovalHistory: List[ImageApprovalHistoryEntry] + + ContrastBolusAgentIngredientName: str + + CreationDateTime: Optional[datetime] + + DisplayUnit: str + + FOR: str + + HasUserOrigin: bool + + ImageType: str + + ImagingDeviceId: str + + ImagingOrientation: PatientOrientation + + ImagingOrientationAsString: str + + IsProcessed: bool + + Level: int + + Modality: SeriesModality + + Origin: VVector + + Series: Series + + UID: str + + UserOrigin: VVector + + UserOriginComments: str + + Window: int + + XDirection: VVector + + XRes: float + + XSize: int + + YDirection: VVector + + YRes: float + + YSize: int + + ZDirection: VVector + + ZRes: float + + ZSize: int + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns the voxel-wise DECT proton stopping powers of the given image plane calculated from the current image and the rho and Z images. The image FOR, size, and resolution for the rho and Z images must conform with this image. + def CalculateDectProtonStoppingPowers(self, rhoImage: Image, zImage: Image, planeIndex: int, preallocatedBuffer: Array[float]) -> None: + """ + Args: + rhoImage: A DECT relative electron density image. The electron density is interpreted from the image values as rho = 0.001 * (value + 1000). + zImage: A DECT effective atomic number image. + planeIndex: Zero based index of the plane. + preallocatedBuffer: Pre-allocated buffer where the proton stopping power values are stored. The size of the buffer must conform with the X- and Y-size of this image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new structure set. If the image does not yet have a structure set, the new structure set will be assigned directly to it. If the image already has a structure set, a copy of this image is made, and the new structure set is assigned to the copy. The image must be a 3D image. + def CreateNewStructureSet(self) -> StructureSet: + ... + + + # Converts DICOM coordinates to the planning coordinate system used in the Eclipse user interface. + def DicomToUser(self, dicom: VVector, planSetup: PlanSetup) -> VVector: + """ + Args: + dicom: Coordinate value in DICOM coordinate system. + planSetup: Plan that defines the planning orientation or null. + """ + ... + + + # Gets the image profile. + def GetImageProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> ImageProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # Returns the HU to proton stopping power curve associated with the image. + def GetProtonStoppingPowerCurve(self, protonStoppingPowerCurve: SortedList[float, float]) -> bool: + """ + Args: + protonStoppingPowerCurve: An empty list where the curve values will be stored. + """ + ... + + + # Gets the voxels of the given image plane. + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """ + Args: + planeIndex: Zero based index of the plane. + preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this image. + """ + ... + + + # Converts a coordinate value from the planning coordinate system used in the Eclipse user interface to DICOM coordinates. + def UserToDicom(self, user: VVector, planSetup: PlanSetup) -> VVector: + """ + Args: + user: Coordinate value in the planning coordinate system. + planSetup: Plan that defines the planning orientation or null. + """ + ... + + + # Converts the given raw voxel value to the corresponding value in the user interface display unit, for example, HU, Bq/ml. + def VoxelToDisplayValue(self, voxelValue: int) -> float: + """ + Args: + voxelValue: Voxel value. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns the voxel-wise DECT proton stopping powers of the given image plane calculated from the current image and the rho and Z images. The image FOR, size, and resolution for the rho and Z images must conform with this image. + def CalculateDectProtonStoppingPowers(self, rhoImage: Image, zImage: Image, planeIndex: int, preallocatedBuffer: Array[float]) -> None: + """ + Args: + rhoImage: A DECT relative electron density image. The electron density is interpreted from the image values as rho = 0.001 * (value + 1000). + zImage: A DECT effective atomic number image. + planeIndex: Zero based index of the plane. + preallocatedBuffer: Pre-allocated buffer where the proton stopping power values are stored. The size of the buffer must conform with the X- and Y-size of this image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new structure set. If the image does not yet have a structure set, the new structure set will be assigned directly to it. If the image already has a structure set, a copy of this image is made, and the new structure set is assigned to the copy. The image must be a 3D image. + def CreateNewStructureSet(self) -> StructureSet: + ... + + + # Converts DICOM coordinates to the planning coordinate system used in the Eclipse user interface. + def DicomToUser(self, dicom: VVector, planSetup: PlanSetup) -> VVector: + """ + Args: + dicom: Coordinate value in DICOM coordinate system. + planSetup: Plan that defines the planning orientation or null. + """ + ... + + + # Gets the image profile. + def GetImageProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> ImageProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # Returns the HU to proton stopping power curve associated with the image. + def GetProtonStoppingPowerCurve(self, protonStoppingPowerCurve: SortedList[float, float]) -> bool: + """ + Args: + protonStoppingPowerCurve: An empty list where the curve values will be stored. + """ + ... + + + # Gets the voxels of the given image plane. + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """ + Args: + planeIndex: Zero based index of the plane. + preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this image. + """ + ... + + + # Converts a coordinate value from the planning coordinate system used in the Eclipse user interface to DICOM coordinates. + def UserToDicom(self, user: VVector, planSetup: PlanSetup) -> VVector: + """ + Args: + user: Coordinate value in the planning coordinate system. + planSetup: Plan that defines the planning orientation or null. + """ + ... + + + # Converts the given raw voxel value to the corresponding value in the user interface display unit, for example, HU, Bq/ml. + def VoxelToDisplayValue(self, voxelValue: int) -> float: + """ + Args: + voxelValue: Voxel value. + """ + ... + + + +class IDVHEstimationCalculator: + """ + Interface to the calculation of the DVH Estimates + """ + def __init__(self) -> None: ... + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """ + Args: + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + """ + ... + + + +class IonBeamParameters: + """ + An editable copy of the parameters of a proton beam. + + Attributes: + ControlPoints (List[IonControlPointParameters]): Editable control point parameters copied from the treatment beam. + PreSelectedRangeShifter1Id (str): ID of the pre-selected range shifter 1 in the field. + PreSelectedRangeShifter1Setting (str): Setting of the pre-selected range shifter 1 in the field. + PreSelectedRangeShifter2Id (str): ID of the pre-selected range shifter 2 in the field. + PreSelectedRangeShifter2Setting (str): Setting of the pre-selected range shifter 2 in the field. + IonControlPointPairs (IonControlPointPairCollection): A copy of editable control point pairs. + SnoutId (str): The snout identifier. Returns null if undefined. + SnoutPosition (float): Snout position in centimeters. + TargetStructure (Structure): Target structure of the field. + ControlPoints (List[IonControlPointParameters]): Editable control point parameters copied from the treatment beam. + PreSelectedRangeShifter1Id (str): ID of the pre-selected range shifter 1 in the field. + PreSelectedRangeShifter1Setting (str): Setting of the pre-selected range shifter 1 in the field. + PreSelectedRangeShifter2Id (str): ID of the pre-selected range shifter 2 in the field. + PreSelectedRangeShifter2Setting (str): Setting of the pre-selected range shifter 2 in the field. + IonControlPointPairs (IonControlPointPairCollection): A copy of editable control point pairs. + SnoutId (str): The snout identifier. Returns null if undefined. + SnoutPosition (float): Snout position in centimeters. + TargetStructure (Structure): Target structure of the field. + + Note: + To apply the parameters, call the + """ + def __init__(self) -> None: ... + + ControlPoints: List[IonControlPointParameters] + + PreSelectedRangeShifter1Id: str + + PreSelectedRangeShifter1Setting: str + + PreSelectedRangeShifter2Id: str + + PreSelectedRangeShifter2Setting: str + + IonControlPointPairs: IonControlPointPairCollection + + SnoutId: str + + SnoutPosition: float + + TargetStructure: Structure + + ControlPoints: List[IonControlPointParameters] + + PreSelectedRangeShifter1Id: str + + PreSelectedRangeShifter1Setting: str + + PreSelectedRangeShifter2Id: str + + PreSelectedRangeShifter2Setting: str + + IonControlPointPairs: IonControlPointPairCollection + + SnoutId: str + + SnoutPosition: float + + TargetStructure: Structure + + +class OptimizationControllerIMPT: + """ + Controls the IMPT optimization from the Script + """ + def __init__(self) -> None: ... + +class OptimizationControllerIMRT: + """ + Controls the IMRT optimization from the Script + """ + def __init__(self) -> None: ... + +class OptimizationControllerVMAT: + """ + Controls the VMAT optimization from the Script + """ + def __init__(self) -> None: ... + +class OptimizationSetup: + """ + Gives access to the optimization parameters and objectives. + + Attributes: + UseJawTracking (bool): [Availability of this property depends on your Eclipse Scripting API license] Jaw tracking parameter for VMAT optimization. The parameter can only be set for plans to be delivered with a treatment machine that supports jaw tracking. + Objectives (List[OptimizationObjective]): A collection of optimization objectives. + Parameters (List[OptimizationParameter]): A collection of optimization parameters. + UseJawTracking (bool): [Availability of this property depends on your Eclipse Scripting API license] Jaw tracking parameter for VMAT optimization. The parameter can only be set for plans to be delivered with a treatment machine that supports jaw tracking. + Objectives (List[OptimizationObjective]): A collection of optimization objectives. + Parameters (List[OptimizationParameter]): A collection of optimization parameters. + """ + def __init__(self) -> None: ... + + UseJawTracking: bool + + Objectives: List[OptimizationObjective] + + Parameters: List[OptimizationParameter] + + UseJawTracking: bool + + Objectives: List[OptimizationObjective] + + Parameters: List[OptimizationParameter] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. + def AddAutomaticNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic SBRT normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. + def AddAutomaticSbrtNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam-specific parameter for IMRT optimization. + def AddBeamSpecificParameter(self, beam: Beam, smoothX: float, smoothY: float, fixedJaws: bool) -> OptimizationIMRTBeamParameter: + """ + Args: + beam: The beam for which the parameters are added. + smoothX: A fluence-smoothing parameter in X-direction. + smoothY: A fluence-smoothing parameter in Y-direction. + fixedJaws: If true, the collimator jaw positions of the beam remain the same during the optimization. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new gEUD objective. + def AddEUDObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, parameterA: float, priority: float) -> OptimizationEUDObjective: + """ + Args: + structure: The target structure of the objective. + objectiveOperator: The type of the gEUD objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + parameterA: gEUD parameter a. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new mean dose objective. + def AddMeanDoseObjective(self, structure: Structure, dose: DoseValue, priority: float) -> OptimizationMeanDoseObjective: + """ + Args: + structure: The target structure of the objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. + def AddNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float, fallOff: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + fallOff: Determines the steepness of the normal tissue objective fall-off. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new point objective. + def AddPointObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, volume: float, priority: float) -> OptimizationPointObjective: + """ + Args: + structure: The target structure of the objective. + objectiveOperator: The type of the dose-volume objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + volume: The volume of the objective. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) for a proton plan or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. + def AddProtonNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization objective. + def RemoveObjective(self, objective: OptimizationObjective) -> None: + """ + Args: + objective: The objective that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization parameter. + def RemoveParameter(self, parameter: OptimizationParameter) -> None: + """ + Args: + parameter: The parameter that is removed. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. + def AddAutomaticNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic SBRT normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. + def AddAutomaticSbrtNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam-specific parameter for IMRT optimization. + def AddBeamSpecificParameter(self, beam: Beam, smoothX: float, smoothY: float, fixedJaws: bool) -> OptimizationIMRTBeamParameter: + """ + Args: + beam: The beam for which the parameters are added. + smoothX: A fluence-smoothing parameter in X-direction. + smoothY: A fluence-smoothing parameter in Y-direction. + fixedJaws: If true, the collimator jaw positions of the beam remain the same during the optimization. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new gEUD objective. + def AddEUDObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, parameterA: float, priority: float) -> OptimizationEUDObjective: + """ + Args: + structure: The target structure of the objective. + objectiveOperator: The type of the gEUD objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + parameterA: gEUD parameter a. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new mean dose objective. + def AddMeanDoseObjective(self, structure: Structure, dose: DoseValue, priority: float) -> OptimizationMeanDoseObjective: + """ + Args: + structure: The target structure of the objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. + def AddNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float, fallOff: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + fallOff: Determines the steepness of the normal tissue objective fall-off. The value is positive. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new point objective. + def AddPointObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, volume: float, priority: float) -> OptimizationPointObjective: + """ + Args: + structure: The target structure of the objective. + objectiveOperator: The type of the dose-volume objective. + dose: The dose value of the objective. The unit must be the same as defined in the system configuration. + volume: The volume of the objective. + priority: The priority of the objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) for a proton plan or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. + def AddProtonNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float) -> OptimizationNormalTissueParameter: + """ + Args: + priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization objective. + def RemoveObjective(self, objective: OptimizationObjective) -> None: + """ + Args: + objective: The objective that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization parameter. + def RemoveParameter(self, parameter: OptimizationParameter) -> None: + """ + Args: + parameter: The parameter that is removed. + """ + ... + + + +class CalculationResult: + """ + Holds the result of the calculation (pass/fail). + + Attributes: + Success (bool): Returns true if calculation did not return any errors. Otherwise returns false. + Success (bool): Returns true if calculation did not return any errors. Otherwise returns false. + """ + def __init__(self) -> None: ... + + Success: bool + + Success: bool + + +class OptimizerResult: + """ + Holds the result of the optimization (pass/fail). + + Attributes: + StructureDVHs (List[OptimizerDVH]): A list of Dose Volume Histogram (DVH) curves for structures. + StructureObjectiveValues (List[OptimizerObjectiveValue]): The list of objective function values per structure. + TotalObjectiveFunctionValue (float): The total objective function value for the optimization. + NumberOfIMRTOptimizerIterations (int): The number of iterations taken by the IMRT optimizer. + StructureDVHs (List[OptimizerDVH]): A list of Dose Volume Histogram (DVH) curves for structures. + StructureObjectiveValues (List[OptimizerObjectiveValue]): The list of objective function values per structure. + TotalObjectiveFunctionValue (float): The total objective function value for the optimization. + NumberOfIMRTOptimizerIterations (int): The number of iterations taken by the IMRT optimizer. + """ + def __init__(self) -> None: ... + + StructureDVHs: List[OptimizerDVH] + + StructureObjectiveValues: List[OptimizerObjectiveValue] + + TotalObjectiveFunctionValue: float + + NumberOfIMRTOptimizerIterations: int + + StructureDVHs: List[OptimizerDVH] + + StructureObjectiveValues: List[OptimizerObjectiveValue] + + TotalObjectiveFunctionValue: float + + NumberOfIMRTOptimizerIterations: int + + +class PlanSetup: + """ + Represents a treatment plan. See the definition of a DICOM RT Plan for more information. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSetup. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Plan. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Plan. + PlanNormalizationValue (float): [Availability of this property depends on your Eclipse Scripting API license] The plan normalization value in percentage. The plan is normalized according to the plan normalization value, for instance, 200%. The value is Double.NaN if it is not defined. + PlanUncertainties (List[PlanUncertainty]): Plan uncertainties defined for the plan. + PlanObjectiveStructures (List[str]): The list of structure IDs that are present in the plan objectives (prescriptions and indices). + ApprovalHistory (List[ApprovalHistoryEntry]): Returns the approval history of the plan setup. + DosePerFractionInPrimaryRefPoint (DoseValue): The calculated fraction dose in the primary reference point. + PrescribedDosePerFraction (DoseValue): The prescribed fraction dose. + PrescribedPercentage (float): The prescribed dose percentage as a decimal number. For example, if the prescribed dose percentage shown in the Eclipse user interface is 80 %, returns 0.8 + TotalPrescribedDose (DoseValue): The total prescribed dose. + ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the plan. + ApprovalStatus (PlanSetupApprovalStatus): The approval status. + ApprovalStatusAsString (str): Returns the approval status as a string (localized). + BaseDosePlanningItem (PlanningItem): BaseDose for the optimization, can be either plan or plan sum. + Beams (List[Beam]): A collection of all the beams in the plan (including setup beams). Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. + BeamsInTreatmentOrder (List[Beam]): A collection of all the beams in the plan (including setup beams) in treatment order. Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. + CreationUserName (str): The name of the user who saved the plan for the first time. + DosePerFraction (DoseValue): The dose per fraction. + DVHEstimates (List[EstimatedDVH]): Returns a list of DVH estimate objects for this plan + ElectronCalculationModel (str): The name of the electron calculation model. Not applicable to brachytherapy plans. + ElectronCalculationOptions (Dict[str, str]): The electron calculation options. Not applicable to brachytherapy plans. + IntegrityHash (str): Returns the plan's integrity hash. Returns null if the plan's integrity hash has not been set. + IsDoseValid (bool): Returns the value true if the plan dose is valid. This implies that the dose object returned from the dose property is not null and can therefore be used to query dose values. + IsTreated (bool): Checks if the treatment plan has been delivered. + NumberOfFractions (Optional[int]): The number of fractions. + OptimizationSetup (OptimizationSetup): Provides access to optimization objectives and parameters. + PatientSupportDevice (PatientSupportDevice): Patient support device. + PhotonCalculationModel (str): The name of the photon calculation model. Not applicable to brachytherapy plans. + PhotonCalculationOptions (Dict[str, str]): The photon calculation options. Not applicable to brachytherapy plans. + PlanIntent (str): The plan intent as in DICOM, or an empty string. The defined terms are "CURATIVE", "PALLIATIVE", "PROPHYLACTIC", "VERIFICATION", "MACHINE_QA", "RESEARCH" and "SERVICE", but the value can be different for imported plans. + PlanIsInTreatment (bool): Checks if plan is loaded into console. + PlannedDosePerFraction (DoseValue): The calculated fraction dose in the primary reference point. + PlanningApprovalDate (str): The date when the plan was approved for planning. + PlanningApprover (str): The identifier of the user who approved the plan for planning. + PlanningApproverDisplayName (str): The display name of the user who approved the plan for planning. + PlanNormalizationMethod (str): The user interface name for the current normalization method. + PlanNormalizationPoint (VVector): The plan normalization point. + PlanType (PlanType): The plan type. + PredecessorPlan (PlanSetup): The prior revision of the plan + PredecessorPlanUID (str): The UID of the predecessor plan. + PrimaryReferencePoint (ReferencePoint): The primary reference point. + ProtocolID (str): The protocol identifier. + ProtocolPhaseID (str): The protocol phase identifier. + ProtonCalculationModel (str): The name of the proton calculation model. Not applicable to brachytherapy plans. + ProtonCalculationOptions (Dict[str, str]): The proton calculation options. Not applicable to brachytherapy plans. + ReferencePoints (List[ReferencePoint]): Collection of reference points in the plan. + RTPrescription (RTPrescription): Used for navigating to the linked prescription. + Series (Series): The series that contains this plan. Null if the plan is not connected to a series. + SeriesUID (str): The DICOM UID of the series that contains this plan. Empty string if the plan is not connected to a series. + TargetVolumeID (str): The target volume identifier. + TotalDose (DoseValue): Planned total dose. + TreatmentApprovalDate (str): The date when the plan was approved for treatment. + TreatmentApprover (str): The identifier of the user who approved the plan for treatment. + TreatmentApproverDisplayName (str): The display name of the user who approved the plan for treatment. + TreatmentOrientation (PatientOrientation): The orientation of the treatment. + TreatmentOrientationAsString (str): The orientation of the treatment as a string (localized). + TreatmentPercentage (float): The treatment percentage as a decimal number. For example, if the treatment percentage shown in the Eclipse user interface is 80%, returns 0.8. + TreatmentSessions (List[PlanTreatmentSession]): Treatment sessions for the plan, either scheduled sessions or treated sessions. + UID (str): The DICOM UID of the plan. + UseGating (bool): Boolean to mark if gating is used in the plan. + VerifiedPlan (PlanSetup): Returns the verified plan if this is a verification plan, otherwise returns null. The verified plan is the clinical plan that was used to create the verification plan. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSetup. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Plan. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Plan. + PlanNormalizationValue (float): [Availability of this property depends on your Eclipse Scripting API license] The plan normalization value in percentage. The plan is normalized according to the plan normalization value, for instance, 200%. The value is Double.NaN if it is not defined. + PlanUncertainties (List[PlanUncertainty]): Plan uncertainties defined for the plan. + PlanObjectiveStructures (List[str]): The list of structure IDs that are present in the plan objectives (prescriptions and indices). + ApprovalHistory (List[ApprovalHistoryEntry]): Returns the approval history of the plan setup. + DosePerFractionInPrimaryRefPoint (DoseValue): The calculated fraction dose in the primary reference point. + PrescribedDosePerFraction (DoseValue): The prescribed fraction dose. + PrescribedPercentage (float): The prescribed dose percentage as a decimal number. For example, if the prescribed dose percentage shown in the Eclipse user interface is 80 %, returns 0.8 + TotalPrescribedDose (DoseValue): The total prescribed dose. + ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the plan. + ApprovalStatus (PlanSetupApprovalStatus): The approval status. + ApprovalStatusAsString (str): Returns the approval status as a string (localized). + BaseDosePlanningItem (PlanningItem): BaseDose for the optimization, can be either plan or plan sum. + Beams (List[Beam]): A collection of all the beams in the plan (including setup beams). Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. + BeamsInTreatmentOrder (List[Beam]): A collection of all the beams in the plan (including setup beams) in treatment order. Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. + CreationUserName (str): The name of the user who saved the plan for the first time. + DosePerFraction (DoseValue): The dose per fraction. + DVHEstimates (List[EstimatedDVH]): Returns a list of DVH estimate objects for this plan + ElectronCalculationModel (str): The name of the electron calculation model. Not applicable to brachytherapy plans. + ElectronCalculationOptions (Dict[str, str]): The electron calculation options. Not applicable to brachytherapy plans. + IntegrityHash (str): Returns the plan's integrity hash. Returns null if the plan's integrity hash has not been set. + IsDoseValid (bool): Returns the value true if the plan dose is valid. This implies that the dose object returned from the dose property is not null and can therefore be used to query dose values. + IsTreated (bool): Checks if the treatment plan has been delivered. + NumberOfFractions (Optional[int]): The number of fractions. + OptimizationSetup (OptimizationSetup): Provides access to optimization objectives and parameters. + PatientSupportDevice (PatientSupportDevice): Patient support device. + PhotonCalculationModel (str): The name of the photon calculation model. Not applicable to brachytherapy plans. + PhotonCalculationOptions (Dict[str, str]): The photon calculation options. Not applicable to brachytherapy plans. + PlanIntent (str): The plan intent as in DICOM, or an empty string. The defined terms are "CURATIVE", "PALLIATIVE", "PROPHYLACTIC", "VERIFICATION", "MACHINE_QA", "RESEARCH" and "SERVICE", but the value can be different for imported plans. + PlanIsInTreatment (bool): Checks if plan is loaded into console. + PlannedDosePerFraction (DoseValue): The calculated fraction dose in the primary reference point. + PlanningApprovalDate (str): The date when the plan was approved for planning. + PlanningApprover (str): The identifier of the user who approved the plan for planning. + PlanningApproverDisplayName (str): The display name of the user who approved the plan for planning. + PlanNormalizationMethod (str): The user interface name for the current normalization method. + PlanNormalizationPoint (VVector): The plan normalization point. + PlanType (PlanType): The plan type. + PredecessorPlan (PlanSetup): The prior revision of the plan + PredecessorPlanUID (str): The UID of the predecessor plan. + PrimaryReferencePoint (ReferencePoint): The primary reference point. + ProtocolID (str): The protocol identifier. + ProtocolPhaseID (str): The protocol phase identifier. + ProtonCalculationModel (str): The name of the proton calculation model. Not applicable to brachytherapy plans. + ProtonCalculationOptions (Dict[str, str]): The proton calculation options. Not applicable to brachytherapy plans. + ReferencePoints (List[ReferencePoint]): Collection of reference points in the plan. + RTPrescription (RTPrescription): Used for navigating to the linked prescription. + Series (Series): The series that contains this plan. Null if the plan is not connected to a series. + SeriesUID (str): The DICOM UID of the series that contains this plan. Empty string if the plan is not connected to a series. + TargetVolumeID (str): The target volume identifier. + TotalDose (DoseValue): Planned total dose. + TreatmentApprovalDate (str): The date when the plan was approved for treatment. + TreatmentApprover (str): The identifier of the user who approved the plan for treatment. + TreatmentApproverDisplayName (str): The display name of the user who approved the plan for treatment. + TreatmentOrientation (PatientOrientation): The orientation of the treatment. + TreatmentOrientationAsString (str): The orientation of the treatment as a string (localized). + TreatmentPercentage (float): The treatment percentage as a decimal number. For example, if the treatment percentage shown in the Eclipse user interface is 80%, returns 0.8. + TreatmentSessions (List[PlanTreatmentSession]): Treatment sessions for the plan, either scheduled sessions or treated sessions. + UID (str): The DICOM UID of the plan. + UseGating (bool): Boolean to mark if gating is used in the plan. + VerifiedPlan (PlanSetup): Returns the verified plan if this is a verification plan, otherwise returns null. The verified plan is the clinical plan that was used to create the verification plan. + """ + def __init__(self) -> None: ... + + Id: str + + Name: str + + Comment: str + + PlanNormalizationValue: float + + PlanUncertainties: List[PlanUncertainty] + + PlanObjectiveStructures: List[str] + + ApprovalHistory: List[ApprovalHistoryEntry] + + DosePerFractionInPrimaryRefPoint: DoseValue + + PrescribedDosePerFraction: DoseValue + + PrescribedPercentage: float + + TotalPrescribedDose: DoseValue + + ApplicationScriptLogs: List[ApplicationScriptLog] + + ApprovalStatus: PlanSetupApprovalStatus + + ApprovalStatusAsString: str + + BaseDosePlanningItem: PlanningItem + + Beams: List[Beam] + + BeamsInTreatmentOrder: List[Beam] + + CreationUserName: str + + DosePerFraction: DoseValue + + DVHEstimates: List[EstimatedDVH] + + ElectronCalculationModel: str + + ElectronCalculationOptions: Dict[str, str] + + IntegrityHash: str + + IsDoseValid: bool + + IsTreated: bool + + NumberOfFractions: Optional[int] + + OptimizationSetup: OptimizationSetup + + PatientSupportDevice: PatientSupportDevice + + PhotonCalculationModel: str + + PhotonCalculationOptions: Dict[str, str] + + PlanIntent: str + + PlanIsInTreatment: bool + + PlannedDosePerFraction: DoseValue + + PlanningApprovalDate: str + + PlanningApprover: str + + PlanningApproverDisplayName: str + + PlanNormalizationMethod: str + + PlanNormalizationPoint: VVector + + PlanType: PlanType + + PredecessorPlan: PlanSetup + + PredecessorPlanUID: str + + PrimaryReferencePoint: ReferencePoint + + ProtocolID: str + + ProtocolPhaseID: str + + ProtonCalculationModel: str + + ProtonCalculationOptions: Dict[str, str] + + ReferencePoints: List[ReferencePoint] + + RTPrescription: RTPrescription + + Series: Series + + SeriesUID: str + + TargetVolumeID: str + + TotalDose: DoseValue + + TreatmentApprovalDate: str + + TreatmentApprover: str + + TreatmentApproverDisplayName: str + + TreatmentOrientation: PatientOrientation + + TreatmentOrientationAsString: str + + TreatmentPercentage: float + + TreatmentSessions: List[PlanTreatmentSession] + + UID: str + + UseGating: bool + + VerifiedPlan: PlanSetup + + Id: str + + Name: str + + Comment: str + + PlanNormalizationValue: float + + PlanUncertainties: List[PlanUncertainty] + + PlanObjectiveStructures: List[str] + + ApprovalHistory: List[ApprovalHistoryEntry] + + DosePerFractionInPrimaryRefPoint: DoseValue + + PrescribedDosePerFraction: DoseValue + + PrescribedPercentage: float + + TotalPrescribedDose: DoseValue + + ApplicationScriptLogs: List[ApplicationScriptLog] + + ApprovalStatus: PlanSetupApprovalStatus + + ApprovalStatusAsString: str + + BaseDosePlanningItem: PlanningItem + + Beams: List[Beam] + + BeamsInTreatmentOrder: List[Beam] + + CreationUserName: str + + DosePerFraction: DoseValue + + DVHEstimates: List[EstimatedDVH] + + ElectronCalculationModel: str + + ElectronCalculationOptions: Dict[str, str] + + IntegrityHash: str + + IsDoseValid: bool + + IsTreated: bool + + NumberOfFractions: Optional[int] + + OptimizationSetup: OptimizationSetup + + PatientSupportDevice: PatientSupportDevice + + PhotonCalculationModel: str + + PhotonCalculationOptions: Dict[str, str] + + PlanIntent: str + + PlanIsInTreatment: bool + + PlannedDosePerFraction: DoseValue + + PlanningApprovalDate: str + + PlanningApprover: str + + PlanningApproverDisplayName: str + + PlanNormalizationMethod: str + + PlanNormalizationPoint: VVector + + PlanType: PlanType + + PredecessorPlan: PlanSetup + + PredecessorPlanUID: str + + PrimaryReferencePoint: ReferencePoint + + ProtocolID: str + + ProtocolPhaseID: str + + ProtonCalculationModel: str + + ProtonCalculationOptions: Dict[str, str] + + ReferencePoints: List[ReferencePoint] + + RTPrescription: RTPrescription + + Series: Series + + SeriesUID: str + + TargetVolumeID: str + + TotalDose: DoseValue + + TreatmentApprovalDate: str + + TreatmentApprover: str + + TreatmentApproverDisplayName: str + + TreatmentOrientation: PatientOrientation + + TreatmentOrientationAsString: str + + TreatmentPercentage: float + + TreatmentSessions: List[PlanTreatmentSession] + + UID: str + + UseGating: bool + + VerifiedPlan: PlanSetup + + # Gets the prescriptions and measures in the protocol that is associated with this plan setup. + def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List[ProtocolPhasePrescription], measures: List[ProtocolPhaseMeasure]) -> None: + """ + Args: + prescriptions: Returned list of prescriptions (plan objectives). + measures: Returned list of plan measures (quality indices). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. + def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: + """ + Args: + target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). + location: Reference point location in mm. + id: Reference point ID. + """ + ... + + + # Attaches event handling. + def AttachToCalcClient(self, doseCalcClient: ICalculationClient) -> Any: + ... + + + # Detaches event handling for the calculation client. + def DetachFromCalcClient(self, doseCalcClient: ICalculationClient) -> Any: + ... + + + # Reporting. + def Report(self, str: str) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimatesImpl(self, dvhCalculator: IPhotonCalculation, client: ICalculationClient, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str], license: LicenseId) -> Any: + """ + Args: + dvhCalculator: Interface for calculating the DVH estimates. + client: Calculation client. + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + license: License required for running the DVH estimation + """ + ... + + + # Check if plan approval status is valid. Note: Configured approval extensions are not executed. + def IsValidForPlanApproval(self, validationResults: List[PlanValidationResultEsapiDetail]) -> bool: + """ + Args: + validationResults: Validation results which contain detailed warning and error messages. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a new plan or field uncertainty with parameters. In case of field specific uncertainty, HUConversionError is overwritten to be always zero. Supported uncertainty types: RangeUncertainty, IsocenterShiftUncertainty, BaselineShiftUncertainty, RobustOptimizationUncertainty (=Perturbation). RangeUncertainty and RobustOptimizationUncertainty are proton specific. IsocenterShiftUncertainty and BaselineShiftUncertainty are photon specific. Field specific plan uncertainty dose can be used only for RobustOptimizationUncertainty. In case of BaselineShiftUncertainty isocenterShift parameter is actually target shift. + def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: + """ + Args: + uncertaintyType: Type of the plan uncertainty dose. + planSpecificUncertainty: The plan uncertainty dose is either plan specific (true) or field specific (false). + HUConversionError: Calibration curve error [%] + isocenterShift: Patient setup error [cm] + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the treatment order of the beams. + def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: + """ + Args: + orderedBeams: The beams in wanted order. All the beams of the plan must be present, otherwise the method fails. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. + def AddReferencePoint(self, refPoint: ReferencePoint) -> ReferencePoint: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Clears the calculation model for the given calculation type. + def ClearCalculationModel(self, calculationType: CalculationType) -> None: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Returns the selected calculation model for the given calculation type. Returns null if no model has been selected. + def GetCalculationModel(self, calculationType: CalculationType) -> str: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Gets the given calculation option value. + def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """ + Args: + calculationModel: The name of the calculation model. + optionName: The XPath or name of the option to set. + optionValue: The value of the given option. + """ + ... + + + # Gets all the calculation options and their values for the given calculation model. + def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: + """ + Args: + calculationModel: The name of the calculation model. + """ + ... + + + # Retrieves the name of DVH Estimation Model. + def GetDvhEstimationModelName(self) -> str: + ... + + + # Checks the limits of the current calculation area. + def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Moves the plan setup from its current course to the destination course, maintaining the plan UID. + def MoveToCourse(self, destinationCourse: Course) -> None: + """ + Args: + destinationCourse: The destination course for the plan setup. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove provided reference point from plan + def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to remove. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the calculation model for the given calculation type. + def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: + """ + Args: + calculationType: The type of calculation. + model: The name of the calculation model. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the given calculation option to the given value. Before setting the options for the model, set the calculation model. See + def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """ + Args: + calculationModel: The name of the calculation model. + optionName: The XPath or name of the option to set. If this is not an XPath, the method sets the first attribute that matches the name. Example 1: CalculationGridSizeInCM in the Anisotropic Analytical Algorithm (AAA) sets the option /AAACalculationOptions/@CalculationGridSizeInCM. Example 2: MaximalDrillDepthInCM in the Proton Convolution Superposition (PCS) algorithm sets the option /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling1/@MaximalDrillDepthInCM. To set the values, for example, for the Drilling2 settings, you have to specify the entire XPath /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling2/@MaximalDrillDepthInCM. + optionValue: The value to set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets and validates the number of fractions and dose per fraction. + def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: + """ + Args: + numberOfFractions: The number of fractions. + dosePerFraction: The dose per fraction. + treatmentPercentage: The treatment percentage as a decimal number. For example, if the treatment percentage shown in the user interface is 80%, use 0.8. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets or changes target structure if valid dose is not affected by the change. + def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: Text.StringBuilder) -> bool: + """ + Args: + newTargetStructure: New target structure. + errorHint: Holder for error message. + """ + ... + + + # Gets the prescriptions and measures in the protocol that is associated with this plan setup. + def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List[ProtocolPhasePrescription], measures: List[ProtocolPhaseMeasure]) -> None: + """ + Args: + prescriptions: Returned list of prescriptions (plan objectives). + measures: Returned list of plan measures (quality indices). + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. + def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: + """ + Args: + target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). + location: Reference point location in mm. + id: Reference point ID. + """ + ... + + + # Attaches event handling. + def AttachToCalcClient(self, doseCalcClient: ICalculationClient) -> Any: + ... + + + # Detaches event handling for the calculation client. + def DetachFromCalcClient(self, doseCalcClient: ICalculationClient) -> Any: + ... + + + # Reporting. + def Report(self, str: str) -> Any: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. + def CalculateDVHEstimatesImpl(self, dvhCalculator: IPhotonCalculation, client: ICalculationClient, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str], license: LicenseId) -> Any: + """ + Args: + dvhCalculator: Interface for calculating the DVH estimates. + client: Calculation client. + modelId: DVH estimation model ID. + targetDoseLevels: Dose levels for the target structures. + structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). + license: License required for running the DVH estimation + """ + ... + + + # Check if plan approval status is valid. Note: Configured approval extensions are not executed. + def IsValidForPlanApproval(self, validationResults: List[PlanValidationResultEsapiDetail]) -> bool: + """ + Args: + validationResults: Validation results which contain detailed warning and error messages. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a new plan or field uncertainty with parameters. In case of field specific uncertainty, HUConversionError is overwritten to be always zero. Supported uncertainty types: RangeUncertainty, IsocenterShiftUncertainty, BaselineShiftUncertainty, RobustOptimizationUncertainty (=Perturbation). RangeUncertainty and RobustOptimizationUncertainty are proton specific. IsocenterShiftUncertainty and BaselineShiftUncertainty are photon specific. Field specific plan uncertainty dose can be used only for RobustOptimizationUncertainty. In case of BaselineShiftUncertainty isocenterShift parameter is actually target shift. + def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: + """ + Args: + uncertaintyType: Type of the plan uncertainty dose. + planSpecificUncertainty: The plan uncertainty dose is either plan specific (true) or field specific (false). + HUConversionError: Calibration curve error [%] + isocenterShift: Patient setup error [cm] + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the treatment order of the beams. + def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: + """ + Args: + orderedBeams: The beams in wanted order. All the beams of the plan must be present, otherwise the method fails. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. + def AddReferencePoint(self, refPoint: ReferencePoint) -> ReferencePoint: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Clears the calculation model for the given calculation type. + def ClearCalculationModel(self, calculationType: CalculationType) -> None: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Returns the selected calculation model for the given calculation type. Returns null if no model has been selected. + def GetCalculationModel(self, calculationType: CalculationType) -> str: + """ + Args: + calculationType: The type of calculation. + """ + ... + + + # Gets the given calculation option value. + def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """ + Args: + calculationModel: The name of the calculation model. + optionName: The XPath or name of the option to set. + optionValue: The value of the given option. + """ + ... + + + # Gets all the calculation options and their values for the given calculation model. + def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: + """ + Args: + calculationModel: The name of the calculation model. + """ + ... + + + # Retrieves the name of DVH Estimation Model. + def GetDvhEstimationModelName(self) -> str: + ... + + + # Checks the limits of the current calculation area. + def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Moves the plan setup from its current course to the destination course, maintaining the plan UID. + def MoveToCourse(self, destinationCourse: Course) -> None: + """ + Args: + destinationCourse: The destination course for the plan setup. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove provided reference point from plan + def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: + """ + Args: + refPoint: Reference point to remove. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the calculation model for the given calculation type. + def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: + """ + Args: + calculationType: The type of calculation. + model: The name of the calculation model. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the given calculation option to the given value. Before setting the options for the model, set the calculation model. See + def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """ + Args: + calculationModel: The name of the calculation model. + optionName: The XPath or name of the option to set. If this is not an XPath, the method sets the first attribute that matches the name. Example 1: CalculationGridSizeInCM in the Anisotropic Analytical Algorithm (AAA) sets the option /AAACalculationOptions/@CalculationGridSizeInCM. Example 2: MaximalDrillDepthInCM in the Proton Convolution Superposition (PCS) algorithm sets the option /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling1/@MaximalDrillDepthInCM. To set the values, for example, for the Drilling2 settings, you have to specify the entire XPath /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling2/@MaximalDrillDepthInCM. + optionValue: The value to set. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets and validates the number of fractions and dose per fraction. + def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: + """ + Args: + numberOfFractions: The number of fractions. + dosePerFraction: The dose per fraction. + treatmentPercentage: The treatment percentage as a decimal number. For example, if the treatment percentage shown in the user interface is 80%, use 0.8. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets or changes target structure if valid dose is not affected by the change. + def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: Text.StringBuilder) -> bool: + """ + Args: + newTargetStructure: New target structure. + errorHint: Holder for error message. + """ + ... + + + +class ProtocolPhaseMeasure: + """ + Represents the plan measures (quality indices) of the clinical protocol. + + Attributes: + TargetValue (float): The target value of this plan measure. + ActualValue (float): The calculated actual value of this plan measure. + TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. + Modifier (MeasureModifier): Measure Modifier. + StructureId (str): ID of the structure to which this measure is applied. + Type (MeasureType): Measure Type. + TypeText (str): Measure type as text, for instance, 'Conformity Index' in 'Conformity Index is more than 10.0'. + TargetValue (float): The target value of this plan measure. + ActualValue (float): The calculated actual value of this plan measure. + TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. + Modifier (MeasureModifier): Measure Modifier. + StructureId (str): ID of the structure to which this measure is applied. + Type (MeasureType): Measure Type. + TypeText (str): Measure type as text, for instance, 'Conformity Index' in 'Conformity Index is more than 10.0'. + """ + def __init__(self) -> None: ... + + TargetValue: float + + ActualValue: float + + TargetIsMet: Optional[bool] + + Modifier: MeasureModifier + + StructureId: str + + Type: MeasureType + + TypeText: str + + TargetValue: float + + ActualValue: float + + TargetIsMet: Optional[bool] + + Modifier: MeasureModifier + + StructureId: str + + Type: MeasureType + + TypeText: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ProtocolPhasePrescription: + """ + Represents the prescriptions (plan objectives) of the clinical protocol. + + Attributes: + TargetTotalDose (DoseValue): Total dose in absolute units specified for this prescription. + TargetFractionDose (DoseValue): Fraction dose in absolute units specified for this prescription. + ActualTotalDose (DoseValue): Actual total dose for this prescription + TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. + PrescModifier (PrescriptionModifier): Prescription Modifier. + PrescParameter (float): Value of the prescription parameter, for instance, '80' in 'At least 80% receives more than 2 Gy'. + PrescType (PrescriptionType): Prescription Type. + StructureId (str): ID of structure to which this prescription is applied. + TargetTotalDose (DoseValue): Total dose in absolute units specified for this prescription. + TargetFractionDose (DoseValue): Fraction dose in absolute units specified for this prescription. + ActualTotalDose (DoseValue): Actual total dose for this prescription + TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. + PrescModifier (PrescriptionModifier): Prescription Modifier. + PrescParameter (float): Value of the prescription parameter, for instance, '80' in 'At least 80% receives more than 2 Gy'. + PrescType (PrescriptionType): Prescription Type. + StructureId (str): ID of structure to which this prescription is applied. + """ + def __init__(self) -> None: ... + + TargetTotalDose: DoseValue + + TargetFractionDose: DoseValue + + ActualTotalDose: DoseValue + + TargetIsMet: Optional[bool] + + PrescModifier: PrescriptionModifier + + PrescParameter: float + + PrescType: PrescriptionType + + StructureId: str + + TargetTotalDose: DoseValue + + TargetFractionDose: DoseValue + + ActualTotalDose: DoseValue + + TargetIsMet: Optional[bool] + + PrescModifier: PrescriptionModifier + + PrescParameter: float + + PrescType: PrescriptionType + + StructureId: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ScriptEnvironment: + """ + Contains the runtime information of the application environment for the script. + + Attributes: + ApplicationName (str): The name of the active application. + VersionInfo (str): The version number of Eclipse. + ApiVersionInfo (str): The version number of Eclipse Scripting API. + Scripts (List[ApplicationScript]): Retrieves a list of all scripts known by the application. + Packages (List[ApplicationPackage]): Retrieves a list of all packages known by the application. + ApplicationName (str): The name of the active application. + VersionInfo (str): The version number of Eclipse. + ApiVersionInfo (str): The version number of Eclipse Scripting API. + Scripts (List[ApplicationScript]): Retrieves a list of all scripts known by the application. + Packages (List[ApplicationPackage]): Retrieves a list of all packages known by the application. + """ + # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. + @overload + def __init__(self, appName: str, scripts: List[IApplicationScript], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: + """ + Args: + appName: The application name. + scripts: A list of all scripts known by the application. + scriptExecutionEngine: The execution engine for executing a script from another script. + """ + ... + + + # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. + @overload + def __init__(self, appName: str, scripts: List[IApplicationScript], packages: List[IApplicationPackage], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: + """ + Args: + appName: The application name. + scripts: A list of all scripts known by the application. + packages: A list of all packages known by the application. + scriptExecutionEngine: The execution engine for executing a script from another script. + """ + ... + + + # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. + @overload + def __init__(self, appName: str, scripts: List[IApplicationScript], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: + """ + Args: + appName: The application name. + scripts: A list of all scripts known by the application. + scriptExecutionEngine: The execution engine for executing a script from another script. + """ + ... + + + # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. + @overload + def __init__(self, appName: str, scripts: List[IApplicationScript], packages: List[IApplicationPackage], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: + """ + Args: + appName: The application name. + scripts: A list of all scripts known by the application. + packages: A list of all packages known by the application. + scriptExecutionEngine: The execution engine for executing a script from another script. + """ + ... + + + ApplicationName: str + + VersionInfo: str + + ApiVersionInfo: str + + Scripts: List[ApplicationScript] + + Packages: List[ApplicationPackage] + + ApplicationName: str + + VersionInfo: str + + ApiVersionInfo: str + + Scripts: List[ApplicationScript] + + Packages: List[ApplicationPackage] + + # Executes an other script from script. This allows a script to be used for launching other scripts. Without using this special method, the system would be unaware of the other script, and thus could not save the correct script logs. + def ExecuteScript(self, scriptAssembly: Reflection.Assembly, scriptContext: ScriptContext, window: Windows.Window) -> None: + """ + Args: + scriptAssembly: The other script assembly. The assembly must have a location. + scriptContext: The script context that was passed to the executing script. + window: The script window. This is an optional parameter, can be null. + """ + ... + + + # Executes an other script from script. This allows a script to be used for launching other scripts. Without using this special method, the system would be unaware of the other script, and thus could not save the correct script logs. + def ExecuteScript(self, scriptAssembly: Reflection.Assembly, scriptContext: ScriptContext, window: Windows.Window) -> None: + """ + Args: + scriptAssembly: The other script assembly. The assembly must have a location. + scriptContext: The script context that was passed to the executing script. + window: The script window. This is an optional parameter, can be null. + """ + ... + + + +class Structure: + """ + A structure is a geometrical representation of an anatomical organ, a treatment volume, a marker, or a support structure. See the definition of a DICOM Structure for more information. + + Attributes: + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Structure. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Structure. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Structure. + ApprovalHistory (List[StructureApprovalHistoryEntry]): Returns the approval history of the structure. + CenterPoint (VVector): The center point of the structure. + Color (Windows.Media.Color): The color of the structure. + DicomType (str): The DICOM type of the structure, for example, PTV, MARKER, or ORGAN. + HasCalculatedPlans (bool): Checks if a calculated plan exists for the structure + HasSegment (bool): Checks if the structure has a segment. + IsApproved (bool): Checks if the structure is approved + IsEmpty (bool): Checks if the structure is empty. + IsHighResolution (bool): true if this structure is a high-resolution structure. Otherwise false. + IsTarget (bool): Checks if the structure is PTV, CTV or GTV + MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The mesh geometry. + ROINumber (int): The DICOM ROI Number of the structure. + SegmentVolume (SegmentVolume): Provides access to the segment volume of the structure. + StructureCode (StructureCode): The structure code that identifies this structure. + StructureCodeInfos (List[StructureCodeInfo]): Property value. + Volume (float): The calculated volume. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Structure. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Structure. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Structure. + ApprovalHistory (List[StructureApprovalHistoryEntry]): Returns the approval history of the structure. + CenterPoint (VVector): The center point of the structure. + Color (Windows.Media.Color): The color of the structure. + DicomType (str): The DICOM type of the structure, for example, PTV, MARKER, or ORGAN. + HasCalculatedPlans (bool): Checks if a calculated plan exists for the structure + HasSegment (bool): Checks if the structure has a segment. + IsApproved (bool): Checks if the structure is approved + IsEmpty (bool): Checks if the structure is empty. + IsHighResolution (bool): true if this structure is a high-resolution structure. Otherwise false. + IsTarget (bool): Checks if the structure is PTV, CTV or GTV + MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The mesh geometry. + ROINumber (int): The DICOM ROI Number of the structure. + SegmentVolume (SegmentVolume): Provides access to the segment volume of the structure. + StructureCode (StructureCode): The structure code that identifies this structure. + StructureCodeInfos (List[StructureCodeInfo]): Property value. + Volume (float): The calculated volume. + """ + def __init__(self) -> None: ... + + Id: str + + Name: str + + Comment: str + + ApprovalHistory: List[StructureApprovalHistoryEntry] + + CenterPoint: VVector + + Color: Windows.Media.Color + + DicomType: str + + HasCalculatedPlans: bool + + HasSegment: bool + + IsApproved: bool + + IsEmpty: bool + + IsHighResolution: bool + + IsTarget: bool + + MeshGeometry: Windows.Media.Media3D.MeshGeometry3D + + ROINumber: int + + SegmentVolume: SegmentVolume + + StructureCode: StructureCode + + StructureCodeInfos: List[StructureCodeInfo] + + Volume: float + + Id: str + + Name: str + + Comment: str + + ApprovalHistory: List[StructureApprovalHistoryEntry] + + CenterPoint: VVector + + Color: Windows.Media.Color + + DicomType: str + + HasCalculatedPlans: bool + + HasSegment: bool + + IsApproved: bool + + IsEmpty: bool + + IsHighResolution: bool + + IsTarget: bool + + MeshGeometry: Windows.Media.Media3D.MeshGeometry3D + + ROINumber: int + + SegmentVolume: SegmentVolume + + StructureCode: StructureCode + + StructureCodeInfos: List[StructureCodeInfo] + + Volume: float + + # An implicit conversion from Structure to SegmentVolume makes it easier to use the SegmentVolume functionality, such as the boolean operators and margin. + def op_Implicit(self, structure: SegmentVolume) -> SegmentVolume: + """ + Args: + structure: The converted structure. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds the given contour to the given image plane. + def AddContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: + """ + Args: + contour: The contour points, z coordinates are ignored. + z: A zero-based image plane index. + """ + ... + + + # Boolean And operation for structures that have a segment model. Provided here for convenience. + def And(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this segment volume. + """ + ... + + + # Asymmetric margin operation for structures that have a segment model. Provided here for convenience. + def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: + """ + Args: + margins: The margins aligned to the axes of the image coordinate system, in millimeters. The maximum is 50. + """ + ... + + + # Returns true if this structure can be converted to a high-resolution structure. + def CanConvertToHighResolution(self) -> bool: + ... + + + # Checks if the segment volume of the structure can be edited. + def CanEditSegmentVolume(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If the segment volume cannot be edited, contains the error message. + """ + ... + + + # Checks if the HU value of the structure can be modified. + def CanSetAssignedHU(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If the HU value cannot be set, contains the error message. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Clears the contours on the given image plane. + def ClearAllContoursOnImagePlane(self, z: int) -> None: + """ + Args: + z: A zero-based image plane index. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a structure out of an isodose level. + def ConvertDoseLevelToStructure(self, dose: Dose, doseLevel: DoseValue) -> None: + """ + Args: + dose: The dose from which the dose level is extracted. + doseLevel: The dose level. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Converts this structure to a high-resolution structure. Increases the resolution of the segment volume in cases where the image size is larger than 256x256 voxels. + def ConvertToHighResolution(self) -> None: + ... + + + # Returns the HU value of the material. + def GetAssignedHU(self, huValue: float) -> bool: + """ + Args: + huValue: Double value that will contain the HU value upon return from this method + """ + ... + + + # If the structure has a segment, gets the contours of the structure on the given image plane. + def GetContoursOnImagePlane(self, z: int) -> Array[Array[VVector]]: + """ + Args: + z: Zero based image plane index. + """ + ... + + + # If the structure has a segment, returns the number of separate parts. + def GetNumberOfSeparateParts(self) -> int: + ... + + + # If the structure is a reference line, gets its points. + def GetReferenceLinePoints(self) -> Array[VVector]: + ... + + + # If the structure has a segment, gets the segment profile. + def GetSegmentProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Collections.BitArray) -> SegmentProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # If the structure has a segment, checks if the given point lies within the structure. + def IsPointInsideSegment(self, point: VVector) -> bool: + """ + Args: + point: Location of the point. + """ + ... + + + # Margin operation for structures that have a segment model. Provided here for convenience. + def Margin(self, marginInMM: float) -> SegmentVolume: + """ + Args: + marginInMM: The used margin in millimeters. The maximum is 50. + """ + ... + + + # Boolean Not operation for structures that have a segment model. Provided here for convenience. + def Not(self) -> SegmentVolume: + ... + + + # Boolean Or operation for structures that have a segment model. Provided here for convenience. + def Or(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Resets the HU value of the material to "undefined". + def ResetAssignedHU(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the HU value of the material. + def SetAssignedHU(self, huValue: float) -> None: + """ + Args: + huValue: A double value that contains the HU value to be set. + """ + ... + + + # Boolean Sub operation for structures that have a segment model. Provided here for convenience. + def Sub(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is subtracted from this segment volume. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Subtracts the given contour from the given image plane. + def SubtractContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: + """ + Args: + contour: The contour points, z coordinates are ignored. + z: A zero-based image plane index. + """ + ... + + + # Boolean Xor operation for structures that have a segment model. Provided here for convenience. + def Xor(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # An implicit conversion from Structure to SegmentVolume makes it easier to use the SegmentVolume functionality, such as the boolean operators and margin. + def op_Implicit(self, structure: SegmentVolume) -> SegmentVolume: + """ + Args: + structure: The converted structure. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds the given contour to the given image plane. + def AddContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: + """ + Args: + contour: The contour points, z coordinates are ignored. + z: A zero-based image plane index. + """ + ... + + + # Boolean And operation for structures that have a segment model. Provided here for convenience. + def And(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this segment volume. + """ + ... + + + # Asymmetric margin operation for structures that have a segment model. Provided here for convenience. + def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: + """ + Args: + margins: The margins aligned to the axes of the image coordinate system, in millimeters. The maximum is 50. + """ + ... + + + # Returns true if this structure can be converted to a high-resolution structure. + def CanConvertToHighResolution(self) -> bool: + ... + + + # Checks if the segment volume of the structure can be edited. + def CanEditSegmentVolume(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If the segment volume cannot be edited, contains the error message. + """ + ... + + + # Checks if the HU value of the structure can be modified. + def CanSetAssignedHU(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If the HU value cannot be set, contains the error message. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Clears the contours on the given image plane. + def ClearAllContoursOnImagePlane(self, z: int) -> None: + """ + Args: + z: A zero-based image plane index. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a structure out of an isodose level. + def ConvertDoseLevelToStructure(self, dose: Dose, doseLevel: DoseValue) -> None: + """ + Args: + dose: The dose from which the dose level is extracted. + doseLevel: The dose level. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Converts this structure to a high-resolution structure. Increases the resolution of the segment volume in cases where the image size is larger than 256x256 voxels. + def ConvertToHighResolution(self) -> None: + ... + + + # Returns the HU value of the material. + def GetAssignedHU(self, huValue: float) -> bool: + """ + Args: + huValue: Double value that will contain the HU value upon return from this method + """ + ... + + + # If the structure has a segment, gets the contours of the structure on the given image plane. + def GetContoursOnImagePlane(self, z: int) -> Array[Array[VVector]]: + """ + Args: + z: Zero based image plane index. + """ + ... + + + # If the structure has a segment, returns the number of separate parts. + def GetNumberOfSeparateParts(self) -> int: + ... + + + # If the structure is a reference line, gets its points. + def GetReferenceLinePoints(self) -> Array[VVector]: + ... + + + # If the structure has a segment, gets the segment profile. + def GetSegmentProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Collections.BitArray) -> SegmentProfile: + """ + Args: + start: Location of the first point of the profile. + stop: Location of the last point of the profile. + preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. + """ + ... + + + # If the structure has a segment, checks if the given point lies within the structure. + def IsPointInsideSegment(self, point: VVector) -> bool: + """ + Args: + point: Location of the point. + """ + ... + + + # Margin operation for structures that have a segment model. Provided here for convenience. + def Margin(self, marginInMM: float) -> SegmentVolume: + """ + Args: + marginInMM: The used margin in millimeters. The maximum is 50. + """ + ... + + + # Boolean Not operation for structures that have a segment model. Provided here for convenience. + def Not(self) -> SegmentVolume: + ... + + + # Boolean Or operation for structures that have a segment model. Provided here for convenience. + def Or(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Resets the HU value of the material to "undefined". + def ResetAssignedHU(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the HU value of the material. + def SetAssignedHU(self, huValue: float) -> None: + """ + Args: + huValue: A double value that contains the HU value to be set. + """ + ... + + + # Boolean Sub operation for structures that have a segment model. Provided here for convenience. + def Sub(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is subtracted from this segment volume. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Subtracts the given contour from the given image plane. + def SubtractContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: + """ + Args: + contour: The contour points, z coordinates are ignored. + z: A zero-based image plane index. + """ + ... + + + # Boolean Xor operation for structures that have a segment model. Provided here for convenience. + def Xor(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + +class StructureSet: + """ + A structure set is a container for structures of a patient, including anatomical organs, treatment volumes and markers, and support structures. + + Attributes: + Structures (List[Structure]): Used for navigating to the child structures. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the structure set. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the structure set. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the structure set. + ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the structure set. + Image (Image): Used for navigating to the image. + Patient (Patient): Used for navigating to the patient. + Series (Series): The series that contains this plan. Null if the plan is not connected to a series. + SeriesUID (str): The DICOM UID of the series that contains this structure set. Empty string if the structure set is not connected to a series. + UID (str): DICOM UID. + Structures (List[Structure]): Used for navigating to the child structures. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the structure set. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the structure set. + Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the structure set. + ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the structure set. + Image (Image): Used for navigating to the image. + Patient (Patient): Used for navigating to the patient. + Series (Series): The series that contains this plan. Null if the plan is not connected to a series. + SeriesUID (str): The DICOM UID of the series that contains this structure set. Empty string if the structure set is not connected to a series. + UID (str): DICOM UID. + """ + def __init__(self) -> None: ... + + Structures: List[Structure] + + Id: str + + Name: str + + Comment: str + + ApplicationScriptLogs: List[ApplicationScriptLog] + + Image: Image + + Patient: Patient + + Series: Series + + SeriesUID: str + + UID: str + + Structures: List[Structure] + + Id: str + + Name: str + + Comment: str + + ApplicationScriptLogs: List[ApplicationScriptLog] + + Image: Image + + Patient: Patient + + Series: Series + + SeriesUID: str + + UID: str + + # [Availability of this method depends on your Eclipse Scripting API license] Adds couch structures to the StructureSet. Eclipse can model certain couches for photon treatment planning. A couch is modeled as a set of couch structures.The couch panel surface and interior, movable structural rails and grid(for Unipanel only) are each modeled as separate couch structures. The structure code of a couch structure is Support by default. You can change it to another structure code if necessary. The volume type of a couch structure is always Support. Couch structures are modeled inside a 3D image. If the 3D image is too small, this method will always enlarge the image to fit the couch structures. + def AddCouchStructures(self, couchModel: str, orientation: PatientOrientation, railA: RailPosition, railB: RailPosition, surfaceHU: Optional[float], interiorHU: Optional[float], railHU: Optional[float], addedStructures: IReadOnlyList[Structure], imageResized: bool, error: str) -> bool: + """ + Args: + couchModel: The id of the couch profile configured in Eclipse to use when creating the couch structures. + orientation: Patient orientation specifying where the couch structures are added. Pass NoOrientation to take the orientation from the image. + railA: Position of moveable rail A. + railB: Position of moveable rail B. + surfaceHU: HU value of the modeled couch surface. Pass null to use the setting from the specified couch profile or override by passing another value. + interiorHU: HU value of the modeled couch interior. Pass null to use the setting from the specified couch profile or override by passing another value. + railHU: HU value of the modeled couch rails. Pass null to use the setting from the specified couch profile or override by passing another value. + addedStructures: Returned list of added couch structures if successful. + imageResized: True if image was resized. + error: Returned error message if call failed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes couch structures from the StructureSet. + def RemoveCouchStructures(self, removedStructureIds: IReadOnlyList[str], error: str) -> bool: + """ + Args: + removedStructureIds: Returned list of removed couch structure IDs if successful. + error: Returned error message if call failed. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new reference line. + def AddReferenceLine(self, name: str, id: str, referenceLinePoints: Array[VVector]) -> Structure: + """ + Args: + name: Reference line name. + id: Reference line Id. + referenceLinePoints: Reference line points. Number of points: 1 .. 500. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure according to the DICOM structure type. + def AddStructure(self, dicomType: str, id: str) -> Structure: + """ + Args: + dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". + id: The identifier for the new structure. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure based on structure code. The DICOM structure type and structure ID are automatically assigned. + def AddStructure(self, code: StructureCodeInfo) -> Structure: + """ + Args: + code: The structure code. + """ + ... + + + # This method is used to verify whether it is possible to add couch structures to the StructureSet. + def CanAddCouchStructures(self, error: str) -> bool: + """ + Args: + error: Returned reason why couch structures cannot be added if method returns false. + """ + ... + + + # Returns true if it is possible to add the given type of structure to the structure set. + def CanAddStructure(self, dicomType: str, id: str) -> bool: + """ + Args: + dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". + id: The identifier for the new structure. + """ + ... + + + # This method is used to verify whether it is possible to remove couch structures from the StructureSet. + def CanRemoveCouchStructures(self, error: str) -> bool: + """ + Args: + error: Returned reason why couch structures cannot be removed if method returns false. + """ + ... + + + # Returns true if it is possible to remove the given structure from the structure set. + def CanRemoveStructure(self, structure: Structure) -> bool: + """ + Args: + structure: The structure to check. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a copy of this structure set. + def Copy(self) -> StructureSet: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new Body structure and searches Body with the specified parameters. The existing Body structure is returned, if there is one. + def CreateAndSearchBody(self, parameters: SearchBodyParameters) -> Structure: + """ + Args: + parameters: Parameters for the Search Body feature. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Deletes this structure set. + def Delete(self) -> None: + ... + + + # Gets a default set of Search Body parameters. + def GetDefaultSearchBodyParameters(self) -> SearchBodyParameters: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the structure from this structure set if removal is allowed. + def RemoveStructure(self, structure: Structure) -> None: + """ + Args: + structure: The structure to remove. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds couch structures to the StructureSet. Eclipse can model certain couches for photon treatment planning. A couch is modeled as a set of couch structures.The couch panel surface and interior, movable structural rails and grid(for Unipanel only) are each modeled as separate couch structures. The structure code of a couch structure is Support by default. You can change it to another structure code if necessary. The volume type of a couch structure is always Support. Couch structures are modeled inside a 3D image. If the 3D image is too small, this method will always enlarge the image to fit the couch structures. + def AddCouchStructures(self, couchModel: str, orientation: PatientOrientation, railA: RailPosition, railB: RailPosition, surfaceHU: Optional[float], interiorHU: Optional[float], railHU: Optional[float], addedStructures: IReadOnlyList[Structure], imageResized: bool, error: str) -> bool: + """ + Args: + couchModel: The id of the couch profile configured in Eclipse to use when creating the couch structures. + orientation: Patient orientation specifying where the couch structures are added. Pass NoOrientation to take the orientation from the image. + railA: Position of moveable rail A. + railB: Position of moveable rail B. + surfaceHU: HU value of the modeled couch surface. Pass null to use the setting from the specified couch profile or override by passing another value. + interiorHU: HU value of the modeled couch interior. Pass null to use the setting from the specified couch profile or override by passing another value. + railHU: HU value of the modeled couch rails. Pass null to use the setting from the specified couch profile or override by passing another value. + addedStructures: Returned list of added couch structures if successful. + imageResized: True if image was resized. + error: Returned error message if call failed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes couch structures from the StructureSet. + def RemoveCouchStructures(self, removedStructureIds: IReadOnlyList[str], error: str) -> bool: + """ + Args: + removedStructureIds: Returned list of removed couch structure IDs if successful. + error: Returned error message if call failed. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new reference line. + def AddReferenceLine(self, name: str, id: str, referenceLinePoints: Array[VVector]) -> Structure: + """ + Args: + name: Reference line name. + id: Reference line Id. + referenceLinePoints: Reference line points. Number of points: 1 .. 500. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure according to the DICOM structure type. + def AddStructure(self, dicomType: str, id: str) -> Structure: + """ + Args: + dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". + id: The identifier for the new structure. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure based on structure code. The DICOM structure type and structure ID are automatically assigned. + def AddStructure(self, code: StructureCodeInfo) -> Structure: + """ + Args: + code: The structure code. + """ + ... + + + # This method is used to verify whether it is possible to add couch structures to the StructureSet. + def CanAddCouchStructures(self, error: str) -> bool: + """ + Args: + error: Returned reason why couch structures cannot be added if method returns false. + """ + ... + + + # Returns true if it is possible to add the given type of structure to the structure set. + def CanAddStructure(self, dicomType: str, id: str) -> bool: + """ + Args: + dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". + id: The identifier for the new structure. + """ + ... + + + # This method is used to verify whether it is possible to remove couch structures from the StructureSet. + def CanRemoveCouchStructures(self, error: str) -> bool: + """ + Args: + error: Returned reason why couch structures cannot be removed if method returns false. + """ + ... + + + # Returns true if it is possible to remove the given structure from the structure set. + def CanRemoveStructure(self, structure: Structure) -> bool: + """ + Args: + structure: The structure to check. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a copy of this structure set. + def Copy(self) -> StructureSet: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a new Body structure and searches Body with the specified parameters. The existing Body structure is returned, if there is one. + def CreateAndSearchBody(self, parameters: SearchBodyParameters) -> Structure: + """ + Args: + parameters: Parameters for the Search Body feature. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Deletes this structure set. + def Delete(self) -> None: + ... + + + # Gets a default set of Search Body parameters. + def GetDefaultSearchBodyParameters(self) -> SearchBodyParameters: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the structure from this structure set if removal is allowed. + def RemoveStructure(self, structure: Structure) -> None: + """ + Args: + structure: The structure to remove. + """ + ... + + + +class TradeoffExplorationContext: + """ + + Attributes: + HasPlanCollection (bool): True if the trade-off exploration context has a plan collection, so that the trade-offs can be explored using the + CanLoadSavedPlanCollection (bool): True if a previously saved plan collection can be loaded. + CanCreatePlanCollection (bool): True if a plan collection can be created. + CanUsePlanDoseAsIntermediateDose (bool): True if plan dose can be used as intermediate dose in + CanUseHybridOptimizationInPlanGeneration (bool): True if VMAT-IMRT hybrid optimization can be used in + TradeoffObjectiveCandidates (List[OptimizationObjective]): Available optimization objectives that can be selected for trade-off exploration in multi-criteria optimization. + TradeoffObjectives (Collections.Generic.IReadOnlyCollection[TradeoffObjective]): Trade-off objectives. If + TradeoffStructureCandidates (List[Structure]): Available structures that can be selected for trade-off exploration in multi-criteria optimization. Only organs at risk can be used for trade-off exploration at the structure level. + TargetStructures (List[Structure]): Target structures in trade-off exploration. These structures cannot be selected for trade-off exploration at the structure level. Homogeneity indices only apply to the target structures. + CurrentDose (Dose): Dose at the current location on the Pareto surface (the current trade-offs). Returns null if no valid dose exists. + HasPlanCollection (bool): True if the trade-off exploration context has a plan collection, so that the trade-offs can be explored using the + CanLoadSavedPlanCollection (bool): True if a previously saved plan collection can be loaded. + CanCreatePlanCollection (bool): True if a plan collection can be created. + CanUsePlanDoseAsIntermediateDose (bool): True if plan dose can be used as intermediate dose in + CanUseHybridOptimizationInPlanGeneration (bool): True if VMAT-IMRT hybrid optimization can be used in + TradeoffObjectiveCandidates (List[OptimizationObjective]): Available optimization objectives that can be selected for trade-off exploration in multi-criteria optimization. + TradeoffObjectives (Collections.Generic.IReadOnlyCollection[TradeoffObjective]): Trade-off objectives. If + TradeoffStructureCandidates (List[Structure]): Available structures that can be selected for trade-off exploration in multi-criteria optimization. Only organs at risk can be used for trade-off exploration at the structure level. + TargetStructures (List[Structure]): Target structures in trade-off exploration. These structures cannot be selected for trade-off exploration at the structure level. Homogeneity indices only apply to the target structures. + CurrentDose (Dose): Dose at the current location on the Pareto surface (the current trade-offs). Returns null if no valid dose exists. + + Note: + To be able to get the + """ + # Creates a trade-off exploration context for a given plan. Acquires an MCO license for the lifetime of the application. + @overload + def __init__(self, param1: ExternalPlanSetup, param2: ILicenseManager, param3: IMcoControllerWithLocalDoseCorrection, param4: IMcoRuleValidator) -> None: + ... + + + # Creates a trade-off exploration context for a given plan. Acquires an MCO license for the lifetime of the application. + @overload + def __init__(self, param1: ExternalPlanSetup, param2: ILicenseManager, param3: IMcoControllerWithLocalDoseCorrection, param4: IMcoRuleValidator) -> None: + ... + + + HasPlanCollection: bool + + CanLoadSavedPlanCollection: bool + + CanCreatePlanCollection: bool + + CanUsePlanDoseAsIntermediateDose: bool + + CanUseHybridOptimizationInPlanGeneration: bool + + TradeoffObjectiveCandidates: List[OptimizationObjective] + + TradeoffObjectives: Collections.Generic.IReadOnlyCollection[TradeoffObjective] + + TradeoffStructureCandidates: List[Structure] + + TargetStructures: List[Structure] + + CurrentDose: Dose + + HasPlanCollection: bool + + CanLoadSavedPlanCollection: bool + + CanCreatePlanCollection: bool + + CanUsePlanDoseAsIntermediateDose: bool + + CanUseHybridOptimizationInPlanGeneration: bool + + TradeoffObjectiveCandidates: List[OptimizationObjective] + + TradeoffObjectives: Collections.Generic.IReadOnlyCollection[TradeoffObjective] + + TradeoffStructureCandidates: List[Structure] + + TargetStructures: List[Structure] + + CurrentDose: Dose + + # Loads a previously saved plan collection and sets + def LoadSavedPlanCollection(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan collection for trade-off exploration and sets + def CreatePlanCollection(self, continueOptimization: bool, intermediateDoseMode: TradeoffPlanGenerationIntermediateDoseMode, useHybridOptimizationForVmat: bool) -> bool: + """ + Args: + continueOptimization: True if the starting point for the trade-off exploration should be created by continuing optimization for the existing plan. Otherwise, the starting point is created by starting optimization from the beginning. + intermediateDoseMode: Specifies which intermediate dose mode is used for plan generation. + useHybridOptimizationForVmat: True if VMAT-IMRT hybrid optimization should be used in VMAT plan generation. Otherwise native VMAT optimization is used. + """ + ... + + + # Gets the current relative cost of a trade-off objective. The costs are normalized to the range [0,1]. If + def GetObjectiveCost(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the cost. + """ + ... + + + # Gets the lower limit value for a trade-off objective. It is not possible to set the cost value of the objective below this value. The range of the objective may be limited because one or more objective has a restrictor ( + def GetObjectiveLowerLimit(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the lower limit. + """ + ... + + + # Gets the upper limit value for a trade-off objective. It is not possible to set the cost value of the objective above this value. The range of the objective may be limited because one or more objective has a restrictor ( + def GetObjectiveUpperLimit(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the upper limit. + """ + ... + + + # Gets the current upper limit of a trade-off objective. The limits are normalized to the range [0,1]. If + def GetObjectiveUpperRestrictor(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective to get the upper limit. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] A single trade-off objective specifies a one dimensional subspace of the Pareto surface. By adjusting the relative cost of the objective, it is possible to move in this one dimensional subspace. The difference between the current relative cost and the new relative cost specifies the direction of the movement. If the difference is negative, the movement is towards the extreme case where the given trade-off objective is emphasized at the cost of all other objectives. If the difference is positive, the movement is away from the extreme case. If + def SetObjectiveCost(self, tradeoffObjective: TradeoffObjective, cost: float) -> None: + """ + Args: + tradeoffObjective: Trade-off objective that specifies the one dimensional subspace. + cost: The relative cost is defined as an interval [0,1]. A smaller value gives more emphasis to the given trade-off objective. + """ + ... + + + # Sets an upper limit for a trade-off objective. The limits are normalized to the range [0,1]. If + def SetObjectiveUpperRestrictor(self, tradeoffObjective: TradeoffObjective, restrictorValue: float) -> None: + """ + Args: + tradeoffObjective: Optimization objective selected for trade-off exploration. This trade-off objective specifies the one dimensional subspace of the Pareto surface. + restrictorValue: New upper limit [0,1] of the given trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Resets the costs of a trade-off objective to correspond to the balanced plan. If + def ResetToBalancedPlan(self) -> None: + ... + + + # Calculates a DVH for a given structure based on the dose at the current location on the Pareto surface (current trade-offs). If + def GetStructureDvh(self, structure: Structure) -> DVHData: + """ + Args: + structure: Structure for which the DVH is calculated. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a homogeneity objective for a given target structure to be used as a trade-off objective. Only target structures with an upper dose objective with larger than zero priority may have a homogeneity objective. Adding a new trade-off objective sets + def AddTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: + """ + Args: + targetStructure: Structure for which the homogeneity objective is created. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from all objectives associated with the given structure. Targets cannot be used in trade-off exploration at the structure level. Structures that do not have objectives or are not included in the plan cannot be added as trade-off objectives. Adding a new trade-off objective sets + def AddTradeoffObjective(self, structure: Structure) -> bool: + """ + Args: + structure: Structure to be added as a trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from an individual optimization objective. Adding a new trade-off objective sets + def AddTradeoffObjective(self, objective: OptimizationObjective) -> bool: + """ + Args: + objective: Objective to be added as a trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the given trade-off objective. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTradeoffObjective(self, tradeoffObjective: TradeoffObjective) -> bool: + """ + Args: + tradeoffObjective: Trade-off objective to be removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the homogeneity trade-off objective of the given target structure. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: + """ + Args: + targetStructure: Target structure for which the homogeneity objective is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the trade-off objective of the given structure. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTradeoffObjective(self, structure: Structure) -> bool: + """ + Args: + structure: Structure for which the trade-off objective is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan collection from the plan setup and database. Removing the plan collection sets + def RemovePlanCollection(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes all the trade-off objectives of the current plan collection. Removing all trade-off objectives invalidates the current plan collection and sets + def RemoveAllTradeoffObjectives(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Saves the trade-off exploration result. Also applies the trade-off exploration result to the plan setup for IMRT plans. For VMAT plans, to apply the results to the plan setup, an additional call to the + def ApplyTradeoffExplorationResult(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Applies the trade-off exploration result to the plan setup for VMAT plans. + def CreateDeliverableVmatPlan(self, useIntermediateDose: bool) -> bool: + """ + Args: + useIntermediateDose: True if intermediate dose is used when creating the VMAT plan. + """ + ... + + + # Loads a previously saved plan collection and sets + def LoadSavedPlanCollection(self) -> bool: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan collection for trade-off exploration and sets + def CreatePlanCollection(self, continueOptimization: bool, intermediateDoseMode: TradeoffPlanGenerationIntermediateDoseMode, useHybridOptimizationForVmat: bool) -> bool: + """ + Args: + continueOptimization: True if the starting point for the trade-off exploration should be created by continuing optimization for the existing plan. Otherwise, the starting point is created by starting optimization from the beginning. + intermediateDoseMode: Specifies which intermediate dose mode is used for plan generation. + useHybridOptimizationForVmat: True if VMAT-IMRT hybrid optimization should be used in VMAT plan generation. Otherwise native VMAT optimization is used. + """ + ... + + + # Gets the current relative cost of a trade-off objective. The costs are normalized to the range [0,1]. If + def GetObjectiveCost(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the cost. + """ + ... + + + # Gets the lower limit value for a trade-off objective. It is not possible to set the cost value of the objective below this value. The range of the objective may be limited because one or more objective has a restrictor ( + def GetObjectiveLowerLimit(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the lower limit. + """ + ... + + + # Gets the upper limit value for a trade-off objective. It is not possible to set the cost value of the objective above this value. The range of the objective may be limited because one or more objective has a restrictor ( + def GetObjectiveUpperLimit(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective for which to get the upper limit. + """ + ... + + + # Gets the current upper limit of a trade-off objective. The limits are normalized to the range [0,1]. If + def GetObjectiveUpperRestrictor(self, objective: TradeoffObjective) -> float: + """ + Args: + objective: Trade-off objective to get the upper limit. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] A single trade-off objective specifies a one dimensional subspace of the Pareto surface. By adjusting the relative cost of the objective, it is possible to move in this one dimensional subspace. The difference between the current relative cost and the new relative cost specifies the direction of the movement. If the difference is negative, the movement is towards the extreme case where the given trade-off objective is emphasized at the cost of all other objectives. If the difference is positive, the movement is away from the extreme case. If + def SetObjectiveCost(self, tradeoffObjective: TradeoffObjective, cost: float) -> None: + """ + Args: + tradeoffObjective: Trade-off objective that specifies the one dimensional subspace. + cost: The relative cost is defined as an interval [0,1]. A smaller value gives more emphasis to the given trade-off objective. + """ + ... + + + # Sets an upper limit for a trade-off objective. The limits are normalized to the range [0,1]. If + def SetObjectiveUpperRestrictor(self, tradeoffObjective: TradeoffObjective, restrictorValue: float) -> None: + """ + Args: + tradeoffObjective: Optimization objective selected for trade-off exploration. This trade-off objective specifies the one dimensional subspace of the Pareto surface. + restrictorValue: New upper limit [0,1] of the given trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Resets the costs of a trade-off objective to correspond to the balanced plan. If + def ResetToBalancedPlan(self) -> None: + ... + + + # Calculates a DVH for a given structure based on the dose at the current location on the Pareto surface (current trade-offs). If + def GetStructureDvh(self, structure: Structure) -> DVHData: + """ + Args: + structure: Structure for which the DVH is calculated. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a homogeneity objective for a given target structure to be used as a trade-off objective. Only target structures with an upper dose objective with larger than zero priority may have a homogeneity objective. Adding a new trade-off objective sets + def AddTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: + """ + Args: + targetStructure: Structure for which the homogeneity objective is created. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from all objectives associated with the given structure. Targets cannot be used in trade-off exploration at the structure level. Structures that do not have objectives or are not included in the plan cannot be added as trade-off objectives. Adding a new trade-off objective sets + def AddTradeoffObjective(self, structure: Structure) -> bool: + """ + Args: + structure: Structure to be added as a trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from an individual optimization objective. Adding a new trade-off objective sets + def AddTradeoffObjective(self, objective: OptimizationObjective) -> bool: + """ + Args: + objective: Objective to be added as a trade-off objective. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the given trade-off objective. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTradeoffObjective(self, tradeoffObjective: TradeoffObjective) -> bool: + """ + Args: + tradeoffObjective: Trade-off objective to be removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the homogeneity trade-off objective of the given target structure. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: + """ + Args: + targetStructure: Target structure for which the homogeneity objective is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the trade-off objective of the given structure. Removing the trade-off objective invalidates the current plan collection and sets + def RemoveTradeoffObjective(self, structure: Structure) -> bool: + """ + Args: + structure: Structure for which the trade-off objective is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan collection from the plan setup and database. Removing the plan collection sets + def RemovePlanCollection(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes all the trade-off objectives of the current plan collection. Removing all trade-off objectives invalidates the current plan collection and sets + def RemoveAllTradeoffObjectives(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Saves the trade-off exploration result. Also applies the trade-off exploration result to the plan setup for IMRT plans. For VMAT plans, to apply the results to the plan setup, an additional call to the + def ApplyTradeoffExplorationResult(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Applies the trade-off exploration result to the plan setup for VMAT plans. + def CreateDeliverableVmatPlan(self, useIntermediateDose: bool) -> bool: + """ + Args: + useIntermediateDose: True if intermediate dose is used when creating the VMAT plan. + """ + ... + + + +class TypeBasedIdValidator: + """ + A utility class for validating the data object identifier. + """ + def __init__(self) -> None: ... + + # Returns true if the given identifier is valid for the given data object. + def IsValidId(self, id: str, dataObject: ApiDataObject, errorHint: Text.StringBuilder) -> bool: + """ + Args: + id: The new identifier to check. + dataObject: The data object for whom the new identifier is checked. + errorHint: The error string that is set if the validation failed. + """ + ... + + + # Throws System.ArgumentException if the given identifier is not valid for the given data object. + def ThrowIfNotValidId(self, id: str, dataObject: ApiDataObject) -> None: + """ + Args: + id: The new identifier to check. + dataObject: The data object for whom the new identifier is checked. + """ + ... + + + # Returns true if the given identifier is valid for the given data object. + def IsValidId(self, id: str, dataObject: ApiDataObject, errorHint: Text.StringBuilder) -> bool: + """ + Args: + id: The new identifier to check. + dataObject: The data object for whom the new identifier is checked. + errorHint: The error string that is set if the validation failed. + """ + ... + + + # Throws System.ArgumentException if the given identifier is not valid for the given data object. + def ThrowIfNotValidId(self, id: str, dataObject: ApiDataObject) -> None: + """ + Args: + id: The new identifier to check. + dataObject: The data object for whom the new identifier is checked. + """ + ... + + + +class User: + """ + Represents a user. + + Attributes: + Id (str): The identifier of the user. + Language (str): The language of the user. + Name (str): The display name of the user. + Id (str): The identifier of the user. + Language (str): The language of the user. + Name (str): The display name of the user. + """ + def __init__(self) -> None: ... + + Id: str + + Language: str + + Name: str + + Id: str + + Language: str + + Name: str + + # Returns a string that represents the current object. + def ToString(self) -> str: + ... + + + # Determines whether the specified Object is equal to the current Object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: Object to compare with the current object + """ + ... + + + # Serves as a hash function for this type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: User, b: User) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: User, b: User) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns a string that represents the current object. + def ToString(self) -> str: + ... + + + # Determines whether the specified Object is equal to the current Object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: Object to compare with the current object + """ + ... + + + # Serves as a hash function for this type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: User, b: User) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: User, b: User) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Diagnosis: + """ + Represents a diagnosis of the patient. + + Attributes: + ClinicalDescription (str): User-defined clinical description of the diagnosis. + Code (str): The disease code from the specified code table. + CodeTable (str): Identifies the coding system table, for example, ICD-9-CM. + ClinicalDescription (str): User-defined clinical description of the diagnosis. + Code (str): The disease code from the specified code table. + CodeTable (str): Identifies the coding system table, for example, ICD-9-CM. + """ + def __init__(self) -> None: ... + + ClinicalDescription: str + + Code: str + + CodeTable: str + + ClinicalDescription: str + + Code: str + + CodeTable: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class DVHEstimationModelSummary: + """ + A summary of an DVH Estimation Model. Contains the needed information for selecting a model. + + Attributes: + Description (str): Model Description + IsPublished (bool): True if set to published state. Only published models are available for optimizing. + IsTrained (bool): True if the model contains data. + ModelDataVersion (str): Version + ModelParticleType (ParticleType): Returns particle type for the model. Either ParticleType.Proton or ParticleType.Photon. + ModelUID (str): Model UID. To be used for the Load command. + Name (str): Display Name + Revision (int): Publish revision of the model + TreatmentSite (str): Indicating the treatment site the model was created for + Description (str): Model Description + IsPublished (bool): True if set to published state. Only published models are available for optimizing. + IsTrained (bool): True if the model contains data. + ModelDataVersion (str): Version + ModelParticleType (ParticleType): Returns particle type for the model. Either ParticleType.Proton or ParticleType.Photon. + ModelUID (str): Model UID. To be used for the Load command. + Name (str): Display Name + Revision (int): Publish revision of the model + TreatmentSite (str): Indicating the treatment site the model was created for + """ + def __init__(self) -> None: ... + + Description: str + + IsPublished: bool + + IsTrained: bool + + ModelDataVersion: str + + ModelParticleType: ParticleType + + ModelUID: str + + Name: str + + Revision: int + + TreatmentSite: str + + Description: str + + IsPublished: bool + + IsTrained: bool + + ModelDataVersion: str + + ModelParticleType: ParticleType + + ModelUID: str + + Name: str + + Revision: int + + TreatmentSite: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class EnergyMode: + """ + Represents an energy mode. + + Attributes: + IsElectron (bool): Checks if the mode is electron. + IsPhoton (bool): Checks if the mode is photon. + IsProton (bool): Checks if the mode is proton. + IsElectron (bool): Checks if the mode is electron. + IsPhoton (bool): Checks if the mode is photon. + IsProton (bool): Checks if the mode is proton. + """ + def __init__(self) -> None: ... + + IsElectron: bool + + IsPhoton: bool + + IsProton: bool + + IsElectron: bool + + IsPhoton: bool + + IsProton: bool + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class EstimatedDVH: + """ + Represents an estimated Dose Volume Histogram (DVH) curve. + + Attributes: + CurveData (Array[DVHPoint]): The points of the estimated DVH curve. + PlanSetup (PlanSetup): Parent plan. + PlanSetupId (str): ID of the parent plan. + Structure (Structure): Parent structure. + StructureId (str): ID of the parent structure. + TargetDoseLevel (DoseValue): Dose level of the associated target structure. + Type (DVHEstimateType): Type of DVH estimate curve. + CurveData (Array[DVHPoint]): The points of the estimated DVH curve. + PlanSetup (PlanSetup): Parent plan. + PlanSetupId (str): ID of the parent plan. + Structure (Structure): Parent structure. + StructureId (str): ID of the parent structure. + TargetDoseLevel (DoseValue): Dose level of the associated target structure. + Type (DVHEstimateType): Type of DVH estimate curve. + """ + def __init__(self) -> None: ... + + CurveData: Array[DVHPoint] + + PlanSetup: PlanSetup + + PlanSetupId: str + + Structure: Structure + + StructureId: str + + TargetDoseLevel: DoseValue + + Type: DVHEstimateType + + CurveData: Array[DVHPoint] + + PlanSetup: PlanSetup + + PlanSetupId: str + + Structure: Structure + + StructureId: str + + TargetDoseLevel: DoseValue + + Type: DVHEstimateType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class EvaluationDose: + """ + Represents an evaluation dose that is connected to a plan that has no beams. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts the given dose value to the corresponding raw voxel value. + def DoseValueToVoxel(self, doseValue: DoseValue) -> int: + """ + Args: + doseValue: Dose value. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] For an evaluation dose (the dose of a plan that has no beams), sets the voxels of the given dose plane. Create the evaluation dose first using + def SetVoxels(self, planeIndex: int, values: Array[int]) -> None: + """ + Args: + planeIndex: Zero-based index of the plane. + values: The plane of voxel values. The size of the array must conform to the X-size and Y-size of the dose. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts the given dose value to the corresponding raw voxel value. + def DoseValueToVoxel(self, doseValue: DoseValue) -> int: + """ + Args: + doseValue: Dose value. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] For an evaluation dose (the dose of a plan that has no beams), sets the voxels of the given dose plane. Create the evaluation dose first using + def SetVoxels(self, planeIndex: int, values: Array[int]) -> None: + """ + Args: + planeIndex: Zero-based index of the plane. + values: The plane of voxel values. The size of the array must conform to the X-size and Y-size of the dose. + """ + ... + + + +class ExternalBeamTreatmentUnit: + """ + Represents a treatment machine used for delivering external beam radiotherapy. + + Attributes: + MachineDepartmentName (str): Default department associated with the machine. + MachineModel (str): The model of the treatment unit. + MachineModelName (str): The displayed name of the treatment unit model. + MachineScaleDisplayName (str): The name of the scale used in the treatment unit. + OperatingLimits (TreatmentUnitOperatingLimits): Information about operating limits for a set of treatment unit parameters. + SourceAxisDistance (float): The Source to Axis Distance (SAD). + MachineDepartmentName (str): Default department associated with the machine. + MachineModel (str): The model of the treatment unit. + MachineModelName (str): The displayed name of the treatment unit model. + MachineScaleDisplayName (str): The name of the scale used in the treatment unit. + OperatingLimits (TreatmentUnitOperatingLimits): Information about operating limits for a set of treatment unit parameters. + SourceAxisDistance (float): The Source to Axis Distance (SAD). + """ + def __init__(self) -> None: ... + + MachineDepartmentName: str + + MachineModel: str + + MachineModelName: str + + MachineScaleDisplayName: str + + OperatingLimits: TreatmentUnitOperatingLimits + + SourceAxisDistance: float + + MachineDepartmentName: str + + MachineModel: str + + MachineModelName: str + + MachineScaleDisplayName: str + + OperatingLimits: TreatmentUnitOperatingLimits + + SourceAxisDistance: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonBeam: + """ + Proton beam interface. + + Attributes: + AirGap (float): The user-defined air gap in mm. + BeamLineStatus (ProtonBeamLineStatus): Determine beamline's status + DistalTargetMargin (float): Distal end margin, in mm. + LateralMargins (VRect[float]): The lateral margins of this field, in mm. + LateralSpreadingDevices (List[LateralSpreadingDevice]): The lateral spreading devices in this beam. + NominalRange (float): The nominal range of the beam line, in mm. + NominalSOBPWidth (float): The nominal width of the Spread Out Bragg Peak, in mm. + OptionId (str): The identifier of the selected beam-line setting for proton beams. For a typical double scattering system, for example, an option is a combination of range modulator, second scatterer, and nominal energy that correspond to a broad proton beam with a certain range in patient and field size. Returns null if the option is undefined. + PatientSupportId (str): Patient support identifier. Returns null if undefined. + PatientSupportType (PatientSupportType): Patient support type. + IonControlPoints (IonControlPointCollection): Gets the proton control points. + ProximalTargetMargin (float): Proximal end margin, in mm. + RangeModulators (List[RangeModulator]): The range modulator devices in this beam. + RangeShifters (List[RangeShifter]): The range shifter devices in this beam. + ScanMode (IonBeamScanMode): The method of beam scanning to be used during treatment. + SnoutId (str): The Snout identifier. Returns null if undefined. + SnoutPosition (float): The snout position in cm. Returns System::Double::NaN if undefined. + TargetStructure (Structure): Returns the field target structure. Null if the field target is not defined (and axial margins are defined around the isocenter level). + VirtualSADX (float): Virtual Source-to-Axis Distance X, in mm. + VirtualSADY (float): Virtual Source-to-Axis Distance Y, in mm. + AirGap (float): The user-defined air gap in mm. + BeamLineStatus (ProtonBeamLineStatus): Determine beamline's status + DistalTargetMargin (float): Distal end margin, in mm. + LateralMargins (VRect[float]): The lateral margins of this field, in mm. + LateralSpreadingDevices (List[LateralSpreadingDevice]): The lateral spreading devices in this beam. + NominalRange (float): The nominal range of the beam line, in mm. + NominalSOBPWidth (float): The nominal width of the Spread Out Bragg Peak, in mm. + OptionId (str): The identifier of the selected beam-line setting for proton beams. For a typical double scattering system, for example, an option is a combination of range modulator, second scatterer, and nominal energy that correspond to a broad proton beam with a certain range in patient and field size. Returns null if the option is undefined. + PatientSupportId (str): Patient support identifier. Returns null if undefined. + PatientSupportType (PatientSupportType): Patient support type. + IonControlPoints (IonControlPointCollection): Gets the proton control points. + ProximalTargetMargin (float): Proximal end margin, in mm. + RangeModulators (List[RangeModulator]): The range modulator devices in this beam. + RangeShifters (List[RangeShifter]): The range shifter devices in this beam. + ScanMode (IonBeamScanMode): The method of beam scanning to be used during treatment. + SnoutId (str): The Snout identifier. Returns null if undefined. + SnoutPosition (float): The snout position in cm. Returns System::Double::NaN if undefined. + TargetStructure (Structure): Returns the field target structure. Null if the field target is not defined (and axial margins are defined around the isocenter level). + VirtualSADX (float): Virtual Source-to-Axis Distance X, in mm. + VirtualSADY (float): Virtual Source-to-Axis Distance Y, in mm. + """ + def __init__(self) -> None: ... + + AirGap: float + + BeamLineStatus: ProtonBeamLineStatus + + DistalTargetMargin: float + + LateralMargins: VRect[float] + + LateralSpreadingDevices: List[LateralSpreadingDevice] + + NominalRange: float + + NominalSOBPWidth: float + + OptionId: str + + PatientSupportId: str + + PatientSupportType: PatientSupportType + + IonControlPoints: IonControlPointCollection + + ProximalTargetMargin: float + + RangeModulators: List[RangeModulator] + + RangeShifters: List[RangeShifter] + + ScanMode: IonBeamScanMode + + SnoutId: str + + SnoutPosition: float + + TargetStructure: Structure + + VirtualSADX: float + + VirtualSADY: float + + AirGap: float + + BeamLineStatus: ProtonBeamLineStatus + + DistalTargetMargin: float + + LateralMargins: VRect[float] + + LateralSpreadingDevices: List[LateralSpreadingDevice] + + NominalRange: float + + NominalSOBPWidth: float + + OptionId: str + + PatientSupportId: str + + PatientSupportType: PatientSupportType + + IonControlPoints: IonControlPointCollection + + ProximalTargetMargin: float + + RangeModulators: List[RangeModulator] + + RangeShifters: List[RangeShifter] + + ScanMode: IonBeamScanMode + + SnoutId: str + + SnoutPosition: float + + TargetStructure: Structure + + VirtualSADX: float + + VirtualSADY: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Modifies the proton beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. DVH Estimations of the plan, if any, are cleared. + def ApplyParameters(self, beamParams: BeamParameters) -> None: + """ + Args: + beamParams: The parameters to apply to the beam. + """ + ... + + + # Returns a proton field deliverability status by room ID. Proton field deliverability status can be Deliverable, Undeliverable or NotCalculated. + def GetDeliveryTimeStatusByRoomId(self, roomId: str) -> ProtonDeliveryTimeStatus: + """ + Args: + roomId: Treatment room ID. + """ + ... + + + # Returns a new editable copy of the ion beam parameters. The returned IonBeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another IonBeamParameters object. + def GetEditableParameters(self) -> IonBeamParameters: + ... + + + # Returns a proton delivery time by room ID in seconds. Returns System::Double::NaN if delivery time status is Undeliverable or NotCalculated. + def GetProtonDeliveryTimeByRoomIdAsNumber(self, roomId: str) -> float: + """ + Args: + roomId: Treatment room ID. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Modifies the proton beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. DVH Estimations of the plan, if any, are cleared. + def ApplyParameters(self, beamParams: BeamParameters) -> None: + """ + Args: + beamParams: The parameters to apply to the beam. + """ + ... + + + # Returns a proton field deliverability status by room ID. Proton field deliverability status can be Deliverable, Undeliverable or NotCalculated. + def GetDeliveryTimeStatusByRoomId(self, roomId: str) -> ProtonDeliveryTimeStatus: + """ + Args: + roomId: Treatment room ID. + """ + ... + + + # Returns a new editable copy of the ion beam parameters. The returned IonBeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another IonBeamParameters object. + def GetEditableParameters(self) -> IonBeamParameters: + ... + + + # Returns a proton delivery time by room ID in seconds. Returns System::Double::NaN if delivery time status is Undeliverable or NotCalculated. + def GetProtonDeliveryTimeByRoomIdAsNumber(self, roomId: str) -> float: + """ + Args: + roomId: Treatment room ID. + """ + ... + + + +class IonControlPoint: + """ + Proton control point interface. + + Attributes: + FinalSpotList (IonSpotCollection): Gets a cached copy of the post-processed final spot list. + LateralSpreadingDeviceSettings (List[LateralSpreadingDeviceSettings]): The lateral spreading device settings. + NominalBeamEnergy (float): Nominal beam energy, in megavolts. + NumberOfPaintings (int): The number of times the scan pattern shall be applied at the current control point. + RangeModulatorSettings (List[RangeModulatorSettings]): The range modulator settings. + RangeShifterSettings (List[RangeShifterSettings]): The range shifter settings. + RawSpotList (IonSpotCollection): Gets a cached copy of the raw spot list. + ScanningSpotSizeX (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY X direction (mm). + ScanningSpotSizeY (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY Y direction (mm). + ScanSpotTuneId (str): User-supplied or machine code identifier for machine configuration to produce beam spot. This may be the nominal spot size or some other machine-specific value. Returns null if undefined. + SnoutPosition (float): The snout position, in mm. + FinalSpotList (IonSpotCollection): Gets a cached copy of the post-processed final spot list. + LateralSpreadingDeviceSettings (List[LateralSpreadingDeviceSettings]): The lateral spreading device settings. + NominalBeamEnergy (float): Nominal beam energy, in megavolts. + NumberOfPaintings (int): The number of times the scan pattern shall be applied at the current control point. + RangeModulatorSettings (List[RangeModulatorSettings]): The range modulator settings. + RangeShifterSettings (List[RangeShifterSettings]): The range shifter settings. + RawSpotList (IonSpotCollection): Gets a cached copy of the raw spot list. + ScanningSpotSizeX (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY X direction (mm). + ScanningSpotSizeY (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY Y direction (mm). + ScanSpotTuneId (str): User-supplied or machine code identifier for machine configuration to produce beam spot. This may be the nominal spot size or some other machine-specific value. Returns null if undefined. + SnoutPosition (float): The snout position, in mm. + """ + def __init__(self) -> None: ... + + FinalSpotList: IonSpotCollection + + LateralSpreadingDeviceSettings: List[LateralSpreadingDeviceSettings] + + NominalBeamEnergy: float + + NumberOfPaintings: int + + RangeModulatorSettings: List[RangeModulatorSettings] + + RangeShifterSettings: List[RangeShifterSettings] + + RawSpotList: IonSpotCollection + + ScanningSpotSizeX: float + + ScanningSpotSizeY: float + + ScanSpotTuneId: str + + SnoutPosition: float + + FinalSpotList: IonSpotCollection + + LateralSpreadingDeviceSettings: List[LateralSpreadingDeviceSettings] + + NominalBeamEnergy: float + + NumberOfPaintings: int + + RangeModulatorSettings: List[RangeModulatorSettings] + + RangeShifterSettings: List[RangeShifterSettings] + + RawSpotList: IonSpotCollection + + ScanningSpotSizeX: float + + ScanningSpotSizeY: float + + ScanSpotTuneId: str + + SnoutPosition: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonControlPointCollection: + """ + Represents a collection of machine parameters that describe the planned proton beam. + + Attributes: + Count (int): The number of control points in the collection. + Count (int): The number of control points in the collection. + """ + def __init__(self) -> None: ... + + Count: int + + Count: int + + # Retrieves enumerator for IonControlPoints in the collection. + def GetEnumerator(self) -> Iterable[IonControlPoint]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Retrieves enumerator for IonControlPoints in the collection. + def GetEnumerator(self) -> Iterable[IonControlPoint]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonControlPointPair: + """ + An editable copy of a control point pair (the pair of the start control point with an even index, and the end control point with an odd index). + + Attributes: + EndControlPoint (IonControlPointParameters): The end control point in the pair, with an odd index. + FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the editable post-processed final spot list. + NominalBeamEnergy (float): Nominal beam energy in megavolts. + RawSpotList (IonSpotParametersCollection): Gets a cached copy of the editable raw spot list + StartControlPoint (IonControlPointParameters): Start control point in the pair, with an even index from zero. + StartIndex (int): The index of the start control point in the pair. The index should be an even number starting from zero. + EndControlPoint (IonControlPointParameters): The end control point in the pair, with an odd index. + FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the editable post-processed final spot list. + NominalBeamEnergy (float): Nominal beam energy in megavolts. + RawSpotList (IonSpotParametersCollection): Gets a cached copy of the editable raw spot list + StartControlPoint (IonControlPointParameters): Start control point in the pair, with an even index from zero. + StartIndex (int): The index of the start control point in the pair. The index should be an even number starting from zero. + + Note: + To apply the parameters, call the + """ + def __init__(self) -> None: ... + + EndControlPoint: IonControlPointParameters + + FinalSpotList: IonSpotParametersCollection + + NominalBeamEnergy: float + + RawSpotList: IonSpotParametersCollection + + StartControlPoint: IonControlPointParameters + + StartIndex: int + + EndControlPoint: IonControlPointParameters + + FinalSpotList: IonSpotParametersCollection + + NominalBeamEnergy: float + + RawSpotList: IonSpotParametersCollection + + StartControlPoint: IonControlPointParameters + + StartIndex: int + + # Resizes the list of final spots. + def ResizeFinalSpotList(self, count: int) -> None: + """ + Args: + count: New length of the list. + """ + ... + + + # Resizes the list of raw spots. + def ResizeRawSpotList(self, count: int) -> None: + """ + Args: + count: New length of the list. + """ + ... + + + # Resizes the list of final spots. + def ResizeFinalSpotList(self, count: int) -> None: + """ + Args: + count: New length of the list. + """ + ... + + + # Resizes the list of raw spots. + def ResizeRawSpotList(self, count: int) -> None: + """ + Args: + count: New length of the list. + """ + ... + + + +class IonControlPointPairCollection: + """ + A collection of editable copies of control point pairs that describe the planned proton beam. + + Attributes: + Count (int): The number of control point pairs in the collection. + Count (int): The number of control point pairs in the collection. + + Note: + To apply the parameters, call the + """ + def __init__(self) -> None: ... + + Count: int + + Count: int + + # Retrieves enumerator for IonControlPointPairs in the collection. + def GetEnumerator(self) -> Iterable[IonControlPointPair]: + ... + + + # Retrieves enumerator for IonControlPointPairs in the collection. + def GetEnumerator(self) -> Iterable[IonControlPointPair]: + ... + + + +class IonControlPointParameters: + """ + An editable copy of the parameters of a proton control point. + + Attributes: + FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the post-processed final spot list. + RawSpotList (IonSpotParametersCollection): Gets a cached copy of the raw spot list. + SnoutPosition (float): Snout position in centimeters. + FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the post-processed final spot list. + RawSpotList (IonSpotParametersCollection): Gets a cached copy of the raw spot list. + SnoutPosition (float): Snout position in centimeters. + + Note: + To apply the parameters, call the ApplyParameters method of the Beam class. Because the parameters are simple copies, they do not reflect the current state of the data model. + """ + def __init__(self) -> None: ... + + FinalSpotList: IonSpotParametersCollection + + RawSpotList: IonSpotParametersCollection + + SnoutPosition: float + + FinalSpotList: IonSpotParametersCollection + + RawSpotList: IonSpotParametersCollection + + SnoutPosition: float + + +class IonSpot: + """ + The proton scanning spot interface that contains the 3D spot position and spot weight. + + Attributes: + Position (VVector): Read-only spot position in X, Y, and Z directions. + Weight (float): Read-only spot weight. + Position (VVector): Read-only spot position in X, Y, and Z directions. + Weight (float): Read-only spot weight. + """ + def __init__(self) -> None: ... + + Position: VVector + + Weight: float + + Position: VVector + + Weight: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonSpotCollection: + """ + Interface for the proton scanning spot list. + + Attributes: + Count (int): The number of scanning spots in this collection (spot list). + Count (int): The number of scanning spots in this collection (spot list). + """ + def __init__(self) -> None: ... + + Count: int + + Count: int + + # Retrieves enumerator for IonSpots in the collection. + def GetEnumerator(self) -> Iterable[IonSpot]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Retrieves enumerator for IonSpots in the collection. + def GetEnumerator(self) -> Iterable[IonSpot]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonSpotParameters: + """ + Interface for the proton scanning spot that contains the 3D spot position and spot weight. + + Attributes: + Weight (float): Editable spot weight. + X (float): Editable X position. + Y (float): Editable Y position. + Weight (float): Editable spot weight. + X (float): Editable X position. + Y (float): Editable Y position. + """ + def __init__(self) -> None: ... + + Weight: float + + X: float + + Y: float + + Weight: float + + X: float + + Y: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class IonSpotParametersCollection: + """ + Interface for the editable proton scanning spot list. + + Attributes: + Count (int): The number of editable scanning spots in this collection (spot list). + Count (int): The number of editable scanning spots in this collection (spot list). + """ + def __init__(self) -> None: ... + + Count: int + + Count: int + + # Retrieves enumerator for IonSpotParameterss in the collection. + def GetEnumerator(self) -> Iterable[IonSpotParameters]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Retrieves enumerator for IonSpotParameterss in the collection. + def GetEnumerator(self) -> Iterable[IonSpotParameters]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class LateralSpreadingDevice: + """ + The lateral spreading device. + + Attributes: + Type (LateralSpreadingDeviceType): The type of the device. + Type (LateralSpreadingDeviceType): The type of the device. + """ + def __init__(self) -> None: ... + + Type: LateralSpreadingDeviceType + + Type: LateralSpreadingDeviceType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class LateralSpreadingDeviceSettings: + """ + Settings for the lateral spreading device. + + Attributes: + IsocenterToLateralSpreadingDeviceDistance (float): Distance from the isocenter to the downstream edge of the lateral spreading device (mm) at the current control point. + LateralSpreadingDeviceSetting (str): Machine-specific setting. + LateralSpreadingDeviceWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the lateral spreading device at the central axis for the beam energy incident upon the device. + ReferencedLateralSpreadingDevice (LateralSpreadingDevice): The referenced lateral spreading device. + IsocenterToLateralSpreadingDeviceDistance (float): Distance from the isocenter to the downstream edge of the lateral spreading device (mm) at the current control point. + LateralSpreadingDeviceSetting (str): Machine-specific setting. + LateralSpreadingDeviceWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the lateral spreading device at the central axis for the beam energy incident upon the device. + ReferencedLateralSpreadingDevice (LateralSpreadingDevice): The referenced lateral spreading device. + """ + def __init__(self) -> None: ... + + IsocenterToLateralSpreadingDeviceDistance: float + + LateralSpreadingDeviceSetting: str + + LateralSpreadingDeviceWaterEquivalentThickness: float + + ReferencedLateralSpreadingDevice: LateralSpreadingDevice + + IsocenterToLateralSpreadingDeviceDistance: float + + LateralSpreadingDeviceSetting: str + + LateralSpreadingDeviceWaterEquivalentThickness: float + + ReferencedLateralSpreadingDevice: LateralSpreadingDevice + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationEUDObjective: + """ + A gEUD objective is an exact, upper or lower objective. An exact gEUD objective defines an exact dose value that a target structure should receive. An upper gEUD objective defines the maximum dose value that a structure should receive. A lower gEUD objective defines the minimum dose value that a target structure should receive. Generalized Equivalent Uniform Dose (gEUD) is a uniform dose that, if delivered over the same number of fractions, yields the same radiobiological effect as the non-uniform dose distribution of interest. + + Attributes: + Dose (DoseValue): The dose value for the objective. + ParameterA (float): A tissue-specific parameter that illustrates the effect of the volume on the dose. + Dose (DoseValue): The dose value for the objective. + ParameterA (float): A tissue-specific parameter that illustrates the effect of the volume on the dose. + """ + def __init__(self) -> None: ... + + Dose: DoseValue + + ParameterA: float + + Dose: DoseValue + + ParameterA: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationExcludeStructureParameter: + """ + Structures that have this parameter are excluded from the optimization. + + Attributes: + Structure (Structure): The structure to be excluded. + Structure (Structure): The structure to be excluded. + """ + def __init__(self) -> None: ... + + Structure: Structure + + Structure: Structure + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationIMRTBeamParameter: + """ + Beam-specific optimization parameter for IMRT optimization. + + Attributes: + Beam (Beam): The beam to which this parameter belongs. + BeamId (str): The identifier of the beam. + Excluded (bool): True if the beam is excluded from the optimization. + FixedJaws (bool): If true, the collimator jaw positions of the beam remain the same during the optimization. + SmoothX (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. + SmoothY (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. + Beam (Beam): The beam to which this parameter belongs. + BeamId (str): The identifier of the beam. + Excluded (bool): True if the beam is excluded from the optimization. + FixedJaws (bool): If true, the collimator jaw positions of the beam remain the same during the optimization. + SmoothX (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. + SmoothY (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. + """ + def __init__(self) -> None: ... + + Beam: Beam + + BeamId: str + + Excluded: bool + + FixedJaws: bool + + SmoothX: float + + SmoothY: float + + Beam: Beam + + BeamId: str + + Excluded: bool + + FixedJaws: bool + + SmoothX: float + + SmoothY: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationJawTrackingUsedParameter: + """ + An optimization parameter for using jaw tracking in VMAT optimization. The parameter exists if OptimizationSetup.UseJawTracking has been set to true. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationLineObjective: + """ + A line objective is a collection of point objectives that have the same priority. It is used to limit the dose in a given structure. + + Attributes: + CurveData (Array[DVHPoint]): The points in the line objective. + CurveData (Array[DVHPoint]): The points in the line objective. + """ + def __init__(self) -> None: ... + + CurveData: Array[DVHPoint] + + CurveData: Array[DVHPoint] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationMeanDoseObjective: + """ + A mean objective defines the mean dose that should not be exceeded. The mean objective is used to decrease the dose that a structure receives. + + Attributes: + Dose (DoseValue): The dose value for the objective. + Dose (DoseValue): The dose value for the objective. + """ + def __init__(self) -> None: ... + + Dose: DoseValue + + Dose: DoseValue + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationNormalTissueParameter: + """ + An optimization parameter for the normal tissue objective. + + Attributes: + DistanceFromTargetBorderInMM (float): Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + EndDosePercentage (float): Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + FallOff (float): Determines the steepness of the normal tissue objective fall-off. The value is positive. + IsAutomatic (bool): Returns True if an automatic normal tissue objective (NTO) is used. The automatic NTO adapts to the patient anatomy and the optimization objectives, and automatically determines the dose fall-off criteria. When an automatic NTO is used, the other properties of this object, except Priority, are not used. + IsAutomaticSbrt (bool): Returns True if an automatic SBRT normal tissue objective (NTO) is used. When an automatic SBRT NTO is used, the other properties of this object, except Priority, are not used. + IsAutomaticSrs (bool): Returns True if an automatic SRS normal tissue objective (NTO) is used. When an automatic SRS NTO is used, the other properties of this object, except Priority, are not used. + Priority (float): Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + StartDosePercentage (float): Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + DistanceFromTargetBorderInMM (float): Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. + EndDosePercentage (float): Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. + FallOff (float): Determines the steepness of the normal tissue objective fall-off. The value is positive. + IsAutomatic (bool): Returns True if an automatic normal tissue objective (NTO) is used. The automatic NTO adapts to the patient anatomy and the optimization objectives, and automatically determines the dose fall-off criteria. When an automatic NTO is used, the other properties of this object, except Priority, are not used. + IsAutomaticSbrt (bool): Returns True if an automatic SBRT normal tissue objective (NTO) is used. When an automatic SBRT NTO is used, the other properties of this object, except Priority, are not used. + IsAutomaticSrs (bool): Returns True if an automatic SRS normal tissue objective (NTO) is used. When an automatic SRS NTO is used, the other properties of this object, except Priority, are not used. + Priority (float): Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. + StartDosePercentage (float): Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. + """ + def __init__(self) -> None: ... + + DistanceFromTargetBorderInMM: float + + EndDosePercentage: float + + FallOff: float + + IsAutomatic: bool + + IsAutomaticSbrt: bool + + IsAutomaticSrs: bool + + Priority: float + + StartDosePercentage: float + + DistanceFromTargetBorderInMM: float + + EndDosePercentage: float + + FallOff: float + + IsAutomatic: bool + + IsAutomaticSbrt: bool + + IsAutomaticSrs: bool + + Priority: float + + StartDosePercentage: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationObjective: + """ + Provides a common base type for all structure-specific optimization objectives. + + Attributes: + Operator (OptimizationObjectiveOperator): Specifies the type of the objective (upper, lower, exact). + Priority (float): The priority of the objective as a positive double. + Structure (Structure): The structure to which this optimization objective belongs. + StructureId (str): The identifier of the structure. + Operator (OptimizationObjectiveOperator): Specifies the type of the objective (upper, lower, exact). + Priority (float): The priority of the objective as a positive double. + Structure (Structure): The structure to which this optimization objective belongs. + StructureId (str): The identifier of the structure. + """ + def __init__(self) -> None: ... + + Operator: OptimizationObjectiveOperator + + Priority: float + + Structure: Structure + + StructureId: str + + Operator: OptimizationObjectiveOperator + + Priority: float + + Structure: Structure + + StructureId: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Determines whether the specified object is equal to the current object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: The object to compare with the current object. + """ + ... + + + # Serves as a hash function for a particular type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Determines whether the specified object is equal to the current object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: The object to compare with the current object. + """ + ... + + + # Serves as a hash function for a particular type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + +class OptimizationParameter: + """ + Provides a common base type for all optimization parameters. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Determines whether the specified object is equal to the current object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: The object to compare with the current object. + """ + ... + + + # Serves as a hash function for a particular type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Determines whether the specified object is equal to the current object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: The object to compare with the current object. + """ + ... + + + # Serves as a hash function for a particular type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: + """ + Args: + a: The first operand. + b: The second operand. + """ + ... + + + +class OptimizationPointCloudParameter: + """ + Structure-specific parameter for point cloud optimization. Relevant if the optimization algorithm uses a point cloud. The point cloud parameters are automatically created with default values when you add other structure-specific parameters or objectives in the optimization setup. + + Attributes: + PointResolutionInMM (float): The point cloud resolution. + Structure (Structure): The structure whose parameters these are. + PointResolutionInMM (float): The point cloud resolution. + Structure (Structure): The structure whose parameters these are. + """ + def __init__(self) -> None: ... + + PointResolutionInMM: float + + Structure: Structure + + PointResolutionInMM: float + + Structure: Structure + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationPointObjective: + """ + A point objective is either an upper or lower objective. An upper objective is used to limit the dose in a given structure. A lower objective is used to define the desired dose levels in target structures. + + Attributes: + Dose (DoseValue): The dose value for the objective. + Volume (float): Percentage of the structure volume (0-100 %) to receive the dose. + Dose (DoseValue): The dose value for the objective. + Volume (float): Percentage of the structure volume (0-100 %) to receive the dose. + """ + def __init__(self) -> None: ... + + Dose: DoseValue + + Volume: float + + Dose: DoseValue + + Volume: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OptimizationVMATAvoidanceSectors: + """ + Beam-specific optimization parameter for VMAT Avoidance sectors. + + Attributes: + AvoidanceSector1 (OptimizationAvoidanceSector): Avoidance Sector 1. + AvoidanceSector2 (OptimizationAvoidanceSector): Avoidance Sector 2. + Beam (Beam): The beam to which this parameter belongs. + IsValid (bool): Is Avoidance Sectors valid. + ValidationError (str): Validation error if any. + AvoidanceSector1 (OptimizationAvoidanceSector): Avoidance Sector 1. + AvoidanceSector2 (OptimizationAvoidanceSector): Avoidance Sector 2. + Beam (Beam): The beam to which this parameter belongs. + IsValid (bool): Is Avoidance Sectors valid. + ValidationError (str): Validation error if any. + """ + def __init__(self) -> None: ... + + AvoidanceSector1: OptimizationAvoidanceSector + + AvoidanceSector2: OptimizationAvoidanceSector + + Beam: Beam + + IsValid: bool + + ValidationError: str + + AvoidanceSector1: OptimizationAvoidanceSector + + AvoidanceSector2: OptimizationAvoidanceSector + + Beam: Beam + + IsValid: bool + + ValidationError: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PatientSupportDevice: + """ + Represents a proton patient support device. + + Attributes: + PatientSupportAccessoryCode (str): Patient support device accessory code. + PatientSupportDeviceType (str): Type of the patient support device. + PatientSupportAccessoryCode (str): Patient support device accessory code. + PatientSupportDeviceType (str): Type of the patient support device. + """ + def __init__(self) -> None: ... + + PatientSupportAccessoryCode: str + + PatientSupportDeviceType: str + + PatientSupportAccessoryCode: str + + PatientSupportDeviceType: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PlanningItemDose: + """ + Represents a dose that is connected to a plan setup or a plan sum. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PlanSumComponent: + """ + Represents a component plan of a plan sum. + + Attributes: + PlanSetupId (str): The unique identification of the plan within the course. + PlanSumOperation (PlanSumOperation): The summing operation (+ or -) that defines how the dose of a component plan contributes to the plan sum. + PlanWeight (float): The weight of a component plan included in the plan sum. + PlanSetupId (str): The unique identification of the plan within the course. + PlanSumOperation (PlanSumOperation): The summing operation (+ or -) that defines how the dose of a component plan contributes to the plan sum. + PlanWeight (float): The weight of a component plan included in the plan sum. + """ + def __init__(self) -> None: ... + + PlanSetupId: str + + PlanSumOperation: PlanSumOperation + + PlanWeight: float + + PlanSetupId: str + + PlanSumOperation: PlanSumOperation + + PlanWeight: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PlanTreatmentSession: + """ + Plan in the treatment session. + + Attributes: + PlanSetup (PlanSetup): Scheduled or treated plan. + Status (TreatmentSessionStatus): Plan status in the treatment session. + TreatmentSession (TreatmentSession): Treatment session. + PlanSetup (PlanSetup): Scheduled or treated plan. + Status (TreatmentSessionStatus): Plan status in the treatment session. + TreatmentSession (TreatmentSession): Treatment session. + """ + def __init__(self) -> None: ... + + PlanSetup: PlanSetup + + Status: TreatmentSessionStatus + + TreatmentSession: TreatmentSession + + PlanSetup: PlanSetup + + Status: TreatmentSessionStatus + + TreatmentSession: TreatmentSession + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PlanUncertainty: + """ + Provides access to Plan Uncertainty parameters. For more information, see Eclipse Photon and Electron Instructions for Use. + + Attributes: + BeamUncertainties (List[BeamUncertainty]): Collection of beam uncertainty doses. + CalibrationCurveError (float): The calibration curve error of the plan uncertainty in percentage. Returns 100 for 100%. NaN if not defined. + DisplayName (str): The display name of the plan variation, including the parameter values. + Dose (Dose): The dose of this plan variation. + IsocenterShift (VVector): The isocenter shift of the plan uncertainty. + UncertaintyType (PlanUncertaintyType): Type of uncertainty, which determines how and in what context the defined parameters are to be used. + BeamUncertainties (List[BeamUncertainty]): Collection of beam uncertainty doses. + CalibrationCurveError (float): The calibration curve error of the plan uncertainty in percentage. Returns 100 for 100%. NaN if not defined. + DisplayName (str): The display name of the plan variation, including the parameter values. + Dose (Dose): The dose of this plan variation. + IsocenterShift (VVector): The isocenter shift of the plan uncertainty. + UncertaintyType (PlanUncertaintyType): Type of uncertainty, which determines how and in what context the defined parameters are to be used. + """ + def __init__(self) -> None: ... + + BeamUncertainties: List[BeamUncertainty] + + CalibrationCurveError: float + + DisplayName: str + + Dose: Dose + + IsocenterShift: VVector + + UncertaintyType: PlanUncertaintyType + + BeamUncertainties: List[BeamUncertainty] + + CalibrationCurveError: float + + DisplayName: str + + Dose: Dose + + IsocenterShift: VVector + + UncertaintyType: PlanUncertaintyType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns cumulative Dose Volume Histogram (DVH) data for this uncertainty plan. + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """ + Args: + structure: Structure, for which the DVH data is requested. + dosePresentation: Requested dose presentation mode (absolute or relative). Note that only absolute dose is supported for PlanSums. + volumePresentation: Requested volume presentation mode. + binWidth: Requested width of the bin. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Returns cumulative Dose Volume Histogram (DVH) data for this uncertainty plan. + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """ + Args: + structure: Structure, for which the DVH data is requested. + dosePresentation: Requested dose presentation mode (absolute or relative). Note that only absolute dose is supported for PlanSums. + volumePresentation: Requested volume presentation mode. + binWidth: Requested width of the bin. + """ + ... + + + +class RadioactiveSource: + """ + Represents a radioactive source installed into a + + Attributes: + CalibrationDate (Optional[datetime]): The calibration date for the strength of this radioactive source. + NominalActivity (bool): Defines whether source decay is accounted for in treatment planning. If the value is true, the dose calculation uses the source at its calibration activity (nominal activity). If the value is false, the source strength is decayed to the treatment activity based on the treatment date of the plan where the source is used. + RadioactiveSourceModel (RadioactiveSourceModel): The brachytherapy radioactive source model associated with this radioactive source. + SerialNumber (str): The serial number of this radioactive source. + Strength (float): The source strength for the radioactive source on the calibration date in cGy cm^2/h. + CalibrationDate (Optional[datetime]): The calibration date for the strength of this radioactive source. + NominalActivity (bool): Defines whether source decay is accounted for in treatment planning. If the value is true, the dose calculation uses the source at its calibration activity (nominal activity). If the value is false, the source strength is decayed to the treatment activity based on the treatment date of the plan where the source is used. + RadioactiveSourceModel (RadioactiveSourceModel): The brachytherapy radioactive source model associated with this radioactive source. + SerialNumber (str): The serial number of this radioactive source. + Strength (float): The source strength for the radioactive source on the calibration date in cGy cm^2/h. + """ + def __init__(self) -> None: ... + + CalibrationDate: Optional[datetime] + + NominalActivity: bool + + RadioactiveSourceModel: RadioactiveSourceModel + + SerialNumber: str + + Strength: float + + CalibrationDate: Optional[datetime] + + NominalActivity: bool + + RadioactiveSourceModel: RadioactiveSourceModel + + SerialNumber: str + + Strength: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RadioactiveSourceModel: + """ + The radioactive source model represents the details of the radioactive source used in brachytherapy. It encapsulates the source isotope, dimensions, and dose calculation parameters. + + Attributes: + ActiveSize (VVector): The active size of the modeled radioactive source in x, y, and z dimensions in millimeters. x represents the source width, y represents the source height, and z the source length. + ActivityConversionFactor (float): The activity-kerma conversion factor is used for converting activity (in mCi) to air-kerma strength (in U = cGy cm^2 / h). The unit of the factor is [U / mCi]. + CalculationModel (str): The dose calculation type used with this source model. Possible values are "Point source" and "Linear source". + DoseRateConstant (float): A conversion factor from the air-kerma strength to the dose rate in tissue. The unit of the dose rate constant is cGy / (h U). + HalfLife (float): The half life of the isotope in seconds. + LiteratureReference (str): The reference to the scientific publications on which the source model is based. + Manufacturer (str): The manufacturer of the modeled radioactive source. + SourceType (str): The DICOM source type. Possible values are "Point", "Line", "Cylinder", and "Sphere". + Status (str): The status of this source model. The status can be either "Unapproved", "Commissioning", "Approved", or "Retired". + StatusDate (Optional[datetime]): The time when the status of the source model was set. + StatusUserName (str): The name of the user who last set the status of the source model. + ActiveSize (VVector): The active size of the modeled radioactive source in x, y, and z dimensions in millimeters. x represents the source width, y represents the source height, and z the source length. + ActivityConversionFactor (float): The activity-kerma conversion factor is used for converting activity (in mCi) to air-kerma strength (in U = cGy cm^2 / h). The unit of the factor is [U / mCi]. + CalculationModel (str): The dose calculation type used with this source model. Possible values are "Point source" and "Linear source". + DoseRateConstant (float): A conversion factor from the air-kerma strength to the dose rate in tissue. The unit of the dose rate constant is cGy / (h U). + HalfLife (float): The half life of the isotope in seconds. + LiteratureReference (str): The reference to the scientific publications on which the source model is based. + Manufacturer (str): The manufacturer of the modeled radioactive source. + SourceType (str): The DICOM source type. Possible values are "Point", "Line", "Cylinder", and "Sphere". + Status (str): The status of this source model. The status can be either "Unapproved", "Commissioning", "Approved", or "Retired". + StatusDate (Optional[datetime]): The time when the status of the source model was set. + StatusUserName (str): The name of the user who last set the status of the source model. + """ + def __init__(self) -> None: ... + + ActiveSize: VVector + + ActivityConversionFactor: float + + CalculationModel: str + + DoseRateConstant: float + + HalfLife: float + + LiteratureReference: str + + Manufacturer: str + + SourceType: str + + Status: str + + StatusDate: Optional[datetime] + + StatusUserName: str + + ActiveSize: VVector + + ActivityConversionFactor: float + + CalculationModel: str + + DoseRateConstant: float + + HalfLife: float + + LiteratureReference: str + + Manufacturer: str + + SourceType: str + + Status: str + + StatusDate: Optional[datetime] + + StatusUserName: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RangeModulator: + """ + The range modulator device. + + Attributes: + Type (RangeModulatorType): The type of the device. + Type (RangeModulatorType): The type of the device. + """ + def __init__(self) -> None: ... + + Type: RangeModulatorType + + Type: RangeModulatorType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RangeModulatorSettings: + """ + Range modulator settings. + + Attributes: + IsocenterToRangeModulatorDistance (float): Distance from the isocenter to the downstream edge of the range modulator (mm) at the current control point. + RangeModulatorGatingStartValue (float): Start position defines the range modulator position at which the beam is switched on. + RangeModulatorGatingStarWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Start Value. + RangeModulatorGatingStopValue (float): Stop position defines the range modulator position at which the beam is switched off. + RangeModulatorGatingStopWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Stop Value. + ReferencedRangeModulator (RangeModulator): The referenced range modulator. + IsocenterToRangeModulatorDistance (float): Distance from the isocenter to the downstream edge of the range modulator (mm) at the current control point. + RangeModulatorGatingStartValue (float): Start position defines the range modulator position at which the beam is switched on. + RangeModulatorGatingStarWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Start Value. + RangeModulatorGatingStopValue (float): Stop position defines the range modulator position at which the beam is switched off. + RangeModulatorGatingStopWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Stop Value. + ReferencedRangeModulator (RangeModulator): The referenced range modulator. + """ + def __init__(self) -> None: ... + + IsocenterToRangeModulatorDistance: float + + RangeModulatorGatingStartValue: float + + RangeModulatorGatingStarWaterEquivalentThickness: float + + RangeModulatorGatingStopValue: float + + RangeModulatorGatingStopWaterEquivalentThickness: float + + ReferencedRangeModulator: RangeModulator + + IsocenterToRangeModulatorDistance: float + + RangeModulatorGatingStartValue: float + + RangeModulatorGatingStarWaterEquivalentThickness: float + + RangeModulatorGatingStopValue: float + + RangeModulatorGatingStopWaterEquivalentThickness: float + + ReferencedRangeModulator: RangeModulator + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RangeShifter: + """ + The range shifter device. + + Attributes: + Type (RangeShifterType): The type of the device. + Type (RangeShifterType): The type of the device. + """ + def __init__(self) -> None: ... + + Type: RangeShifterType + + Type: RangeShifterType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RangeShifterSettings: + """ + Range shifter settings. + + Attributes: + IsocenterToRangeShifterDistance (float): Distance from the isocenter to the downstream edge of the range shifter (mm) at the current control point. + RangeShifterSetting (str): Machine-specific setting. + RangeShifterWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range shifter at the central axis for the beam energy incident upon the device. + ReferencedRangeShifter (RangeShifter): The referenced range shifter. + IsocenterToRangeShifterDistance (float): Distance from the isocenter to the downstream edge of the range shifter (mm) at the current control point. + RangeShifterSetting (str): Machine-specific setting. + RangeShifterWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range shifter at the central axis for the beam energy incident upon the device. + ReferencedRangeShifter (RangeShifter): The referenced range shifter. + """ + def __init__(self) -> None: ... + + IsocenterToRangeShifterDistance: float + + RangeShifterSetting: str + + RangeShifterWaterEquivalentThickness: float + + ReferencedRangeShifter: RangeShifter + + IsocenterToRangeShifterDistance: float + + RangeShifterSetting: str + + RangeShifterWaterEquivalentThickness: float + + ReferencedRangeShifter: RangeShifter + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RTPrescription: + """ + Represents a prescription. + + Attributes: + BolusFrequency (str): Bolus frequency (how often the bolus is present in the field). For example, daily. + BolusThickness (str): Thickness of the bolus to be used. + Energies (List[str]): The energies in the prescription. + EnergyModes (List[str]): The energy modes in the prescription. + Gating (str): Gating information. + LatestRevision (RTPrescription): Gets the latest revision of the current RT prescription. + Notes (str): Additional notes. + NumberOfFractions (Optional[int]): Number of fractions, optional. + OrgansAtRisk (List[RTPrescriptionOrganAtRisk]): Gets the organs at risk of the current RT prescription. + PhaseType (str): Type of the phase (primary/boost). + PredecessorPrescription (RTPrescription): Gets the previous version of the RT prescription if it exists. + RevisionNumber (int): Revision number of the prescription. + SimulationNeeded (Optional[bool]): Indicates if simulations need to be done before treatment planning. + Site (str): The treatment site in the prescription. + Status (str): Prescription status. + TargetConstraintsWithoutTargetLevel (List[RTPrescriptionTargetConstraints]): Coverage constraints for targets with no prescribed dose. + Targets (List[RTPrescriptionTarget]): Gets the targets of the current prescription. + Technique (str): Treatment technique to be used. + BolusFrequency (str): Bolus frequency (how often the bolus is present in the field). For example, daily. + BolusThickness (str): Thickness of the bolus to be used. + Energies (List[str]): The energies in the prescription. + EnergyModes (List[str]): The energy modes in the prescription. + Gating (str): Gating information. + LatestRevision (RTPrescription): Gets the latest revision of the current RT prescription. + Notes (str): Additional notes. + NumberOfFractions (Optional[int]): Number of fractions, optional. + OrgansAtRisk (List[RTPrescriptionOrganAtRisk]): Gets the organs at risk of the current RT prescription. + PhaseType (str): Type of the phase (primary/boost). + PredecessorPrescription (RTPrescription): Gets the previous version of the RT prescription if it exists. + RevisionNumber (int): Revision number of the prescription. + SimulationNeeded (Optional[bool]): Indicates if simulations need to be done before treatment planning. + Site (str): The treatment site in the prescription. + Status (str): Prescription status. + TargetConstraintsWithoutTargetLevel (List[RTPrescriptionTargetConstraints]): Coverage constraints for targets with no prescribed dose. + Targets (List[RTPrescriptionTarget]): Gets the targets of the current prescription. + Technique (str): Treatment technique to be used. + """ + def __init__(self) -> None: ... + + BolusFrequency: str + + BolusThickness: str + + Energies: List[str] + + EnergyModes: List[str] + + Gating: str + + LatestRevision: RTPrescription + + Notes: str + + NumberOfFractions: Optional[int] + + OrgansAtRisk: List[RTPrescriptionOrganAtRisk] + + PhaseType: str + + PredecessorPrescription: RTPrescription + + RevisionNumber: int + + SimulationNeeded: Optional[bool] + + Site: str + + Status: str + + TargetConstraintsWithoutTargetLevel: List[RTPrescriptionTargetConstraints] + + Targets: List[RTPrescriptionTarget] + + Technique: str + + BolusFrequency: str + + BolusThickness: str + + Energies: List[str] + + EnergyModes: List[str] + + Gating: str + + LatestRevision: RTPrescription + + Notes: str + + NumberOfFractions: Optional[int] + + OrgansAtRisk: List[RTPrescriptionOrganAtRisk] + + PhaseType: str + + PredecessorPrescription: RTPrescription + + RevisionNumber: int + + SimulationNeeded: Optional[bool] + + Site: str + + Status: str + + TargetConstraintsWithoutTargetLevel: List[RTPrescriptionTargetConstraints] + + Targets: List[RTPrescriptionTarget] + + Technique: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RTPrescriptionConstraint: + """ + Represents a coverage constraint for an RT prescription. + + Attributes: + ConstraintType (RTPrescriptionConstraintType): Type of the constraint. + Unit1 (str): Gy, %, or null + Unit2 (str): Gy, %, or null + Value1 (str): First numerical (or free text) part of the constraint. + Value2 (str): Second numerical (or free text) part of the constraint. + ConstraintType (RTPrescriptionConstraintType): Type of the constraint. + Unit1 (str): Gy, %, or null + Unit2 (str): Gy, %, or null + Value1 (str): First numerical (or free text) part of the constraint. + Value2 (str): Second numerical (or free text) part of the constraint. + """ + def __init__(self) -> None: ... + + ConstraintType: RTPrescriptionConstraintType + + Unit1: str + + Unit2: str + + Value1: str + + Value2: str + + ConstraintType: RTPrescriptionConstraintType + + Unit1: str + + Unit2: str + + Value1: str + + Value2: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RTPrescriptionOrganAtRisk: + """ + Represents an organ at risk structure. + + Attributes: + Constraints (List[RTPrescriptionConstraint]): Constraints. + OrganAtRiskId (str): Structure identifier of the organ at risk. + Constraints (List[RTPrescriptionConstraint]): Constraints. + OrganAtRiskId (str): Structure identifier of the organ at risk. + """ + def __init__(self) -> None: ... + + Constraints: List[RTPrescriptionConstraint] + + OrganAtRiskId: str + + Constraints: List[RTPrescriptionConstraint] + + OrganAtRiskId: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RTPrescriptionTarget: + """ + Represents a prescription target. + + Attributes: + Constraints (List[RTPrescriptionConstraint]): Coverage constraints. + DosePerFraction (DoseValue): Dose per fraction for this target. + NumberOfFractions (int): The number of fractions in the prescription. + TargetId (str): The ID of the target volume. + Type (RTPrescriptionTargetType): Type of the prescription target. It can be Isocenter, IsodoseLine, Volume or Depth. + Value (float): Defined when the target type is IsodoseLine or Depth. Unit is % for IsodoseLine or mm for Depth. Not defined for other prescription types. + Constraints (List[RTPrescriptionConstraint]): Coverage constraints. + DosePerFraction (DoseValue): Dose per fraction for this target. + NumberOfFractions (int): The number of fractions in the prescription. + TargetId (str): The ID of the target volume. + Type (RTPrescriptionTargetType): Type of the prescription target. It can be Isocenter, IsodoseLine, Volume or Depth. + Value (float): Defined when the target type is IsodoseLine or Depth. Unit is % for IsodoseLine or mm for Depth. Not defined for other prescription types. + """ + def __init__(self) -> None: ... + + Constraints: List[RTPrescriptionConstraint] + + DosePerFraction: DoseValue + + NumberOfFractions: int + + TargetId: str + + Type: RTPrescriptionTargetType + + Value: float + + Constraints: List[RTPrescriptionConstraint] + + DosePerFraction: DoseValue + + NumberOfFractions: int + + TargetId: str + + Type: RTPrescriptionTargetType + + Value: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class RTPrescriptionTargetConstraints: + """ + Represents target structure constraints. + + Attributes: + Constraints (List[RTPrescriptionConstraint]): Constraints. + TargetId (str): Identifier of the target structure. + Constraints (List[RTPrescriptionConstraint]): Constraints. + TargetId (str): Identifier of the target structure. + """ + def __init__(self) -> None: ... + + Constraints: List[RTPrescriptionConstraint] + + TargetId: str + + Constraints: List[RTPrescriptionConstraint] + + TargetId: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class SearchBodyParameters: + """ + Parameters for the Search Body feature. + + Attributes: + FillAllCavities (bool): Defines whether all cavities are filled. + KeepLargestParts (bool): Defines whether the largest part(s) of the Body structure are kept. + LowerHUThreshold (int): The lower threshold of the Hounsfield Unit value in the CT for the Search Body feature. + MREdgeThresholdHigh (int): Higher edge threshold for MR images. + MREdgeThresholdLow (int): Lower edge threshold for MR images. + NumberOfLargestPartsToKeep (int): The number of the largest parts in the Body structure that are kept. + PreCloseOpenings (bool): Defines whether to connect structure parts before extraction. + PreCloseOpeningsRadius (float): Radius setting for PreCloseOpenings. + PreDisconnect (bool): Defines whether to disconnect structure parts before extraction. + PreDisconnectRadius (float): Radius setting for PreDisconnect. + Smoothing (bool): Whether to do smoothing. + SmoothingLevel (int): Smoothing levels. + FillAllCavities (bool): Defines whether all cavities are filled. + KeepLargestParts (bool): Defines whether the largest part(s) of the Body structure are kept. + LowerHUThreshold (int): The lower threshold of the Hounsfield Unit value in the CT for the Search Body feature. + MREdgeThresholdHigh (int): Higher edge threshold for MR images. + MREdgeThresholdLow (int): Lower edge threshold for MR images. + NumberOfLargestPartsToKeep (int): The number of the largest parts in the Body structure that are kept. + PreCloseOpenings (bool): Defines whether to connect structure parts before extraction. + PreCloseOpeningsRadius (float): Radius setting for PreCloseOpenings. + PreDisconnect (bool): Defines whether to disconnect structure parts before extraction. + PreDisconnectRadius (float): Radius setting for PreDisconnect. + Smoothing (bool): Whether to do smoothing. + SmoothingLevel (int): Smoothing levels. + """ + def __init__(self) -> None: ... + + FillAllCavities: bool + + KeepLargestParts: bool + + LowerHUThreshold: int + + MREdgeThresholdHigh: int + + MREdgeThresholdLow: int + + NumberOfLargestPartsToKeep: int + + PreCloseOpenings: bool + + PreCloseOpeningsRadius: float + + PreDisconnect: bool + + PreDisconnectRadius: float + + Smoothing: bool + + SmoothingLevel: int + + FillAllCavities: bool + + KeepLargestParts: bool + + LowerHUThreshold: int + + MREdgeThresholdHigh: int + + MREdgeThresholdLow: int + + NumberOfLargestPartsToKeep: int + + PreCloseOpenings: bool + + PreCloseOpeningsRadius: float + + PreDisconnect: bool + + PreDisconnectRadius: float + + Smoothing: bool + + SmoothingLevel: int + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Loads the default values of the Search Body parameters. + def LoadDefaults(self) -> None: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Loads the default values of the Search Body parameters. + def LoadDefaults(self) -> None: + ... + + + +class SegmentVolume: + """ + The volumetric representation of a structure. This object is used when defining margins for structures, or when performing Boolean operations on structures. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to both this segment volume and another segment volume, that is, the intersection of this and the other segment volume. + def And(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this segment volume. + """ + ... + + + # Expands or shrinks this segment volume with the specified margins, aligned to the axes of the image coordinate system. + def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: + """ + Args: + margins: The margins in millimeters. The maximum is 50. + """ + ... + + + # Creates a new segment volume by expanding or shrinking this segment volume with the specified margin (in millimeters). A positive value creates an outer margin. A negative value creates an inner margin. + def Margin(self, marginInMM: float) -> SegmentVolume: + """ + Args: + marginInMM: The used margin in millimeters. The maximum is 50. + """ + ... + + + # Creates a combination of segment volumes. Does not modify this segment volume. The combination includes the area that covers everything else but this segment volume. + def Not(self) -> SegmentVolume: + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to this segment volume, to another segment volume, or both, that is, the union of this and the other segment volume. + def Or(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the area that belongs to this segment volume, but not to the other segment volume. + def Sub(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is subtracted from this segment volume. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong either to this segment volume or to another segment volume, but not to both of them. + def Xor(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to both this segment volume and another segment volume, that is, the intersection of this and the other segment volume. + def And(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this segment volume. + """ + ... + + + # Expands or shrinks this segment volume with the specified margins, aligned to the axes of the image coordinate system. + def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: + """ + Args: + margins: The margins in millimeters. The maximum is 50. + """ + ... + + + # Creates a new segment volume by expanding or shrinking this segment volume with the specified margin (in millimeters). A positive value creates an outer margin. A negative value creates an inner margin. + def Margin(self, marginInMM: float) -> SegmentVolume: + """ + Args: + marginInMM: The used margin in millimeters. The maximum is 50. + """ + ... + + + # Creates a combination of segment volumes. Does not modify this segment volume. The combination includes the area that covers everything else but this segment volume. + def Not(self) -> SegmentVolume: + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to this segment volume, to another segment volume, or both, that is, the union of this and the other segment volume. + def Or(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the area that belongs to this segment volume, but not to the other segment volume. + def Sub(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is subtracted from this segment volume. + """ + ... + + + # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong either to this segment volume or to another segment volume, but not to both of them. + def Xor(self, other: SegmentVolume) -> SegmentVolume: + """ + Args: + other: The segment volume that is combined with this volume. + """ + ... + + + +class StandardWedge: + """ + A standard wedge is a physical piece of material with an angle that is static during treatment. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class BeamCalculationLog: + """ + Represents a beam calculation log. + + Attributes: + Beam (Beam): Used for navigating to parent Beam + Category (str): The log category, for example, "Dose", or "Optimization". + MessageLines (List[str]): The log as an array of lines. + Beam (Beam): Used for navigating to parent Beam + Category (str): The log category, for example, "Dose", or "Optimization". + MessageLines (List[str]): The log as an array of lines. + """ + def __init__(self) -> None: ... + + Beam: Beam + + Category: str + + MessageLines: List[str] + + Beam: Beam + + Category: str + + MessageLines: List[str] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Block: + """ + Represents a block add-on, a custom-made beam collimating material fixed to a tray, used to shape the beam. + + Attributes: + AddOnMaterial (AddOnMaterial): The dosimetric material of the block. + IsDiverging (bool): Checks if the block cut is diverging. + Outline (Array[Array[Windows.Point]]): The block outline points in field coordinates. + TransmissionFactor (float): The transmission factor of the selected material. + Tray (Tray): The tray on which the block is installed. + TrayTransmissionFactor (float): The transmission factor of the selected tray. + Type (BlockType): The type of the block: shielding or aperture. + AddOnMaterial (AddOnMaterial): The dosimetric material of the block. + IsDiverging (bool): Checks if the block cut is diverging. + Outline (Array[Array[Windows.Point]]): The block outline points in field coordinates. + TransmissionFactor (float): The transmission factor of the selected material. + Tray (Tray): The tray on which the block is installed. + TrayTransmissionFactor (float): The transmission factor of the selected tray. + Type (BlockType): The type of the block: shielding or aperture. + """ + def __init__(self) -> None: ... + + AddOnMaterial: AddOnMaterial + + IsDiverging: bool + + Outline: Array[Array[Windows.Point]] + + TransmissionFactor: float + + Tray: Tray + + TrayTransmissionFactor: float + + Type: BlockType + + AddOnMaterial: AddOnMaterial + + IsDiverging: bool + + Outline: Array[Array[Windows.Point]] + + TransmissionFactor: float + + Tray: Tray + + TrayTransmissionFactor: float + + Type: BlockType + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Bolus: + """ + Represents a bolus, which is custom-made material that is usually fixed to the patient's skin for treatment. The bolus is used to modulate the depth dose profile of a beam. + + Attributes: + Id (str): The identifier of the bolus. + MaterialCTValue (float): The CT value of the bolus material (HU). + Name (str): The name of the bolus. + Id (str): The identifier of the bolus. + MaterialCTValue (float): The CT value of the bolus material (HU). + Name (str): The name of the bolus. + """ + def __init__(self) -> None: ... + + Id: str + + MaterialCTValue: float + + Name: str + + Id: str + + MaterialCTValue: float + + Name: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Compensator: + """ + Represents a beam compensator add-on, a custom-made beam modulating material fixed to a tray, used to modulate the beam's intensity. + + Attributes: + Material (AddOnMaterial): The dosimetric material used in the compensator. + Slot (Slot): The slot into which the tray is inserted. + Tray (Tray): The tray to which the compensator is connected. + Material (AddOnMaterial): The dosimetric material used in the compensator. + Slot (Slot): The slot into which the tray is inserted. + Tray (Tray): The tray to which the compensator is connected. + """ + def __init__(self) -> None: ... + + Material: AddOnMaterial + + Slot: Slot + + Tray: Tray + + Material: AddOnMaterial + + Slot: Slot + + Tray: Tray + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ControlPoint: + """ + Represents a point in a planned sequence of treatment beam parameters. See the definition of control points in a DICOM RT Beam. + + Attributes: + Beam (Beam): Used for navigating to parent beam + CollimatorAngle (float): The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + GantryAngle (float): The gantry angle of the radiation source. In other words, the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. + JawPositions (VRect[float]): The positions of the beam collimator jaws (in mm) in the IEC BEAM LIMITING DEVICE coordinates. + LeafPositions (Array[float]): The positions of the beam collimator leaf pairs (in mm) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If there is no MLC, a (0,0)-length array is returned. + MetersetWeight (float): The cumulative meterset weight to this control point. The cumulative meterset weight for the first item in a control point sequence is zero. + PatientSupportAngle (float): The patient support angle. In other words, the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. + Beam (Beam): Used for navigating to parent beam + CollimatorAngle (float): The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). + GantryAngle (float): The gantry angle of the radiation source. In other words, the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. + JawPositions (VRect[float]): The positions of the beam collimator jaws (in mm) in the IEC BEAM LIMITING DEVICE coordinates. + LeafPositions (Array[float]): The positions of the beam collimator leaf pairs (in mm) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If there is no MLC, a (0,0)-length array is returned. + MetersetWeight (float): The cumulative meterset weight to this control point. The cumulative meterset weight for the first item in a control point sequence is zero. + PatientSupportAngle (float): The patient support angle. In other words, the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). + TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. + TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. + + Note: + Control points are discussed in DICOM PS 3.3 C.8.8.14. All beams have at least two control points. Note that some values may be NaN if they are not applicable to the treatment plan in question. + """ + def __init__(self) -> None: ... + + Beam: Beam + + CollimatorAngle: float + + GantryAngle: float + + Index: int + + JawPositions: VRect[float] + + LeafPositions: Array[float] + + MetersetWeight: float + + PatientSupportAngle: float + + TableTopLateralPosition: float + + TableTopLongitudinalPosition: float + + TableTopVerticalPosition: float + + Beam: Beam + + CollimatorAngle: float + + GantryAngle: float + + Index: int + + JawPositions: VRect[float] + + LeafPositions: Array[float] + + MetersetWeight: float + + PatientSupportAngle: float + + TableTopLateralPosition: float + + TableTopLongitudinalPosition: float + + TableTopVerticalPosition: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ControlPointCollection: + """ + Represents a collection of machine parameters that describe the planned treatment beam. + + Attributes: + Count (int): The number of control points in the collection. + Count (int): The number of control points in the collection. + """ + def __init__(self) -> None: ... + + Count: int + + Count: int + + # Retrieves enumerator for ControlPoints in the collection. + def GetEnumerator(self) -> Iterable[ControlPoint]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Retrieves enumerator for ControlPoints in the collection. + def GetEnumerator(self) -> Iterable[ControlPoint]: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ApiDataObject: + """ + The base class of objects in the Eclipse Scripting API. + + Attributes: + Id (str): The identifier of the object. + Name (str): The name of the object. + Comment (str): A comment about the object. + HistoryUserName (str): The identifier of the last user who modified this object. + HistoryUserDisplayName (str): The name of the last user who modified this object. + HistoryDateTime (datetime): The date when this object was last modified. + Id (str): The identifier of the object. + Name (str): The name of the object. + Comment (str): A comment about the object. + HistoryUserName (str): The identifier of the last user who modified this object. + HistoryUserDisplayName (str): The name of the last user who modified this object. + HistoryDateTime (datetime): The date when this object was last modified. + """ + def __init__(self) -> None: ... + + Id: str + + Name: str + + Comment: str + + HistoryUserName: str + + HistoryUserDisplayName: str + + HistoryDateTime: datetime + + Id: str + + Name: str + + Comment: str + + HistoryUserName: str + + HistoryUserDisplayName: str + + HistoryDateTime: datetime + + # Returns a string that represents the current object. + def ToString(self) -> str: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream to which the object is serialized. + """ + ... + + + # Determines whether the specified Object is equal to the current Object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: Object to compare with the current object + """ + ... + + + # Serves as a hash function for this type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: ApiDataObject, b: ApiDataObject) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: ApiDataObject, b: ApiDataObject) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPIClinicalModifyingMethodGuard(self, param1: str) -> Any: + ... + + + # Throws an exception if the caller tries to add more scripting objects of certain types than a preset maximum limit allows. + def EnforceObjectLimits(self, callerMemberName: str) -> Any: + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPINonClinicalModifyingMethodGuard(self, param1: str) -> Any: + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPIClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: + """ + Args: + dataObj: The data object that is modified. + explicitCallerName: The API member that calls. + callerMemberName: The member that calls. + """ + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPINonClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: + """ + Args: + dataObj: The data object that is modified. + explicitCallerName: The API member that calls. + callerMemberName: The member that calls. + """ + ... + + + # Returns a string that represents the current object. + def ToString(self) -> str: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream to which the object is serialized. + """ + ... + + + # Determines whether the specified Object is equal to the current Object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: Object to compare with the current object + """ + ... + + + # Serves as a hash function for this type. + def GetHashCode(self) -> int: + ... + + + # The equality operator. + def op_Equality(self, a: ApiDataObject, b: ApiDataObject) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # The inequality operator. + def op_Inequality(self, a: ApiDataObject, b: ApiDataObject) -> bool: + """ + Args: + a: First operand. + b: Second operand. + """ + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPIClinicalModifyingMethodGuard(self, param1: str) -> Any: + ... + + + # Throws an exception if the caller tries to add more scripting objects of certain types than a preset maximum limit allows. + def EnforceObjectLimits(self, callerMemberName: str) -> Any: + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPINonClinicalModifyingMethodGuard(self, param1: str) -> Any: + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPIClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: + """ + Args: + dataObj: The data object that is modified. + explicitCallerName: The API member that calls. + callerMemberName: The member that calls. + """ + ... + + + # Throws an exception if the system is in the read-only state. + def GetESAPINonClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: + """ + Args: + dataObj: The data object that is modified. + explicitCallerName: The API member that calls. + callerMemberName: The member that calls. + """ + ... + + + +class Application: + """ + The main application interface. + + Attributes: + CurrentUser (User): The user who is currently logged on. + PatientSummaries (List[PatientSummary]): Fetches patient summaries from the database. + Calculation (Calculation): Calculation related functions + StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. + Equipment (Equipment): Provides access to clinical devices and accessories. + ScriptEnvironment (ScriptEnvironment): Gets the script environment. + CurrentUser (User): The user who is currently logged on. + PatientSummaries (List[PatientSummary]): Fetches patient summaries from the database. + Calculation (Calculation): Calculation related functions + StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. + Equipment (Equipment): Provides access to clinical devices and accessories. + ScriptEnvironment (ScriptEnvironment): Gets the script environment. + """ + def __init__(self) -> None: ... + + CurrentUser: User + + PatientSummaries: List[PatientSummary] + + Calculation: Calculation + + StructureCodes: ActiveStructureCodeDictionaries + + Equipment: Equipment + + ScriptEnvironment: ScriptEnvironment + + CurrentUser: User + + PatientSummaries: List[PatientSummary] + + Calculation: Calculation + + StructureCodes: ActiveStructureCodeDictionaries + + Equipment: Equipment + + ScriptEnvironment: ScriptEnvironment + + # Releases all unmanaged resources of this object. + def Dispose(self) -> None: + ... + + + # Called only if user forgot to call Dispose() + def Finalize(self) -> Any: + ... + + + # Creates an application instance and logs into the system. + def CreateApplication(self, username: str, password: str) -> Application: + """ + Args: + username: Username for logging in or null value to invoke an interactive login dialog. + password: Password for logging in or null value to invoke an interactive login dialog. + """ + ... + + + # Creates an application instance for a standalone script and logs into the system. + def CreateApplication(self) -> Application: + ... + + + # Opens a patient. + def OpenPatient(self, patientSummary: PatientSummary) -> Patient: + """ + Args: + patientSummary: Patient summary. + """ + ... + + + # Opens a patient by using a patient identifier. + def OpenPatientById(self, id: str) -> Patient: + """ + Args: + id: Patient ID + """ + ... + + + # Closes the current patient. If the script tries to access the data of a closed patient, an access violation exception occurs. + def ClosePatient(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Saves data modifications to the database if saving is allowed. Note: Calling this method can cause a multi-user warning dialog box to appear if the same patient is modified by other parties. + def SaveModifications(self) -> None: + ... + + + # Add HIPAA log record if HIPAA is enabled + def LogExportToHipaa(self, patientId: str) -> Any: + ... + + + # CTRL+BREAK handler, stops script execution + def ConsoleEventHandler(self, eventCode: ConsoleHandlerEventCode) -> Any: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Releases all unmanaged resources of this object. + def Dispose(self) -> None: + ... + + + # Called only if user forgot to call Dispose() + def Finalize(self) -> Any: + ... + + + # Creates an application instance and logs into the system. + def CreateApplication(self, username: str, password: str) -> Application: + """ + Args: + username: Username for logging in or null value to invoke an interactive login dialog. + password: Password for logging in or null value to invoke an interactive login dialog. + """ + ... + + + # Creates an application instance for a standalone script and logs into the system. + def CreateApplication(self) -> Application: + ... + + + # Opens a patient. + def OpenPatient(self, patientSummary: PatientSummary) -> Patient: + """ + Args: + patientSummary: Patient summary. + """ + ... + + + # Opens a patient by using a patient identifier. + def OpenPatientById(self, id: str) -> Patient: + """ + Args: + id: Patient ID + """ + ... + + + # Closes the current patient. If the script tries to access the data of a closed patient, an access violation exception occurs. + def ClosePatient(self) -> None: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Saves data modifications to the database if saving is allowed. Note: Calling this method can cause a multi-user warning dialog box to appear if the same patient is modified by other parties. + def SaveModifications(self) -> None: + ... + + + # Add HIPAA log record if HIPAA is enabled + def LogExportToHipaa(self, patientId: str) -> Any: + ... + + + # CTRL+BREAK handler, stops script execution + def ConsoleEventHandler(self, eventCode: ConsoleHandlerEventCode) -> Any: + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Globals: + """ + This class is internal to the Eclipse Scripting API. + + Attributes: + AbortNow (bool): The flag that aborts script execution the next time any property or method of the Eclipse Scripting API is accessed. + DefaultMaximumNumberOfLoggedApiCalls (int): The default maximum number of API calls that are saved in the script execution log. + AbortNow (bool): The flag that aborts script execution the next time any property or method of the Eclipse Scripting API is accessed. + DefaultMaximumNumberOfLoggedApiCalls (int): The default maximum number of API calls that are saved in the script execution log. + """ + # Constructor + @overload + def __init__(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: + ... + + + # Constructor + @overload + def __init__(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: + ... + + + AbortNow: bool + + DefaultMaximumNumberOfLoggedApiCalls: int + + AbortNow: bool + + DefaultMaximumNumberOfLoggedApiCalls: int + + # Initialize custom log + def Initialize(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: + ... + + + # Checks if abort is needed and stops execution. + def CheckAbort(self) -> Any: + ... + + + # Uses System.Diagnostics.Trace with re-entrancy check for the Scripting API. + def Trace(self, message: str) -> Any: + ... + + + # Sets the maximum number of the API calls that are saved in the script execution log. This will clear the existing log entries. + def SetMaximumNumberOfLoggedApiCalls(self, apiLogCacheSize: int) -> None: + """ + Args: + apiLogCacheSize: The cache size for API call logs. Setting the value to zero disables logging. + """ + ... + + + # Returns the last called properties and methods. The oldest cached call is the first. The maximum number of logged calls is set by calling SetMaximumNumberOfLoggedApiCalls. + def GetLoggedApiCalls(self) -> List[str]: + ... + + + # Enables the getting of access information for API members through .NET trace listener. + def EnableApiAccessTrace(self) -> None: + ... + + + # Disables the getting of access information for API members through .NET trace listener. + def DisableApiAccessTrace(self) -> None: + ... + + + # Adds a log entry to custom script log file. + def AddCustomLogEntry(self, message: str, logSeverity: LogSeverity) -> None: + ... + + + # Initialize custom log + def Initialize(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: + ... + + + # Checks if abort is needed and stops execution. + def CheckAbort(self) -> Any: + ... + + + # Uses System.Diagnostics.Trace with re-entrancy check for the Scripting API. + def Trace(self, message: str) -> Any: + ... + + + # Sets the maximum number of the API calls that are saved in the script execution log. This will clear the existing log entries. + def SetMaximumNumberOfLoggedApiCalls(self, apiLogCacheSize: int) -> None: + """ + Args: + apiLogCacheSize: The cache size for API call logs. Setting the value to zero disables logging. + """ + ... + + + # Returns the last called properties and methods. The oldest cached call is the first. The maximum number of logged calls is set by calling SetMaximumNumberOfLoggedApiCalls. + def GetLoggedApiCalls(self) -> List[str]: + ... + + + # Enables the getting of access information for API members through .NET trace listener. + def EnableApiAccessTrace(self) -> None: + ... + + + # Disables the getting of access information for API members through .NET trace listener. + def DisableApiAccessTrace(self) -> None: + ... + + + # Adds a log entry to custom script log file. + def AddCustomLogEntry(self, message: str, logSeverity: LogSeverity) -> None: + ... + + + +class DVHData: + """ + Represents Dose Volume Histogram (DVH) data. + + Attributes: + Coverage (float): The dose coverage of the target, normalized to 0.0 .. 1.0. + CurveData (Array[DVHPoint]): The points of the Dose Volume Histogram (DVH) curve. + MaxDose (DoseValue): The maximum dose. + MaxDosePosition (VVector): The position of the maximum dose. + MeanDose (DoseValue): The mean dose. + MedianDose (DoseValue): The median dose. + MinDose (DoseValue): The minimum dose. + MinDosePosition (VVector): The position of the minimum dose. + SamplingCoverage (float): The sampling coverage. + StdDev (float): The standard deviation. + Volume (float): The volume of the structure in cubic centimeters. + Coverage (float): The dose coverage of the target, normalized to 0.0 .. 1.0. + CurveData (Array[DVHPoint]): The points of the Dose Volume Histogram (DVH) curve. + MaxDose (DoseValue): The maximum dose. + MaxDosePosition (VVector): The position of the maximum dose. + MeanDose (DoseValue): The mean dose. + MedianDose (DoseValue): The median dose. + MinDose (DoseValue): The minimum dose. + MinDosePosition (VVector): The position of the minimum dose. + SamplingCoverage (float): The sampling coverage. + StdDev (float): The standard deviation. + Volume (float): The volume of the structure in cubic centimeters. + """ + def __init__(self) -> None: ... + + Coverage: float + + CurveData: Array[DVHPoint] + + MaxDose: DoseValue + + MaxDosePosition: VVector + + MeanDose: DoseValue + + MedianDose: DoseValue + + MinDose: DoseValue + + MinDosePosition: VVector + + SamplingCoverage: float + + StdDev: float + + Volume: float + + Coverage: float + + CurveData: Array[DVHPoint] + + MaxDose: DoseValue + + MaxDosePosition: VVector + + MeanDose: DoseValue + + MedianDose: DoseValue + + MinDose: DoseValue + + MinDosePosition: VVector + + SamplingCoverage: float + + StdDev: float + + Volume: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class DynamicWedge: + """ + A Dynamic Wedge is formed by a moving jaw of a standard collimator during irradiation. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class EnhancedDynamicWedge: + """ + An Enhanced Dynamic Wedge is similar to a Dynamic Wedge, but it features more wedge angles than a simple Dynamic Wedge. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class FieldReferencePoint: + """ + This object links a treatment beam to a reference point. + + Attributes: + EffectiveDepth (float): The effective depth of the field reference point. For arc fields this is the average value over the span of the arc. + FieldDose (DoseValue): The field dose. + IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. + IsPrimaryReferencePoint (bool): Checks if the reference point is primary. + ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. + RefPointLocation (VVector): The location of the reference point. + SSD (float): The Source-to-Skin Distance (SSD) of the reference point. For arc fields this is the average value over the span of the arc. + EffectiveDepth (float): The effective depth of the field reference point. For arc fields this is the average value over the span of the arc. + FieldDose (DoseValue): The field dose. + IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. + IsPrimaryReferencePoint (bool): Checks if the reference point is primary. + ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. + RefPointLocation (VVector): The location of the reference point. + SSD (float): The Source-to-Skin Distance (SSD) of the reference point. For arc fields this is the average value over the span of the arc. + """ + def __init__(self) -> None: ... + + EffectiveDepth: float + + FieldDose: DoseValue + + IsFieldDoseNominal: bool + + IsPrimaryReferencePoint: bool + + ReferencePoint: ReferencePoint + + RefPointLocation: VVector + + SSD: float + + EffectiveDepth: float + + FieldDose: DoseValue + + IsFieldDoseNominal: bool + + IsPrimaryReferencePoint: bool + + ReferencePoint: ReferencePoint + + RefPointLocation: VVector + + SSD: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Hospital: + """ + Represents a hospital. + + Attributes: + CreationDateTime (Optional[datetime]): The date when this object was created. + Location (str): The location of the hospital. + CreationDateTime (Optional[datetime]): The date when this object was created. + Location (str): The location of the hospital. + """ + def __init__(self) -> None: ... + + CreationDateTime: Optional[datetime] + + Location: str + + CreationDateTime: Optional[datetime] + + Location: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class ScriptContext: + """ + Contains the runtime context information of the active application for the script. + + Attributes: + CurrentUser (User): The current user of the application. + Course (Course): The course. The value may be null if the context has no course. + Image (Image): The 3D image. The value may be null if the context has no image. + StructureSet (StructureSet): The structure set. The value may be null if the context has no structure set. + Calculation (Calculation): Calculation related functions + StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. + Equipment (Equipment): Provides access to clinical devices and accessories. + Patient (Patient): The patient. The value may be null if the context has no patient. + PlanSetup (PlanSetup): The plan setup. The value may be null if the context has no plan setup. + ExternalPlanSetup (ExternalPlanSetup): The active external beam plan setup. The value is null if the active object is not an external beam plan setup. + BrachyPlanSetup (BrachyPlanSetup): The active brachytherapy plan setup. The value is null if the active object is not a brachytherapy plan setup. + IonPlanSetup (IonPlanSetup): The active proton plan setup. The value is null if the active object is not a proton plan setup. + PlansInScope (List[PlanSetup]): Retrieves a list of all plans in the Scope window. + ExternalPlansInScope (List[ExternalPlanSetup]): Retrieves a list of all external beam plans in the Scope window. + BrachyPlansInScope (List[BrachyPlanSetup]): Retrieves a list of all brachytherapy plans in the Scope window. + IonPlansInScope (List[IonPlanSetup]): Retrieves a list of all proton plans in the Scope window. + PlanSumsInScope (List[PlanSum]): Retrieves a list of all plan sums in the Scope window. + PlanSum (PlanSum): Retrieves the active plan sum. + ActiveStructure (Any): Retrieves the active structure. + ApplicationName (str): The name of the active application. + VersionInfo (str): The version number of Eclipse. + CurrentUser (User): The current user of the application. + Course (Course): The course. The value may be null if the context has no course. + Image (Image): The 3D image. The value may be null if the context has no image. + StructureSet (StructureSet): The structure set. The value may be null if the context has no structure set. + Calculation (Calculation): Calculation related functions + StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. + Equipment (Equipment): Provides access to clinical devices and accessories. + Patient (Patient): The patient. The value may be null if the context has no patient. + PlanSetup (PlanSetup): The plan setup. The value may be null if the context has no plan setup. + ExternalPlanSetup (ExternalPlanSetup): The active external beam plan setup. The value is null if the active object is not an external beam plan setup. + BrachyPlanSetup (BrachyPlanSetup): The active brachytherapy plan setup. The value is null if the active object is not a brachytherapy plan setup. + IonPlanSetup (IonPlanSetup): The active proton plan setup. The value is null if the active object is not a proton plan setup. + PlansInScope (List[PlanSetup]): Retrieves a list of all plans in the Scope window. + ExternalPlansInScope (List[ExternalPlanSetup]): Retrieves a list of all external beam plans in the Scope window. + BrachyPlansInScope (List[BrachyPlanSetup]): Retrieves a list of all brachytherapy plans in the Scope window. + IonPlansInScope (List[IonPlanSetup]): Retrieves a list of all proton plans in the Scope window. + PlanSumsInScope (List[PlanSum]): Retrieves a list of all plan sums in the Scope window. + PlanSum (PlanSum): Retrieves the active plan sum. + ActiveStructure (Any): Retrieves the active structure. + ApplicationName (str): The name of the active application. + VersionInfo (str): The version number of Eclipse. + """ + # Provides scripts an access to the current data context. A context instance is given as a parameter in the Execute function of the script. The script itself does not instantiate the context. + @overload + def __init__(self, context: Any, user: Any, dvhEstimation: Any, appName: str) -> None: + """ + Args: + context: The internal data context. + user: The internal user object. + dvhEstimation: The internal dvh estimation model library object. + appName: The application name. + """ + ... + + + # Provides scripts an access to the current data context. A context instance is given as a parameter in the Execute function of the script. The script itself does not instantiate the context. + @overload + def __init__(self, context: Any, user: Any, dvhEstimation: Any, appName: str) -> None: + """ + Args: + context: The internal data context. + user: The internal user object. + dvhEstimation: The internal dvh estimation model library object. + appName: The application name. + """ + ... + + + CurrentUser: User + + Course: Course + + Image: Image + + StructureSet: StructureSet + + Calculation: Calculation + + StructureCodes: ActiveStructureCodeDictionaries + + Equipment: Equipment + + Patient: Patient + + PlanSetup: PlanSetup + + ExternalPlanSetup: ExternalPlanSetup + + BrachyPlanSetup: BrachyPlanSetup + + IonPlanSetup: IonPlanSetup + + PlansInScope: List[PlanSetup] + + ExternalPlansInScope: List[ExternalPlanSetup] + + BrachyPlansInScope: List[BrachyPlanSetup] + + IonPlansInScope: List[IonPlanSetup] + + PlanSumsInScope: List[PlanSum] + + PlanSum: PlanSum + + ActiveStructure: Any + + ApplicationName: str + + VersionInfo: str + + CurrentUser: User + + Course: Course + + Image: Image + + StructureSet: StructureSet + + Calculation: Calculation + + StructureCodes: ActiveStructureCodeDictionaries + + Equipment: Equipment + + Patient: Patient + + PlanSetup: PlanSetup + + ExternalPlanSetup: ExternalPlanSetup + + BrachyPlanSetup: BrachyPlanSetup + + IonPlanSetup: IonPlanSetup + + PlansInScope: List[PlanSetup] + + ExternalPlansInScope: List[ExternalPlanSetup] + + BrachyPlansInScope: List[BrachyPlanSetup] + + IonPlansInScope: List[IonPlanSetup] + + PlanSumsInScope: List[PlanSum] + + PlanSum: PlanSum + + ActiveStructure: Any + + ApplicationName: str + + VersionInfo: str + + +class Isodose: + """ + Represents an isodose level for a fixed absolute or relative dose value. + + Attributes: + Color (Windows.Media.Color): The color of the isodose. + Level (DoseValue): The dose value of the isodose level. + MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The triangle mesh of the isodose. Returned for those isodose levels that are rendered in 3D in Eclipse. + Color (Windows.Media.Color): The color of the isodose. + Level (DoseValue): The dose value of the isodose level. + MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The triangle mesh of the isodose. Returned for those isodose levels that are rendered in 3D in Eclipse. + """ + def __init__(self) -> None: ... + + Color: Windows.Media.Color + + Level: DoseValue + + MeshGeometry: Windows.Media.Media3D.MeshGeometry3D + + Color: Windows.Media.Color + + Level: DoseValue + + MeshGeometry: Windows.Media.Media3D.MeshGeometry3D + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class MLC: + """ + Represents a Multileaf Collimator (MLC) add-on. + + Attributes: + ManufacturerName (str): The name of the manufacturer of the Multileaf Collimator (MLC). + MinDoseDynamicLeafGap (float): For dose-dynamic treatments, the minimum gap (mm) between moving, open leaf pairs that the Multileaf Collimator (MLC) hardware can handle. + Model (str): The number or name of the Multileaf Collimator (MLC) model. + SerialNumber (str): The serial number given to the Multileaf Collimator (MLC) by the factory. + ManufacturerName (str): The name of the manufacturer of the Multileaf Collimator (MLC). + MinDoseDynamicLeafGap (float): For dose-dynamic treatments, the minimum gap (mm) between moving, open leaf pairs that the Multileaf Collimator (MLC) hardware can handle. + Model (str): The number or name of the Multileaf Collimator (MLC) model. + SerialNumber (str): The serial number given to the Multileaf Collimator (MLC) by the factory. + """ + def __init__(self) -> None: ... + + ManufacturerName: str + + MinDoseDynamicLeafGap: float + + Model: str + + SerialNumber: str + + ManufacturerName: str + + MinDoseDynamicLeafGap: float + + Model: str + + SerialNumber: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class MotorizedWedge: + """ + A motorized wedge is a standard wedge placed in the beam for a user-defined fraction of the total treatment time. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class OmniWedge: + """ + An OmniWedge is a special type of wedge that combines an open field, a motorized wedge, and a virtual wedge to create the desired wedge effect. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Patient: + """ + Represents a patient. + + Attributes: + Courses (List[Course]): A collection of the patient's courses. + CreationDateTime (Optional[datetime]): The date when this object was created. + DateOfBirth (Optional[datetime]): The date of birth of the patient. + DefaultDepartment (str): The default department name. + FirstName (str): The first name of the patient. + HasModifiedData (bool): Returns true if the patient object tree has been modified. + Hospital (Hospital): The hospital. + Id2 (str): The patient ID2. + LastName (str): The last name of the patient. + MiddleName (str): The middle name of the patient. + PrimaryOncologistId (str): The identifier of the primary oncologist. + PrimaryOncologistName (str): The primary oncologist name. + ReferencePoints (List[ReferencePoint]): Collection of all reference points for the patient. + Registrations (List[Registration]): A collection of registrations. + Sex (str): The gender of the patient. + SSN (str): The Social Security Account Number (SSN) of the patient. + StructureSets (List[StructureSet]): A collection of structure sets. + Studies (List[Study]): A collection of studies. + Courses (List[Course]): A collection of the patient's courses. + CreationDateTime (Optional[datetime]): The date when this object was created. + DateOfBirth (Optional[datetime]): The date of birth of the patient. + DefaultDepartment (str): The default department name. + FirstName (str): The first name of the patient. + HasModifiedData (bool): Returns true if the patient object tree has been modified. + Hospital (Hospital): The hospital. + Id2 (str): The patient ID2. + LastName (str): The last name of the patient. + MiddleName (str): The middle name of the patient. + PrimaryOncologistId (str): The identifier of the primary oncologist. + PrimaryOncologistName (str): The primary oncologist name. + ReferencePoints (List[ReferencePoint]): Collection of all reference points for the patient. + Registrations (List[Registration]): A collection of registrations. + Sex (str): The gender of the patient. + SSN (str): The Social Security Account Number (SSN) of the patient. + StructureSets (List[StructureSet]): A collection of structure sets. + Studies (List[Study]): A collection of studies. + """ + def __init__(self) -> None: ... + + Courses: List[Course] + + CreationDateTime: Optional[datetime] + + DateOfBirth: Optional[datetime] + + DefaultDepartment: str + + FirstName: str + + HasModifiedData: bool + + Hospital: Hospital + + Id2: str + + LastName: str + + MiddleName: str + + PrimaryOncologistId: str + + PrimaryOncologistName: str + + ReferencePoints: List[ReferencePoint] + + Registrations: List[Registration] + + Sex: str + + SSN: str + + StructureSets: List[StructureSet] + + Studies: List[Study] + + Courses: List[Course] + + CreationDateTime: Optional[datetime] + + DateOfBirth: Optional[datetime] + + DefaultDepartment: str + + FirstName: str + + HasModifiedData: bool + + Hospital: Hospital + + Id2: str + + LastName: str + + MiddleName: str + + PrimaryOncologistId: str + + PrimaryOncologistName: str + + ReferencePoints: List[ReferencePoint] + + Registrations: List[Registration] + + Sex: str + + SSN: str + + StructureSets: List[StructureSet] + + Studies: List[Study] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new course to this patient. + def AddCourse(self) -> Course: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds an empty phantom image to the patient. The empty image is created in a new study. A new structure set is created for the image. + def AddEmptyPhantom(self, imageId: str, orientation: PatientOrientation, xSizePixel: int, ySizePixel: int, widthMM: float, heightMM: float, nrOfPlanes: int, planeSepMM: float) -> StructureSet: + """ + Args: + imageId: The identifier for the empty image to be created. The value must not be empty. + orientation: The patient orientation in the image. + xSizePixel: The x size of the image in pixels. The expected value is from 23 to 2048 pixels. + ySizePixel: The y size of the image in pixels. The expected value is from 23 to 2048 pixels. + widthMM: The height of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. + heightMM: The width of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. + nrOfPlanes: The number of planes in the image. The expected value is from 1 to 10000. + planeSepMM: The distance between the planes in millimeters. The expected value is from 0.1 to 200.0 millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add reference point to a patient + def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: + """ + Args: + target: True if point being added is for target volume + id: Identifier for the new reference point + """ + ... + + + # Enables write-access to the data model from the Scripting API. This function must be called for each patient the script modifies. If this function is not called, the data in the database cannot be modified. + def BeginModifications(self) -> None: + ... + + + # Checks if a new course can be added to the patient. + def CanAddCourse(self) -> bool: + ... + + + # Checks if an empty phantom can be added to the patient. The user should have the appropriate permissions to perform the operation. + def CanAddEmptyPhantom(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If phantom adding is not permitted, contains the error message. + """ + ... + + + # Checks if the image can be copied from the other patient. + def CanCopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str, errorMessage: str) -> bool: + """ + Args: + targetStudy: The target study for the new image series, or null. + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + errorMessage: If copying the image is not permitted, contains the error message. + """ + ... + + + # Returns true if the script can modify patient data in the database. + def CanModifyData(self) -> bool: + ... + + + # Checks if the course can be removed from the patient. + def CanRemoveCourse(self, course: Course) -> bool: + """ + Args: + course: The course to be removed. + """ + ... + + + # Checks if the image can be removed. The image to be removed and the associated structure set should be empty. + def CanRemoveEmptyPhantom(self, structureset: StructureSet, errorMessage: str) -> bool: + """ + Args: + structureset: The structure set to be removed. + errorMessage: If the image and associated structure set cannot be removed, contains the error message. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to this patient. A new study and series is created for the image. The method + def CopyImageFromOtherPatient(self, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: + """ + Args: + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to the given study. A new series is created for the image. The method + def CopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: + """ + Args: + targetStudy: The target study for the new image series. + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the course from the patient and deletes it. + def RemoveCourse(self, course: Course) -> None: + """ + Args: + course: The course that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes an empty image from the patient. The associated structure set is also removed. The image to be removed and the associated structure set should be empty. + def RemoveEmptyPhantom(self, structureset: StructureSet) -> None: + """ + Args: + structureset: The structure set to be removed. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new course to this patient. + def AddCourse(self) -> Course: + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Adds an empty phantom image to the patient. The empty image is created in a new study. A new structure set is created for the image. + def AddEmptyPhantom(self, imageId: str, orientation: PatientOrientation, xSizePixel: int, ySizePixel: int, widthMM: float, heightMM: float, nrOfPlanes: int, planeSepMM: float) -> StructureSet: + """ + Args: + imageId: The identifier for the empty image to be created. The value must not be empty. + orientation: The patient orientation in the image. + xSizePixel: The x size of the image in pixels. The expected value is from 23 to 2048 pixels. + ySizePixel: The y size of the image in pixels. The expected value is from 23 to 2048 pixels. + widthMM: The height of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. + heightMM: The width of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. + nrOfPlanes: The number of planes in the image. The expected value is from 1 to 10000. + planeSepMM: The distance between the planes in millimeters. The expected value is from 0.1 to 200.0 millimeters. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add reference point to a patient + def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: + """ + Args: + target: True if point being added is for target volume + id: Identifier for the new reference point + """ + ... + + + # Enables write-access to the data model from the Scripting API. This function must be called for each patient the script modifies. If this function is not called, the data in the database cannot be modified. + def BeginModifications(self) -> None: + ... + + + # Checks if a new course can be added to the patient. + def CanAddCourse(self) -> bool: + ... + + + # Checks if an empty phantom can be added to the patient. The user should have the appropriate permissions to perform the operation. + def CanAddEmptyPhantom(self, errorMessage: str) -> bool: + """ + Args: + errorMessage: If phantom adding is not permitted, contains the error message. + """ + ... + + + # Checks if the image can be copied from the other patient. + def CanCopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str, errorMessage: str) -> bool: + """ + Args: + targetStudy: The target study for the new image series, or null. + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + errorMessage: If copying the image is not permitted, contains the error message. + """ + ... + + + # Returns true if the script can modify patient data in the database. + def CanModifyData(self) -> bool: + ... + + + # Checks if the course can be removed from the patient. + def CanRemoveCourse(self, course: Course) -> bool: + """ + Args: + course: The course to be removed. + """ + ... + + + # Checks if the image can be removed. The image to be removed and the associated structure set should be empty. + def CanRemoveEmptyPhantom(self, structureset: StructureSet, errorMessage: str) -> bool: + """ + Args: + structureset: The structure set to be removed. + errorMessage: If the image and associated structure set cannot be removed, contains the error message. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to this patient. A new study and series is created for the image. The method + def CopyImageFromOtherPatient(self, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: + """ + Args: + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to the given study. A new series is created for the image. The method + def CopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: + """ + Args: + targetStudy: The target study for the new image series. + otherPatientId: The identifier of the other patient. + otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. + otherPatient3DImageId: The identifier of the other patient's 3D image. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes the course from the patient and deletes it. + def RemoveCourse(self, course: Course) -> None: + """ + Args: + course: The course that is removed. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Removes an empty image from the patient. The associated structure set is also removed. The image to be removed and the associated structure set should be empty. + def RemoveEmptyPhantom(self, structureset: StructureSet) -> None: + """ + Args: + structureset: The structure set to be removed. + """ + ... + + + +class PatientSummary: + """ + Basic information about the patient. + + Attributes: + CreationDateTime (Optional[datetime]): The date when the patient object was created. + DateOfBirth (Optional[datetime]): The date of birth of the patient. + FirstName (str): The first name of the patient. + Id (str): The patient ID. + Id2 (str): The patient ID2. + LastName (str): The last name of the patient. + MiddleName (str): The middle name of the patient. + Sex (str): The gender of the patient. + SSN (str): The Social Security Account Number (SSN) of the patient. + CreationDateTime (Optional[datetime]): The date when the patient object was created. + DateOfBirth (Optional[datetime]): The date of birth of the patient. + FirstName (str): The first name of the patient. + Id (str): The patient ID. + Id2 (str): The patient ID2. + LastName (str): The last name of the patient. + MiddleName (str): The middle name of the patient. + Sex (str): The gender of the patient. + SSN (str): The Social Security Account Number (SSN) of the patient. + """ + def __init__(self) -> None: ... + + CreationDateTime: Optional[datetime] + + DateOfBirth: Optional[datetime] + + FirstName: str + + Id: str + + Id2: str + + LastName: str + + MiddleName: str + + Sex: str + + SSN: str + + CreationDateTime: Optional[datetime] + + DateOfBirth: Optional[datetime] + + FirstName: str + + Id: str + + Id2: str + + LastName: str + + MiddleName: str + + Sex: str + + SSN: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class PlanningItem: + """ + Common properties of a treatment plan and a plan sum. + + Attributes: + Course (Course): Used for navigating to parent course. + CreationDateTime (Optional[datetime]): The date when this object was created. + Dose (PlanningItemDose): The total dose. The total dose is the dose of all planned fractions together. + DoseValuePresentation (DoseValuePresentation): The presentation of the dose as absolute or relative. + StructureSet (StructureSet): The structure set. + StructuresSelectedForDvh (List[Structure]): The collection of the structures that have been selected for DVH evaluation in Eclipse. + Course (Course): Used for navigating to parent course. + CreationDateTime (Optional[datetime]): The date when this object was created. + Dose (PlanningItemDose): The total dose. The total dose is the dose of all planned fractions together. + DoseValuePresentation (DoseValuePresentation): The presentation of the dose as absolute or relative. + StructureSet (StructureSet): The structure set. + StructuresSelectedForDvh (List[Structure]): The collection of the structures that have been selected for DVH evaluation in Eclipse. + """ + def __init__(self) -> None: ... + + Course: Course + + CreationDateTime: Optional[datetime] + + Dose: PlanningItemDose + + DoseValuePresentation: DoseValuePresentation + + StructureSet: StructureSet + + StructuresSelectedForDvh: List[Structure] + + Course: Course + + CreationDateTime: Optional[datetime] + + Dose: PlanningItemDose + + DoseValuePresentation: DoseValuePresentation + + StructureSet: StructureSet + + StructuresSelectedForDvh: List[Structure] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Get the list of clinical goals assigned to a planning item. + def GetClinicalGoals(self) -> List[ClinicalGoal]: + ... + + + # Returns cumulative Dose Volume Histogram (DVH) data. + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """ + Args: + structure: Structure for which the DVH data is requested. + dosePresentation: Requested dose presentation mode (absolute or relative). Note, that only absolute dose is supported for PlanSums. + volumePresentation: Requested volume presentation mode. + binWidth: Requested width of the bin. + """ + ... + + + # Gets the dose at a volume. + def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: + """ + Args: + structure: Structure for which the value is requested. + volume: Volume at which the dose is requested. + volumePresentation: Presentation mode of the volume parameter. + requestedDosePresentation: Requested dose presentation mode (absolute or relative). + """ + ... + + + # Gets the volume at the dose. + def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: + """ + Args: + structure: Structure for which the value is requested. + dose: Dose at which the volume is requested. + requestedVolumePresentation: Requested volume presentation mode. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Get the list of clinical goals assigned to a planning item. + def GetClinicalGoals(self) -> List[ClinicalGoal]: + ... + + + # Returns cumulative Dose Volume Histogram (DVH) data. + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """ + Args: + structure: Structure for which the DVH data is requested. + dosePresentation: Requested dose presentation mode (absolute or relative). Note, that only absolute dose is supported for PlanSums. + volumePresentation: Requested volume presentation mode. + binWidth: Requested width of the bin. + """ + ... + + + # Gets the dose at a volume. + def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: + """ + Args: + structure: Structure for which the value is requested. + volume: Volume at which the dose is requested. + volumePresentation: Presentation mode of the volume parameter. + requestedDosePresentation: Requested dose presentation mode (absolute or relative). + """ + ... + + + # Gets the volume at the dose. + def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: + """ + Args: + structure: Structure for which the value is requested. + dose: Dose at which the volume is requested. + requestedVolumePresentation: Requested volume presentation mode. + """ + ... + + + +class PlanSum: + """ + A plan sum describes the cumulative dose summation of several treatment plans. It can be used, for example, to evaluate the dose the patient received from a treatment plan and boost plan together. + + Attributes: + PlanSumComponents (List[PlanSumComponent]): A collection of plans in a plan sum. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSum. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the PlanSum. + PlanSetups (List[PlanSetup]): A collection of plan setups. + PlanSumComponents (List[PlanSumComponent]): A collection of plans in a plan sum. + Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSum. + Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the PlanSum. + PlanSetups (List[PlanSetup]): A collection of plan setups. + """ + def __init__(self) -> None: ... + + PlanSumComponents: List[PlanSumComponent] + + Id: str + + Name: str + + PlanSetups: List[PlanSetup] + + PlanSumComponents: List[PlanSumComponent] + + Id: str + + Name: str + + PlanSetups: List[PlanSetup] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum with default parameters ( + def AddItem(self, pi: PlanningItem) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum. If item to be added is a plan sum, all plans of the plan sum will be added. + def AddItem(self, pi: PlanningItem, operation: PlanSumOperation, planWeight: float) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + operation: The summing operation of the plan in the plan sum. + planWeight: Plan weight + """ + ... + + + # Returns the summing operation of the plan in the plan sum. + def GetPlanSumOperation(self, planSetupInPlanSum: PlanSetup) -> PlanSumOperation: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + """ + ... + + + # Returns the weight of the plan included in the sum. + def GetPlanWeight(self, planSetupInPlanSum: PlanSetup) -> float: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove a planning item from the plan sum. If item to be removed is a plan sum, all plans of the plan sum will be removed. + def RemoveItem(self, pi: PlanningItem) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the summing operation for the plan in the plan sum. + def SetPlanSumOperation(self, planSetupInPlanSum: PlanSetup, operation: PlanSumOperation) -> None: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + operation: The summing operation of the plan in the plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the weight of the plan included in the sum. + def SetPlanWeight(self, planSetupInPlanSum: PlanSetup, weight: float) -> None: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + weight: Plan weight + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum with default parameters ( + def AddItem(self, pi: PlanningItem) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum. If item to be added is a plan sum, all plans of the plan sum will be added. + def AddItem(self, pi: PlanningItem, operation: PlanSumOperation, planWeight: float) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + operation: The summing operation of the plan in the plan sum. + planWeight: Plan weight + """ + ... + + + # Returns the summing operation of the plan in the plan sum. + def GetPlanSumOperation(self, planSetupInPlanSum: PlanSetup) -> PlanSumOperation: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + """ + ... + + + # Returns the weight of the plan included in the sum. + def GetPlanWeight(self, planSetupInPlanSum: PlanSetup) -> float: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Remove a planning item from the plan sum. If item to be removed is a plan sum, all plans of the plan sum will be removed. + def RemoveItem(self, pi: PlanningItem) -> None: + """ + Args: + pi: Planning item, can be plan setup or plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the summing operation for the plan in the plan sum. + def SetPlanSumOperation(self, planSetupInPlanSum: PlanSetup, operation: PlanSumOperation) -> None: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + operation: The summing operation of the plan in the plan sum. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the weight of the plan included in the sum. + def SetPlanWeight(self, planSetupInPlanSum: PlanSetup, weight: float) -> None: + """ + Args: + planSetupInPlanSum: A plan that belongs to this plan sum, included in collection + weight: Plan weight + """ + ... + + + +class SerializableObject: + """ + Base class for objects that can be serialized. + """ + def __init__(self) -> None: ... + + # This member is internal to the Eclipse Scripting API. + def GetSchema(self) -> Xml.Schema.XmlSchema: + ... + + + # This member is internal to the Eclipse Scripting API. + def ReadXml(self, reader: Xml.XmlReader) -> None: + """ + Args: + reader: XmlReader + """ + ... + + + # Serializes this object to the given XmlWriter. + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: XmlWriter where this object is serialized. + """ + ... + + + # Serializes everything except IEnumerable. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Any) -> None: + """ + Args: + writer: XmlWriter + name: Name. + obj: Object. + """ + ... + + + # Serializes a string. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: str) -> None: + """ + Args: + writer: XmlWriter. + name: Name. + obj: String. + """ + ... + + + # Serializes IEnumerable. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: IEnumerable[T]) -> None: + ... + + + # Serializes IDictionary. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Dict[T, T2]) -> None: + ... + + + # Must be called at the beginning of serialization + def StartSerialization(self, typeName: str, typeId: str) -> Any: + """ + Args: + typeName: Name of the type to serialize. + typeId: Id of the object. + """ + ... + + + # Must be called at the end of serialization. Clear history records and type names. + def EndSerialization(self) -> Any: + ... + + + # Check if history contains information about class + def IsTypeSerialized(self) -> Any: + ... + + + # Add history record + def AddTypeToHistory(self) -> Any: + ... + + + # This member is internal to the Eclipse Scripting API. + def ClearSerializationHistory(self) -> None: + ... + + + # This member is internal to the Eclipse Scripting API. + def GetSchema(self) -> Xml.Schema.XmlSchema: + ... + + + # This member is internal to the Eclipse Scripting API. + def ReadXml(self, reader: Xml.XmlReader) -> None: + """ + Args: + reader: XmlReader + """ + ... + + + # Serializes this object to the given XmlWriter. + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: XmlWriter where this object is serialized. + """ + ... + + + # Serializes everything except IEnumerable. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Any) -> None: + """ + Args: + writer: XmlWriter + name: Name. + obj: Object. + """ + ... + + + # Serializes a string. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: str) -> None: + """ + Args: + writer: XmlWriter. + name: Name. + obj: String. + """ + ... + + + # Serializes IEnumerable. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: IEnumerable[T]) -> None: + ... + + + # Serializes IDictionary. + def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Dict[T, T2]) -> None: + ... + + + # Must be called at the beginning of serialization + def StartSerialization(self, typeName: str, typeId: str) -> Any: + """ + Args: + typeName: Name of the type to serialize. + typeId: Id of the object. + """ + ... + + + # Must be called at the end of serialization. Clear history records and type names. + def EndSerialization(self) -> Any: + ... + + + # Check if history contains information about class + def IsTypeSerialized(self) -> Any: + ... + + + # Add history record + def AddTypeToHistory(self) -> Any: + ... + + + # This member is internal to the Eclipse Scripting API. + def ClearSerializationHistory(self) -> None: + ... + + + +class Registration: + """ + Represents the spatial registration matrix between two frames of reference. + + Attributes: + CreationDateTime (Optional[datetime]): The date when this object was created. + RegisteredFOR (str): The frame of reference UID of the registered coordinate system. + SourceFOR (str): The frame of reference UID of the source coordinate system. + Status (RegistrationApprovalStatus): The current approval status of the registration. + StatusDateTime (Optional[datetime]): The approval status date and time. + StatusUserDisplayName (str): Full user name of user who changed the approval status. + StatusUserName (str): User ID of the user who changed the approval status. + TransformationMatrix (Array[float]): The elements of the 4x4 transformation matrix. + UID (str): The SOP Instance UID of this registration object. + CreationDateTime (Optional[datetime]): The date when this object was created. + RegisteredFOR (str): The frame of reference UID of the registered coordinate system. + SourceFOR (str): The frame of reference UID of the source coordinate system. + Status (RegistrationApprovalStatus): The current approval status of the registration. + StatusDateTime (Optional[datetime]): The approval status date and time. + StatusUserDisplayName (str): Full user name of user who changed the approval status. + StatusUserName (str): User ID of the user who changed the approval status. + TransformationMatrix (Array[float]): The elements of the 4x4 transformation matrix. + UID (str): The SOP Instance UID of this registration object. + """ + def __init__(self) -> None: ... + + CreationDateTime: Optional[datetime] + + RegisteredFOR: str + + SourceFOR: str + + Status: RegistrationApprovalStatus + + StatusDateTime: Optional[datetime] + + StatusUserDisplayName: str + + StatusUserName: str + + TransformationMatrix: Array[float] + + UID: str + + CreationDateTime: Optional[datetime] + + RegisteredFOR: str + + SourceFOR: str + + Status: RegistrationApprovalStatus + + StatusDateTime: Optional[datetime] + + StatusUserDisplayName: str + + StatusUserName: str + + TransformationMatrix: Array[float] + + UID: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Transforms a point in the inverse direction, that is, from the coordinate system of the RegisteredFOR to the coordinate system of the SourceFOR. + def InverseTransformPoint(self, pt: VVector) -> VVector: + """ + Args: + pt: Point in the RegisteredFOR coordinate system. + """ + ... + + + # Transforms a point from the SourceFOR coordinate system to the RegisteredFOR coordinate system. + def TransformPoint(self, pt: VVector) -> VVector: + """ + Args: + pt: Point in the SourceFOR coordinate system. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Transforms a point in the inverse direction, that is, from the coordinate system of the RegisteredFOR to the coordinate system of the SourceFOR. + def InverseTransformPoint(self, pt: VVector) -> VVector: + """ + Args: + pt: Point in the RegisteredFOR coordinate system. + """ + ... + + + # Transforms a point from the SourceFOR coordinate system to the RegisteredFOR coordinate system. + def TransformPoint(self, pt: VVector) -> VVector: + """ + Args: + pt: Point in the SourceFOR coordinate system. + """ + ... + + + +class Series: + """ + A series is a collection of radiation therapy objects of a patient. The series is part of a study. See the definition of a DICOM Series for more information. + + Attributes: + FOR (str): The UID of the frame of reference. + Images (List[Image]): A collection of images that belong to the series. + ImagingDeviceDepartment (str): The assigned department of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device department is not defined. + ImagingDeviceId (str): The identifier of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device identifier is not defined. + ImagingDeviceManufacturer (str): The manufacturer of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device manufacturer is not defined. + ImagingDeviceModel (str): The model of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device model is not defined. + ImagingDeviceSerialNo (str): The serial number of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device serial number is not defined. + Modality (SeriesModality): The modality of the series. + Study (Study): Used for navigating to parent study. + UID (str): The DICOM UID. + FOR (str): The UID of the frame of reference. + Images (List[Image]): A collection of images that belong to the series. + ImagingDeviceDepartment (str): The assigned department of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device department is not defined. + ImagingDeviceId (str): The identifier of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device identifier is not defined. + ImagingDeviceManufacturer (str): The manufacturer of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device manufacturer is not defined. + ImagingDeviceModel (str): The model of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device model is not defined. + ImagingDeviceSerialNo (str): The serial number of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device serial number is not defined. + Modality (SeriesModality): The modality of the series. + Study (Study): Used for navigating to parent study. + UID (str): The DICOM UID. + """ + def __init__(self) -> None: ... + + FOR: str + + Images: List[Image] + + ImagingDeviceDepartment: str + + ImagingDeviceId: str + + ImagingDeviceManufacturer: str + + ImagingDeviceModel: str + + ImagingDeviceSerialNo: str + + Modality: SeriesModality + + Study: Study + + UID: str + + FOR: str + + Images: List[Image] + + ImagingDeviceDepartment: str + + ImagingDeviceId: str + + ImagingDeviceManufacturer: str + + ImagingDeviceModel: str + + ImagingDeviceSerialNo: str + + Modality: SeriesModality + + Study: Study + + UID: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the imaging device for the image series based on the identifier of the imaging device. If the imaging device identifier is not found, an exception is thrown. + def SetImagingDevice(self, imagingDeviceId: str) -> None: + """ + Args: + imagingDeviceId: Identifier of the imaging device. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # [Availability of this method depends on your Eclipse Scripting API license] Sets the imaging device for the image series based on the identifier of the imaging device. If the imaging device identifier is not found, an exception is thrown. + def SetImagingDevice(self, imagingDeviceId: str) -> None: + """ + Args: + imagingDeviceId: Identifier of the imaging device. + """ + ... + + + +class Slot: + """ + A slot is the location (typically on the collimator head of the gantry) where an add-on, such as a wedge or block, is mounted. + + Attributes: + Number (int): The slot number is unique within an instance of a treatment machine. + Number (int): The slot number is unique within an instance of a treatment machine. + """ + def __init__(self) -> None: ... + + Number: int + + Number: int + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Study: + """ + A study is a collection of series. + + Attributes: + CreationDateTime (Optional[datetime]): The date when this object was created. + Images3D (List[Image]): A collection of 3D images in a study. + Series (List[Series]): A collection of series. + UID (str): The DICOM UID. + CreationDateTime (Optional[datetime]): The date when this object was created. + Images3D (List[Image]): A collection of 3D images in a study. + Series (List[Series]): A collection of series. + UID (str): The DICOM UID. + """ + def __init__(self) -> None: ... + + CreationDateTime: Optional[datetime] + + Images3D: List[Image] + + Series: List[Series] + + UID: str + + CreationDateTime: Optional[datetime] + + Images3D: List[Image] + + Series: List[Series] + + UID: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Technique: + """ + Treatment technique used for a beam. Can be, for example, static or arc, or (for proton beams) modulated scanning. + + Attributes: + IsArc (bool): Returns the value true if the beam technique is 'ARC' or 'SRS ARC'. + IsModulatedScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING'. + IsProton (bool): Returns the value true if it is a proton beam. + IsScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING' or 'UNIFORM_SCANNING'. + IsStatic (bool): Returns the value true if the beam technique is 'STATIC' or 'SRS STATIC'. + IsArc (bool): Returns the value true if the beam technique is 'ARC' or 'SRS ARC'. + IsModulatedScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING'. + IsProton (bool): Returns the value true if it is a proton beam. + IsScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING' or 'UNIFORM_SCANNING'. + IsStatic (bool): Returns the value true if the beam technique is 'STATIC' or 'SRS STATIC'. + """ + def __init__(self) -> None: ... + + IsArc: bool + + IsModulatedScanning: bool + + IsProton: bool + + IsScanning: bool + + IsStatic: bool + + IsArc: bool + + IsModulatedScanning: bool + + IsProton: bool + + IsScanning: bool + + IsStatic: bool + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class TradeoffObjective: + """ + Trade-off objective interface that consists of a set of optimization objectives. + + Attributes: + Id (int): Identifier of the trade-off objective. + OptimizationObjectives (List[OptimizationObjective]): The collection of objectives that this trade-off objective represents. + Structure (Structure): Structure that this trade-off objective represents. + Id (int): Identifier of the trade-off objective. + OptimizationObjectives (List[OptimizationObjective]): The collection of objectives that this trade-off objective represents. + Structure (Structure): Structure that this trade-off objective represents. + """ + def __init__(self) -> None: ... + + Id: int + + OptimizationObjectives: List[OptimizationObjective] + + Structure: Structure + + Id: int + + OptimizationObjectives: List[OptimizationObjective] + + Structure: Structure + + +class Tray: + """ + A tray add-on is a plate where blocks, compensators, and other beam modifying materials can be fixed to. The tray is inserted into a slot during the treatment of a beam. + """ + def __init__(self) -> None: ... + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class TreatmentPhase: + """ + Treatment phase. + + Attributes: + OtherInfo (str): Other info (notes). + PhaseGapNumberOfDays (int): Number of days between phases. + Prescriptions (List[RTPrescription]): A collection of RT prescriptions in the course. + TimeGapType (str): Type of the time gap. + OtherInfo (str): Other info (notes). + PhaseGapNumberOfDays (int): Number of days between phases. + Prescriptions (List[RTPrescription]): A collection of RT prescriptions in the course. + TimeGapType (str): Type of the time gap. + """ + def __init__(self) -> None: ... + + OtherInfo: str + + PhaseGapNumberOfDays: int + + Prescriptions: List[RTPrescription] + + TimeGapType: str + + OtherInfo: str + + PhaseGapNumberOfDays: int + + Prescriptions: List[RTPrescription] + + TimeGapType: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class TreatmentSession: + """ + Treatment session. + + Attributes: + SessionNumber (int): Treatment session number. + SessionPlans (List[PlanTreatmentSession]): Plans in this treatment session. + SessionNumber (int): Treatment session number. + SessionPlans (List[PlanTreatmentSession]): Plans in this treatment session. + """ + def __init__(self) -> None: ... + + SessionNumber: int + + SessionPlans: List[PlanTreatmentSession] + + SessionNumber: int + + SessionPlans: List[PlanTreatmentSession] + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class TreatmentUnitOperatingLimit: + """ + Describes the limits of a treatment unit parameter and provides descriptive information related to it. + + Attributes: + Label (str): Gets the descriptive name of the operating limit parameter. + MaxValue (float): Gets the maximum allowed value for the operating limit parameter. + MinValue (float): Gets the minimum allowed value for the operating limit parameter. + Precision (Optional[int]): Gets the number of decimal places to display for the operating limit parameter. + UnitString (str): Gets the string that describes the unit of the operating limit parameter. + Label (str): Gets the descriptive name of the operating limit parameter. + MaxValue (float): Gets the maximum allowed value for the operating limit parameter. + MinValue (float): Gets the minimum allowed value for the operating limit parameter. + Precision (Optional[int]): Gets the number of decimal places to display for the operating limit parameter. + UnitString (str): Gets the string that describes the unit of the operating limit parameter. + """ + def __init__(self) -> None: ... + + Label: str + + MaxValue: float + + MinValue: float + + Precision: Optional[int] + + UnitString: str + + Label: str + + MaxValue: float + + MinValue: float + + Precision: Optional[int] + + UnitString: str + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class TreatmentUnitOperatingLimits: + """ + Provides operating limit information for treatment unit parameters. + + Attributes: + CollimatorAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the collimator angle parameter. + GantryAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the gantry angle parameter. + MU (TreatmentUnitOperatingLimit): Gets the operating limit information for the monitor unit (MU) parameter. + PatientSupportAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the patient support angle parameter. + CollimatorAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the collimator angle parameter. + GantryAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the gantry angle parameter. + MU (TreatmentUnitOperatingLimit): Gets the operating limit information for the monitor unit (MU) parameter. + PatientSupportAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the patient support angle parameter. + """ + def __init__(self) -> None: ... + + CollimatorAngle: TreatmentUnitOperatingLimit + + GantryAngle: TreatmentUnitOperatingLimit + + MU: TreatmentUnitOperatingLimit + + PatientSupportAngle: TreatmentUnitOperatingLimit + + CollimatorAngle: TreatmentUnitOperatingLimit + + GantryAngle: TreatmentUnitOperatingLimit + + MU: TreatmentUnitOperatingLimit + + PatientSupportAngle: TreatmentUnitOperatingLimit + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + +class Wedge: + """ + A wedge is a beam modulating add-on that modifies the dose intensity over all or a part of a treatment beam. + + Attributes: + Direction (float): The wedge orientation with respect to the beam orientation, in degrees. + WedgeAngle (float): The wedge angle. + Direction (float): The wedge orientation with respect to the beam orientation, in degrees. + WedgeAngle (float): The wedge angle. + + Note: + Use run-time type information via operator + """ + def __init__(self) -> None: ... + + Direction: float + + WedgeAngle: float + + Direction: float + + WedgeAngle: float + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream, to which the object is serialized. + """ + ... + + + diff --git a/pyesapi/VMS/TPS/Common/Model/API/AsyncPump/AsyncPump.pyi b/pyesapi/VMS/TPS/Common/Model/API/AsyncPump/AsyncPump.pyi new file mode 100644 index 0000000..1cdb928 --- /dev/null +++ b/pyesapi/VMS/TPS/Common/Model/API/AsyncPump/AsyncPump.pyi @@ -0,0 +1,211 @@ +""" +Type stubs for VMS.TPS.Common.Model.API.AsyncPump +Generated from .NET XML documentation +""" + +from typing import Any, List, Optional, Union, Dict, Iterable, overload +from datetime import datetime +from System import Array, Double, Single, Int32, Boolean, String +from System.Collections.Generic import KeyValuePair +from System import Collections + +class SingleThreadSynchronizationContext: + """ + Provides a SynchronizationContext object that is single-threaded. + """ + def __init__(self) -> None: ... + + # Dispatches an asynchronous message to the synchronization context. + def Post(self, d: Threading.SendOrPostCallback, state: Any) -> Any: + """ + Args: + d: The System.Threading.SendOrPostCallback delegate to call. + state: The object passed to the delegate. + """ + ... + + + # Not supported. + def Send(self, param1: Threading.SendOrPostCallback, param2: Any) -> Any: + ... + + + # Runs an loop to process all queued work items. + def RunOnCurrentThread(self) -> Any: + ... + + + # Notifies the context that no more work will arrive. + def Complete(self) -> Any: + ... + + + # Dispatches an asynchronous message to the synchronization context. + def Post(self, d: Threading.SendOrPostCallback, state: Any) -> Any: + """ + Args: + d: The System.Threading.SendOrPostCallback delegate to call. + state: The object passed to the delegate. + """ + ... + + + # Not supported. + def Send(self, param1: Threading.SendOrPostCallback, param2: Any) -> Any: + ... + + + # Runs an loop to process all queued work items. + def RunOnCurrentThread(self) -> Any: + ... + + + # Notifies the context that no more work will arrive. + def Complete(self) -> Any: + ... + + + +class SingleThreadSynchronizationContextSetter: + """ + Provides a temporary single-threaded environment until the diposal of this object ( + """ + # Sets SynchronizationContext to a + @overload + def __init__(self) -> None: + ... + + + # Sets SynchronizationContext to a + @overload + def __init__(self) -> None: + ... + + + # Resets the SynchronizationContext. + def Dispose(self) -> Any: + ... + + + def Complete(self) -> Any: + ... + + + def Run(self) -> Any: + ... + + + # Resets the SynchronizationContext. + def Dispose(self) -> Any: + ... + + + def Complete(self) -> Any: + ... + + + def Run(self) -> Any: + ... + + + +class SingleThreadSynchronizationContext: + """ + Provides a SynchronizationContext object that is single-threaded. + """ + def __init__(self) -> None: ... + + # Dispatches an asynchronous message to the synchronization context. + def Post(self, d: Threading.SendOrPostCallback, state: Any) -> Any: + """ + Args: + d: The System.Threading.SendOrPostCallback delegate to call. + state: The object passed to the delegate. + """ + ... + + + # Not supported. + def Send(self, param1: Threading.SendOrPostCallback, param2: Any) -> Any: + ... + + + # Runs an loop to process all queued work items. + def RunOnCurrentThread(self) -> Any: + ... + + + # Notifies the context that no more work will arrive. + def Complete(self) -> Any: + ... + + + # Dispatches an asynchronous message to the synchronization context. + def Post(self, d: Threading.SendOrPostCallback, state: Any) -> Any: + """ + Args: + d: The System.Threading.SendOrPostCallback delegate to call. + state: The object passed to the delegate. + """ + ... + + + # Not supported. + def Send(self, param1: Threading.SendOrPostCallback, param2: Any) -> Any: + ... + + + # Runs an loop to process all queued work items. + def RunOnCurrentThread(self) -> Any: + ... + + + # Notifies the context that no more work will arrive. + def Complete(self) -> Any: + ... + + + +class SingleThreadSynchronizationContextSetter: + """ + Provides a temporary single-threaded environment until the diposal of this object ( + """ + # Sets SynchronizationContext to a + @overload + def __init__(self) -> None: + ... + + + # Sets SynchronizationContext to a + @overload + def __init__(self) -> None: + ... + + + # Resets the SynchronizationContext. + def Dispose(self) -> Any: + ... + + + def Complete(self) -> Any: + ... + + + def Run(self) -> Any: + ... + + + # Resets the SynchronizationContext. + def Dispose(self) -> Any: + ... + + + def Complete(self) -> Any: + ... + + + def Run(self) -> Any: + ... + + + diff --git a/pyesapi/stubs/__init__.py b/pyesapi/VMS/TPS/Common/Model/API/AsyncPump/__init__.pyi similarity index 100% rename from pyesapi/stubs/__init__.py rename to pyesapi/VMS/TPS/Common/Model/API/AsyncPump/__init__.pyi diff --git a/pyesapi/VMS/TPS/Common/Model/API/Calculation/Calculation.pyi b/pyesapi/VMS/TPS/Common/Model/API/Calculation/Calculation.pyi new file mode 100644 index 0000000..7bd1f31 --- /dev/null +++ b/pyesapi/VMS/TPS/Common/Model/API/Calculation/Calculation.pyi @@ -0,0 +1,39 @@ +""" +Type stubs for VMS.TPS.Common.Model.API.Calculation +Generated from .NET XML documentation +""" + +from typing import Any, List, Optional, Union, Dict, Iterable +from datetime import datetime +from System import Array, Double, Single, Int32, Boolean, String +from System.Collections.Generic import KeyValuePair +from System import Collections + +class Algorithm: + """ + Algorithm + """ + def __init__(self) -> None: ... + + +class CalculationModel: + """ + Calculation Model + """ + def __init__(self) -> None: ... + + +class Algorithm: + """ + Algorithm + """ + def __init__(self) -> None: ... + + +class CalculationModel: + """ + Calculation Model + """ + def __init__(self) -> None: ... + + diff --git a/pyesapi/VMS/TPS/Common/Model/API/Calculation/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/API/Calculation/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/API/ControlPointCollection/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/API/ControlPointCollection/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/API/IonControlPointCollection/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/API/IonControlPointCollection/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/API/IonControlPointPairCollection/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/API/IonControlPointPairCollection/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/API/IonSpotCollection/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/API/IonSpotCollection/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/API/IonSpotParametersCollection/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/API/IonSpotParametersCollection/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/API/StructureCodeDictionary/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/API/StructureCodeDictionary/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/API/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/API/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/DoseValue/DoseValue.pyi b/pyesapi/VMS/TPS/Common/Model/Types/DoseValue/DoseValue.pyi new file mode 100644 index 0000000..001ed79 --- /dev/null +++ b/pyesapi/VMS/TPS/Common/Model/Types/DoseValue/DoseValue.pyi @@ -0,0 +1,18 @@ +""" +Type stubs for VMS.TPS.Common.Model.Types.DoseValue +Generated from .NET XML documentation +""" + +from typing import Any, List, Optional, Union, Dict, Iterable +from datetime import datetime +from System import Array, Double, Single, Int32, Boolean, String +from System.Collections.Generic import KeyValuePair +from System import Collections + +class DoseUnit: + """ + The unit of the dose value. + """ + def __init__(self) -> None: ... + + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/DoseValue/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/DoseValue/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/DoseValueDisplayConfig/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/DoseValueDisplayConfig/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/LineProfile/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/LineProfile/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/PlanValidationResultDetail.pyi b/pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/PlanValidationResultDetail.pyi new file mode 100644 index 0000000..6fb7b64 --- /dev/null +++ b/pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/PlanValidationResultDetail.pyi @@ -0,0 +1,18 @@ +""" +Type stubs for VMS.TPS.Common.Model.Types.PlanValidationResultDetail +Generated from .NET XML documentation +""" + +from typing import Any, List, Optional, Union, Dict, Iterable +from datetime import datetime +from System import Array, Double, Single, Int32, Boolean, String +from System.Collections.Generic import KeyValuePair +from System import Collections + +class ResultClassification: + """ + Classification of plan validation detail. + """ + def __init__(self) -> None: ... + + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/SegmentProfile/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/SegmentProfile/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/Types.pyi b/pyesapi/VMS/TPS/Common/Model/Types/Types.pyi new file mode 100644 index 0000000..0b804cb --- /dev/null +++ b/pyesapi/VMS/TPS/Common/Model/Types/Types.pyi @@ -0,0 +1,2468 @@ +""" +Type stubs for VMS.TPS.Common.Model.Types +Generated from .NET XML documentation +""" + +from typing import Any, List, Optional, Union, Dict, Iterable, TypeVar, Generic, overload +from datetime import datetime +from System import Array, Double, Single, Int32, Boolean, String +from System.Collections.Generic import KeyValuePair +from System import Collections + +# Generic type variables +T = TypeVar('T') +T1 = TypeVar('T1') +T2 = TypeVar('T2') +T3 = TypeVar('T3') + +class BeamNumber: + """ + Represents a unique identifier for a beam of a plan. The identifier is unique within the scope of the plan. + + Attributes: + Number (int): The beam number. + IsValid (bool): Returns true if the given BeamNumber is valid. Otherwise false. + """ + # Constructs a new beam number from a numeric beam number. + @overload + def __init__(self, number: int) -> None: + """ + Args: + number: Make sure that the beam number corresponds to the real beam number, otherwise use NotABeamNumber. + """ + ... + + + # Constructs a new beam number from another BeamNumber. + @overload + def __init__(self, other: BeamNumber) -> None: + """ + Args: + other: Another BeamNumber. + """ + ... + + + Number: int + + IsValid: bool + + # Compares two beam numbers for equality. + def op_Equality(self, a: BeamNumber, b: BeamNumber) -> bool: + """ + Args: + a: The first object to compare. + b: The second object to compare. + """ + ... + + + # Compares two BeamNumbers for inequality. + def op_Inequality(self, a: BeamNumber, b: BeamNumber) -> bool: + """ + Args: + a: The first object to compare. + b: The second object to compare. + """ + ... + + + # Compares two BeamNumbers, a and b, to determine if a is greater than b. + def op_GreaterThan(self, a: BeamNumber, b: BeamNumber) -> bool: + """ + Args: + a: The first object to compare. + b: The second object to compare. + """ + ... + + + # Compares two BeamNumbers, a and b, to determine if a is smaller than b. + def op_LessThan(self, a: BeamNumber, b: BeamNumber) -> bool: + """ + Args: + a: The first object to compare. + b: The second object to compare. + """ + ... + + + # Compares two BeamNumbers, a and b, to determine if a is greater than or equal to b. + def op_GreaterThanOrEqual(self, a: BeamNumber, b: BeamNumber) -> bool: + """ + Args: + a: The first object to compare. + b: The second object to compare. + """ + ... + + + # Compares two BeamNumbers, a and b, to determine if a is smaller than or equal to b. + def op_LessThanOrEqual(self, a: BeamNumber, b: BeamNumber) -> bool: + """ + Args: + a: The first object to compare. + b: The second object to compare. + """ + ... + + + # Converts a BeamNumber to an int. + def op_Implicit(self, bn: Int32) -> int: + """ + Args: + bn: The converted BeamNumber object. + """ + ... + + + # Provides a hash code for the item, see + def GetHashCode(self) -> int: + ... + + + # Determines whether the specified object is equal to the current object. + def Equals(self, other: Any) -> bool: + """ + Args: + other: The other object to compare. + """ + ... + + + # Indicates whether the current object is equal to another object of the same type. + def Equals(self, other: BeamNumber) -> bool: + """ + Args: + other: An object to compare with this object. + """ + ... + + + # This member is internal to the Eclipse Scripting API. + def GetSchema(self) -> Xml.Schema.XmlSchema: + ... + + + # This member is internal to the Eclipse Scripting API. + def ReadXml(self, reader: Xml.XmlReader) -> None: + """ + Args: + reader: The XmlReader stream from which the object is deserialized. + """ + ... + + + # Serialization support. + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream to which the object is serialized. + """ + ... + + + +class StructureMarginGeometry: + """ + Specifies whether a margin operation expands (outer margin) or shrinks (inner margin) the volume. + """ + def __init__(self) -> None: ... + + +class AxisAlignedMargins: + """ + Represents margins aligned to the axes of the image coordinate system, in mm. Negative margins are not allowed, but it is possible to specify whether the margins represent an inner or outer margin. + """ + # Constructs a new AxisAlignedMargins instance. The given margins are aligned to the axes of the image coordinate system, in mm. + def __init__(self, geometry: StructureMarginGeometry, x1: float, y1: float, z1: float, x2: float, y2: float, z2: float) -> None: + """ + Args: + geometry: Specifies whether the margin operation expands (outer margin) or shrinks (inner margin) the volume. + x1: A non-negative value defining the margin towards the negative X axis, in mm. + y1: A non-negative value defining the margin towards the negative Y axis, in mm. + z1: A non-negative value defining the margin towards the negative Z axis, in mm. + x2: A non-negative value defining the margin towards the positive X axis, in mm. + y2: A non-negative value defining the margin towards the positive Y axis, in mm. + z2: A non-negative value defining the margin towards the positive Z axis, in mm. + """ + ... + + + # A string that represents the current object. + def ToString(self) -> str: + ... + + + +class ChangeBrachyTreatmentUnitResult: + """ + Return value for + """ + def __init__(self) -> None: ... + + +class ObjectiveGoalType: + """ + Clinical goal Objective type + """ + def __init__(self) -> None: ... + + +class ObjectiveOperator: + """ + Clinical goal Objective operator + """ + def __init__(self) -> None: ... + + +class ObjectiveUnit: + """ + Clinical goal Objective Unit + """ + def __init__(self) -> None: ... + + +class Objective: + """ + Represents a clinical goal objective. + + Attributes: + Type (ObjectiveGoalType): Objective type + Value (float): Objective value + ValueUnit (ObjectiveUnit): Objective value + Operator (ObjectiveOperator): Objective operator + Limit (float): Objective limit + LimitUnit (ObjectiveUnit): Objective limit unit + """ + # Clinical Goal Objective constructor + def __init__(self, type: ObjectiveGoalType, value: float, valueUnit: ObjectiveUnit, oper: ObjectiveOperator, limit: float, limitUnit: ObjectiveUnit) -> None: + """ + Args: + type: Objective type. + value: Objective value. + valueUnit: Value unit. + oper: Operator. + limit: Limit. + limitUnit: Limit unit. + """ + ... + + + Type: ObjectiveGoalType + + Value: float + + ValueUnit: ObjectiveUnit + + Operator: ObjectiveOperator + + Limit: float + + LimitUnit: ObjectiveUnit + + # This member is internal to the Eclipse Scripting API. + def GetSchema(self) -> Xml.Schema.XmlSchema: + ... + + + # This member is internal to the Eclipse Scripting API. + def ReadXml(self, reader: Xml.XmlReader) -> None: + """ + Args: + reader: XmlReader. + """ + ... + + + # Serialization support. TODO: Convert unit and operator to human form. + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream to which the object is serialized. + """ + ... + + + +class ClinicalGoal: + """ + Represents a clinical goal. + + Attributes: + MeasureType (MeasureType): Clinical goal measure type + StructureId (str): Clinical goal structure Id + Objective (Objective): Clinical goal objective + ObjectiveAsString (str): String representation of clinical goal objective + Priority (GoalPriority): Goal priority (0-4), where 0 is Most Important + VariationAcceptable (float): Clinical goal Variation Acceptable (tolerance) + VariationAcceptableAsString (str): String representation of clinical goal Variation Acceptable (tolerance) + ActualValue (float): Clinical goal actual value + ActualValueAsString (str): String representation of clinical goal actual value + EvaluationResult (GoalEvalResult): Evaluation result. + """ + # Construct a ClinicalGoal + def __init__(self, measureType: MeasureType, structureId: str, objective: Objective, objAsString: str, priority: GoalPriority, tolerance: float, toleranceAsString: str, actual: float, actualAsString: str, evalResult: GoalEvalResult) -> None: + """ + Args: + measureType: Measure Type. + structureId: Structure ID. + objective: Objective. + objAsString: Objective as a string. + priority: Priority. + tolerance: Tolerance. + toleranceAsString: Tolerance as a string. + actual: Actual value. + actualAsString: Actual value as a string. + evalResult: Goal evaluation result. + """ + ... + + + MeasureType: MeasureType + + StructureId: str + + Objective: Objective + + ObjectiveAsString: str + + Priority: GoalPriority + + VariationAcceptable: float + + VariationAcceptableAsString: str + + ActualValue: float + + ActualValueAsString: str + + EvaluationResult: GoalEvalResult + + # This member is internal to the Eclipse Scripting API. + def GetSchema(self) -> Xml.Schema.XmlSchema: + ... + + + # This member is internal to the Eclipse Scripting API. + def ReadXml(self, reader: Xml.XmlReader) -> None: + """ + Args: + reader: XmlReader. + """ + ... + + + # Serialization support. + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream to which the object is serialized. + """ + ... + + + +class IDoseValueDisplaySettings: + """ + Application specific dose value display settings. + """ + def __init__(self) -> None: ... + + # Determines how many decimals to use to display a dosevalue with specified unit. + def Decimals(self, unit: DoseUnit) -> int: + """ + Args: + unit: DoseUnit for which the number of decimals is requested. + """ + ... + + + +class DoseValueDisplayConfig: + """ + Configure the settings related to the dose value display for the application. Defaults to the same settings as Eclipse. + + Attributes: + DisplaySettings (IDoseValueDisplaySettings): Get and set current dosevalue display settings. Set settings controller to null reverts to default display settings. + """ + def __init__(self) -> None: ... + + DisplaySettings: IDoseValueDisplaySettings + + # Get number of decimals to user for dosevalue of the defined dose unit + def Decimals(self, unit: DoseUnit) -> int: + """ + Args: + unit: DoseUnit for which the number of decimals is requested. + """ + ... + + + +class DoseValue: + """ + Represents a dose value. DoseValue semantics follows the semantics of System.Double, with DoseValue.Undefined corresponding to Double.NaN. + + Attributes: + Dose (float): The value of this instance. + Unit (DoseValue+DoseUnit): The unit of this instance. + UnitAsString (str): The unit of this instance as a string. + ValueAsString (str): The value of this instance as a string. + IsAbsoluteDoseValue (bool): Returns true if the unit of the dose value is absolute (Gy or cGy). + IsRelativeDoseValue (bool): Returns true if the unit of the dose value is relative (%). + Decimals (int): The display precision of this value + """ + # Constructs a DoseValue. + @overload + def __init__(self, value: float, unitName: str) -> None: + """ + Args: + value: Value for this instance. + unitName: String that corresponds to one of the enumeration values of DoseUnit. + """ + ... + + + # Constructs a DoseValue. + @overload + def __init__(self, value: float, unit: DoseUnit) -> None: + """ + Args: + value: Value for this instance + unit: Unit of this instance. + """ + ... + + + Dose: float + + Unit: DoseValue+DoseUnit + + UnitAsString: str + + ValueAsString: str + + IsAbsoluteDoseValue: bool + + IsRelativeDoseValue: bool + + Decimals: int + + # Equality comparison of DoseValue and Object. This method considers two instances of DoseValue.Undefined to be equal to each other. Otherwise, a dose value is equal to an object only if the object is a DoseValue and the units and the values are equal. For epsilon-equal comparison, use + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: Object to compare this to. + """ + ... + + + # A hash code for the current object. + def GetHashCode(self) -> int: + ... + + + # Equality comparison of dose values. This method considers two instances of DoseValue.Undefined to be equal to each other. Otherwise, two dose values are equal only if the units and the values are equal. For epsilon-equal comparison, use + def Equals(self, other: DoseValue) -> bool: + """ + Args: + other: Dose value to compare this to. + """ + ... + + + # Epsilon-equality comparison of dose values. This method considers two instances of DoseValue.Undefined to be equal to each other. Otherwise, two dose values are equal only if the units are equal and the values are within epsilon. + def Equals(self, other: DoseValue, epsilon: float) -> bool: + """ + Args: + other: Dose value to compare this to. + epsilon: Epsilon to use for the dose value comparison. + """ + ... + + + # Equality operator for dose values. This operator considers two instances of DoseValue.Undefined to be inequal. For epsilon-equal comparison, use + def op_Equality(self, dv1: DoseValue, dv2: DoseValue) -> bool: + """ + Args: + dv1: First operand. + dv2: Second operand. + """ + ... + + + # Inequality operator for dose values. This operator considers two instances of DoseValue.Undefined to be inequal. For epsilon-equal comparison, use + def op_Inequality(self, dv1: DoseValue, dv2: DoseValue) -> bool: + """ + Args: + dv1: First operand. + dv2: Second operand. + """ + ... + + + # Comparison of dose values. DoseValue.Undefined preceeds other values. Otherwise, different units cause an exception to be thrown. The values are compared using Double.CompareTo(Double). + def CompareTo(self, other: DoseValue) -> int: + """ + Args: + other: Dose value to compare this to. + """ + ... + + + # Less-than comparison of dose values. Comparison with DoseValue.Undefined is false. + def op_LessThan(self, dv1: DoseValue, dv2: DoseValue) -> bool: + """ + Args: + dv1: First operand. + dv2: Second operand. + """ + ... + + + # Less-than-or-equal comparison of dose values. Comparison with DoseValue.Undefined is false. + def op_LessThanOrEqual(self, dv1: DoseValue, dv2: DoseValue) -> bool: + """ + Args: + dv1: First operand. + dv2: Second operand. + """ + ... + + + # Greater-than comparison of dose values. Comparison with DoseValue.Undefined is false. + def op_GreaterThan(self, dv1: DoseValue, dv2: DoseValue) -> bool: + """ + Args: + dv1: First operand. + dv2: Second operand. + """ + ... + + + # Greater-than comparison of dose values. Comparison with DoseValue.Undefined is false. + def op_GreaterThanOrEqual(self, dv1: DoseValue, dv2: DoseValue) -> bool: + """ + Args: + dv1: First operand. + dv2: Second operand. + """ + ... + + + # Subtraction of dose values. If either of the operands is DoseValue.Undefined, the result will be DoseValue.Undefined. + def op_Subtraction(self, dv1: DoseValue, dv2: DoseValue) -> DoseValue: + """ + Args: + dv1: First operand. + dv2: Second operand. + """ + ... + + + # Addition of dose values. If either of the operands is DoseValue.Undefined, the result will be DoseValue.Undefined. + def op_Addition(self, dv1: DoseValue, dv2: DoseValue) -> DoseValue: + """ + Args: + dv1: First operand. + dv2: Second operand. + """ + ... + + + # Multiplication of a dose value and a double. If the dose value is DoseValue.Undefined, the result will be DoseValue.Undefined. + def op_Multiply(self, dv: DoseValue, dbl: float) -> DoseValue: + """ + Args: + dv: DoseValue to multiply. + dbl: Multiplier. + """ + ... + + + # Multiplication of a dose value and a double. If the dose value is DoseValue.Undefined, the result will be DoseValue.Undefined. + def op_Multiply(self, dbl: float, dv: DoseValue) -> DoseValue: + """ + Args: + dbl: Multiplier. + dv: DoseValue to multiply. + """ + ... + + + # Division of a dose value by a double. If the dose value is DoseValue.Undefined, the result will be DoseValue.Undefined. + def op_Division(self, dv: DoseValue, dbl: float) -> DoseValue: + """ + Args: + dv: Dividend. + dbl: Divisor. + """ + ... + + + # Division of two dose values. If either of the operands is DoseValue.Undefined, the result will be Double.NaN. + def op_Division(self, dv1: DoseValue, dv2: DoseValue) -> DoseValue: + """ + Args: + dv1: Dividend. + dv2: Divisor. + """ + ... + + + # Returns true if the dose unit is absolute (Gy or cGy). + def IsAbsoluteDoseUnit(self, doseUnit: DoseUnit) -> bool: + """ + Args: + doseUnit: The dose unit that is evaluated. + """ + ... + + + # Returns true if the dose unit is relative (%). + def IsRelativeDoseUnit(self, doseUnit: DoseUnit) -> bool: + """ + Args: + doseUnit: The dose unit that is evaluated. + """ + ... + + + # A string that represents the current object. + def ToString(self) -> str: + ... + + + # A dose value, for which the value is Double.NaN and the unit is unknown. + def UndefinedDose(self) -> DoseValue: + ... + + + # Returns true if this dose value is equal to DoseValue.Undefined, false otherwise. + def IsUndefined(self) -> bool: + ... + + + # This member is internal to the Eclipse Scripting API. + def GetSchema(self) -> Xml.Schema.XmlSchema: + ... + + + # This member is internal to the Eclipse Scripting API. + def ReadXml(self, reader: Xml.XmlReader) -> None: + """ + Args: + reader: XmlReader. + """ + ... + + + # Serialization support. + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream to which the object is serialized. + """ + ... + + + +class SingleLayerParameters: + """ + One layer or group of DRR calculation parameters. + + Attributes: + LayerOn (bool): Defines whether the layer of parameters are selected. + Weight (float): Weight factor of the DRR layer. Value must be between -100.0 and 100.0. + CTFrom (float): Lower end of the CT window. Value must be between -1024.0 and 6000.0. + CTTo (float): Upper end of the CT window. Value must be between -1024.0 and 6000.0. + GeoClipping (bool): Image volume type on which the DRR calculation is based. If calculation is based on partial image volume as specified by + GeoFrom (float): Starting distance from the isocenter. Value must be between -10000 and 10000 mm. + GeoTo (float): Ending distance from the isocenter. Value must be between -10000 and 10000 mm. + """ + def __init__(self) -> None: ... + + LayerOn: bool + + Weight: float + + CTFrom: float + + CTTo: float + + GeoClipping: bool + + GeoFrom: float + + GeoTo: float + + +class DRRCalculationParameters: + """ + Parameters for DRR calculation. + + Attributes: + DRRSize (float): DRR size. Decreasing the size of the DRR effectively increases the resolution of the DRR. Value must be between 5 and 5120 mm. + StructureOutlines (bool): Defines if structure outlines are added as layers in the DRR. + FieldOutlines (bool): Defines if field outlines (MLC, CIAO etc.) are added as layers in the DRR. + """ + # Creates a new set of DRR calculation parameters with default values. + @overload + def __init__(self) -> None: + ... + + + # Creates a new set of DRR calculation parameters with a specified DRR size. + @overload + def __init__(self, drrSize: float) -> None: + """ + Args: + drrSize: DRR size in mm. + """ + ... + + + # Creates a new set of DRR calculation parameters. + @overload + def __init__(self, drrSize: float, weight: float, ctFrom: float, ctTo: float) -> None: + """ + Args: + drrSize: DRR size in mm. Value must be between 5 and 5120 mm. + weight: DRR layer weight. Value must be between -100.0 and 100.0. + ctFrom: Lower end of the CT window. Value must be between -1024.0 and 6000.0. + ctTo: Upper end of the CT window. Value must be between -1024.0 and 6000.0. + """ + ... + + + # Creates a new set of DRR calculation parameters. + @overload + def __init__(self, drrSize: float, weight: float, ctFrom: float, ctTo: float, geoFrom: float, geoTo: float) -> None: + """ + Args: + drrSize: DRR size in mm. Value must be between 5 and 5120 mm. + weight: DRR layer weight. Value must be between -100.0 and 100.0. + ctFrom: Lower end of the CT window. Value must be between -1024.0 and 6000.0. + ctTo: Upper end of the CT window. Value must be between -1024.0 and 6000.0. + geoFrom: Starting distance from the isocenter. Value must be between -10000 and 10000 mm. + geoTo: Ending distance from the isocenter. Value must be between -10000 and 10000 mm. + """ + ... + + + DRRSize: float + + StructureOutlines: bool + + FieldOutlines: bool + + # Gets a single layer of editable DRR calculation parameters. + def GetLayerParameters(self, index: int) -> SingleLayerParameters: + """ + Args: + index: Layer index. Value must be between 0 and 2. + """ + ... + + + # Sets parameters for + def SetLayerParameters(self, index: int, weight: float, ctFrom: float, ctTo: float) -> None: + """ + Args: + index: Layer index. + weight: DRR layer weight. Value must be between -100.0 and 100.0. + ctFrom: Lower end of the CT window. Value must be between -1024.0 and 6000.0. + ctTo: Upper end of the CT window. Value must be between -1024.0 and 6000.0. + """ + ... + + + # Sets parameters for + def SetLayerParameters(self, index: int, weight: float, ctFrom: float, ctTo: float, geoFrom: float, geoTo: float) -> None: + """ + Args: + index: Layer index. + weight: DRR layer weight. Value must be between -100.0 and 100.0. + ctFrom: Lower end of the CT window. Value must be between -1024.0 and 6000.0. + ctTo: Upper end of the CT window. Value must be between -1024.0 and 6000.0. + geoFrom: Starting distance from the isocenter. Value must be between -10000 and 10000 mm. + geoTo: Ending distance from the isocenter. Value must be between -10000 and 10000 mm. + """ + ... + + + +class DVHPoint: + """ + Represents a value on a Dose Volume Histogram (DVH) curve. + + Attributes: + DoseValue (DoseValue): The dose value of the point. + Volume (float): The volume value of the point. + VolumeUnit (str): The volume unit of the point. + """ + # Constructs a DVHPoint. + def __init__(self, dose: DoseValue, volume: float, volumeUnit: str) -> None: + """ + Args: + dose: Dose value of the point. + volume: Volume value of the point. + volumeUnit: Unit of volume. + """ + ... + + + DoseValue: DoseValue + + Volume: float + + VolumeUnit: str + + # This member is internal to the Eclipse Scripting API. + def GetSchema(self) -> Xml.Schema.XmlSchema: + ... + + + # This member is internal to the Eclipse Scripting API. + def ReadXml(self, reader: Xml.XmlReader) -> None: + """ + Args: + reader: XmlReader. + """ + ... + + + # Serialization support. + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream to which the object is serialized. + """ + ... + + + +class ExternalBeamMachineParameters: + """ + The parameters for the external beam treatment unit. + + Attributes: + MachineId (str): The treatment unit identifier. + EnergyModeId (str): The energy mode identifier. For example, "6X", or "18X". + DoseRate (int): Dose rate value. + PrimaryFluenceModeId (str): Primary Fluence Mode identifier. Acceptable values are: null, empty string, "SRS","FFF". + TechniqueId (str): Technique identifier. Typically "STATIC" or "ARC". + MLCId (str): Optional MLC identifier. If null (which is the default) then the single MLC of the treatment unit is selected. + """ + # Assigns the parameters to the properties for external beams. + @overload + def __init__(self, doseRate: str, energyModeId: str, machineId: int, primaryFluenceModeId: str, techniqueId: str) -> None: + """ + Args: + doseRate: Dose rate value. + energyModeId: The energy mode identifier. For example, "6X", or "18X". + machineId: The treatment unit identifier. + primaryFluenceModeId: Primary Fluence Mode ID. Acceptable values are: null, empty string, "SRS","FFF". + techniqueId: Technique identifier. Typically "STATIC" or "ARC". + """ + ... + + + # Assigns the Treatment Unit ID to the properties. Rest of the properties are left empty. These parameters will work for Halcyon machine when adding imaging setup or Fixed Sequence beam. For other types of beams, define all properties. + @overload + def __init__(self, machineId: str) -> None: + """ + Args: + machineId: The treatment unit identifier. + """ + ... + + + MachineId: str + + EnergyModeId: str + + DoseRate: int + + PrimaryFluenceModeId: str + + TechniqueId: str + + MLCId: str + + +class FitToStructureMarginType: + """ + Margin type + """ + def __init__(self) -> None: ... + + +class FitToStructureMargins: + """ + Margins that are used when fitting a field device to a structure from the BEV perspective + """ + # Constructs a new FitToStructureMargins instance with elliptical margin type. + @overload + def __init__(self, x1: float, y1: float, x2: float, y2: float) -> None: + """ + Args: + x1: Margin x1 in mm + y1: Margin y1 in mm + x2: Margin x2 in mm + y2: Margin y2 in mm + """ + ... + + + # Constructs a new FitToStructureMargins instance with circular margin type. + @overload + def __init__(self, margin: float) -> None: + """ + Args: + margin: Uniform margin for all directions in mm + """ + ... + + + # A string that represents the current object. + def ToString(self) -> str: + ... + + + +class Fluence: + """ + Represents the fluence for a beam. The resolution in the fluence matrix is 2.5 mm in x and y directions. In the fluence matrix, x dimension is the number of columns, and y dimension is the number of rows. + + Attributes: + MaxSizePixel (int): The maximum size of pixels for x or y dimension in the fluence. + XSizePixel (int): The size of x dimension in pixels for the fluence. This corresponds to the number of columns in the pixels matrix. + YSizePixel (int): The size of y dimension in pixels for the fluence. This corresponds to the number of rows in the pixels matrix. + XSizeMM (float): The size of x dimension in mm for the fluence. The resolution is 2.5 mm in x and y directions. + YSizeMM (float): The size of y dimension in mm for the fluence. The resolution is 2.5 mm in x and y directions. + XOrigin (float): The x coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. + YOrigin (float): The y coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. + MLCId (str): The identifier of the MLC that is related to the fluence. The value can be empty or null. + """ + # Constructor. + @overload + def __init__(self, fluenceMatrix: Array[float], xOrigin: float, yOrigin: float) -> None: + """ + Args: + fluenceMatrix: Contains the pixel values for the fluence. x dimension is the number of columns, and y dimension is the number of rows in the matrix. The minimum number of rows and columns is 2, and the maximum is 1024. For the optimal fluence of a beam, the values in the fluence matrix are floats, 4 bytes per pixel. The pixel values are determined as follows: fluence value 1 produces a dose of 1 Gy at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Correspondingly, fluence value 2 produces 2 Gy, fluence value 3 produces 3 Gy, etc. at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Pixel values are positive. + xOrigin: The x coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. + yOrigin: The y coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. + """ + ... + + + # Constructor. + @overload + def __init__(self, fluenceMatrix: Array[float], xOrigin: float, yOrigin: float, mlcId: str) -> None: + """ + Args: + fluenceMatrix: Contains the pixel values for the fluence. x dimension is the number of columns, and y dimension is the number of rows in the matrix. The minimum number of rows and columns is 2, and the maximum is 1024. The pixel values are determined as follows: fluence value 1 produces a dose of 1 Gy at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Correspondingly, fluence value 2 produces 2 Gy, fluence value 3 produces 3 Gy, etc. at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Pixel values are positive. + xOrigin: The x coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. + yOrigin: The y coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. + mlcId: The identifier of the MLC that is related to the fluence. This parameter is optional. If the identifier is empty, the system tries to find the MLC from the treatment unit configuration. This happens when you call one of the + """ + ... + + + MaxSizePixel: int + + XSizePixel: int + + YSizePixel: int + + XSizeMM: float + + YSizeMM: float + + XOrigin: float + + YOrigin: float + + MLCId: str + + # Returns the fluence matrix. + def GetPixels(self) -> Array[float]: + ... + + + +class ImagingBeamSetupParameters: + """ + Setup parameters for imaging fields. + + Attributes: + ImagingSetup (ImagingSetup): Identifier for the imaging setup. + FitMarginX1 (float): Fit margin in x-direction in mm. + FitMarginX2 (float): Fit margin in x-direction in mm. + FitMarginY1 (float): Fit margin in y-direction in mm. + FitMarginY2 (float): Fit margin in y-direction in mm. + FieldSizeX (float): Field size in x-direction in mm. + FieldSizeY (float): Field size in y-direction in mm. + """ + # Constructor for imaging beam setup parameters. + def __init__(self, imagingSetup: ImagingSetup, fitMarginX1_mm: float, fitMarginX2_mm: float, fitMarginY1_mm: float, fitMarginY2_mm: float, fieldSizeX_mm: float, fieldSizeY_mm: float) -> None: + """ + Args: + imagingSetup: Setup technique + fitMarginX1_mm: Fit margin left side (in mm) + fitMarginX2_mm: Fit margin right side (in mm) + fitMarginY1_mm: Fit margin top (in mm) + fitMarginY2_mm: Fit margin bottom (in mm) + fieldSizeX_mm: Field size in x direction (in mm) + fieldSizeY_mm: Field size in y direction (in mm) + """ + ... + + + ImagingSetup: ImagingSetup + + FitMarginX1: float + + FitMarginX2: float + + FitMarginY1: float + + FitMarginY2: float + + FieldSizeX: float + + FieldSizeY: float + + +class ProfilePoint: + """ + Represents a point of a line profile. + + Attributes: + Position (VVector): The position of the point. + Value (float): The value of the point. + """ + # Constructs a ProfilePoint. + def __init__(self, position: VVector, value: float) -> None: + """ + Args: + position: Position of the point. + value: Value of the point. + """ + ... + + + Position: VVector + + Value: float + + +class LineProfile: + """ + Represents values along a line segment. + + Attributes: + Count (int): The number of points in the profile. + """ + # Constructs a LineProfile. + def __init__(self, origin: VVector, step: VVector, data: Array[Double]) -> None: + """ + Args: + origin: Origin, i.e. position of first point of the profile. + step: Step length and direction between points on the profile. + data: Array of values of the profile. + """ + ... + + + Count: int + + # An enumerator for the points in the profile. + def GetEnumerator(self) -> Iterable[ProfilePoint]: + ... + + + # A non-generic version of the enumerator for the points in the profile. + def GetEnumerator(self) -> Iterable[ProfilePoint]: + ... + + + +class ImageProfile: + """ + Represents an image line profile. + + Attributes: + Unit (str): The unit of the points on the image profile. + """ + # Constructs an ImageProfile. + def __init__(self, origin: VVector, step: VVector, data: Array[Double], unit: str) -> None: + """ + Args: + origin: Origin, i.e. position of first point of the profile. + step: Step length and direction between points on the profile. + data: Array of values of the profile. + unit: Unit of values in the profile. + """ + ... + + + Unit: str + + +class DoseProfile: + """ + Represents a dose profile. + + Attributes: + Unit (DoseValue+DoseUnit): The unit of the points on this dose profile. + """ + # Constructs a DoseProfile. + def __init__(self, origin: VVector, step: VVector, data: Array[Double], unit: DoseUnit) -> None: + """ + Args: + origin: Origin, i.e. position of first point of the profile. + step: Step length and direction between points on the profile. + data: Array of values of the profile. + unit: Unit of values in the profile. + """ + ... + + + Unit: DoseValue+DoseUnit + + +class LMCVOptions: + """ + Options for calculating leaf motions using the Varian Leaf Motion Calculator (LMCV) algorithm. + + Attributes: + FixedJaws (bool): Use the Fixed jaws option. + """ + # Constructor. + def __init__(self, fixedJaws: bool) -> None: + """ + Args: + fixedJaws: Use the Fixed jaws option. + """ + ... + + + FixedJaws: bool + + +class SmartLMCOptions: + """ + Options for calculating leaf motions using the Varian Smart LMC algorithm. + + Attributes: + FixedFieldBorders (bool): Use the Fixed field borders option. See details in Eclipse Photon and Electron Algorithms Reference Guide. + JawTracking (bool): Use the Jaw tracking option. See details in Eclipse Photon and Electron Algorithms Reference Guide. + """ + # Constructor. + def __init__(self, fixedFieldBorders: bool, jawTracking: bool) -> None: + """ + Args: + fixedFieldBorders: Use the Fixed field borders option. See details in Eclipse Photon and Electron Algorithms Reference Guide. + jawTracking: Use the Jaw tracking option. See details in Eclipse Photon and Electron Algorithms Reference Guide. + """ + ... + + + FixedFieldBorders: bool + + JawTracking: bool + + +class LMCMSSOptions: + """ + Options for calculating leaf motions using the non-Varian MSS Leaf Motion Calculator (LMCMSS) algorithm. + + Attributes: + NumberOfIterations (int): The number of calculation iterations. + """ + # Constructor. + def __init__(self, numberOfIterations: int) -> None: + """ + Args: + numberOfIterations: The number of calculation iterations. + """ + ... + + + NumberOfIterations: int + + +class DosimeterUnit: + """ + The dosimeter unit. + """ + def __init__(self) -> None: ... + + +class MetersetValue: + """ + Represents a meterset value. + + Attributes: + Value (float): The value of this instance. + Unit (DosimeterUnit): The unit of this instance. + """ + # Constructs a MetersetValue. + def __init__(self, value: float, unit: DosimeterUnit) -> None: + """ + Args: + value: Value for this instance. + unit: Unit for this instance. + """ + ... + + + Value: float + + Unit: DosimeterUnit + + # This member is internal to the Eclipse Scripting API. + def GetSchema(self) -> Xml.Schema.XmlSchema: + ... + + + # This member is internal to the Eclipse Scripting API. + def ReadXml(self, reader: Xml.XmlReader) -> None: + """ + Args: + reader: XmlReader. + """ + ... + + + # Serialization support. + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream to which the object is serialized. + """ + ... + + + +class OptimizationAvoidanceSector: + """ + Avoidance sector details. + + Attributes: + StartAngle (float): Start angle. + StopAngle (float): Stop angle. + Valid (bool): Is Avoidance Sector valid. + ValidationError (str): Validation error. + IsDefined (bool): Is Avoidance Sector defined. True if either startAngle or stopAngle is defined. + """ + # OptimizationAvoidanceSector constructor. + @overload + def __init__(self, startAngle: float, stopAngle: float) -> None: + ... + + + # OptimizationAvoidanceSector constructor. + @overload + def __init__(self, startAngle: float, stopAngle: float, isValid: bool, validationError: str) -> None: + ... + + + StartAngle: float + + StopAngle: float + + Valid: bool + + ValidationError: str + + IsDefined: bool + + +class OptimizationOptionsBase: + """ + Abstract base class for IMRT and VMAT optimization options. + + Attributes: + MLC (str): Identifier for the Multileaf Collimator (MLC). This can be left empty if there is exactly one MLC configured. + StartOption (OptimizationOption): The state at the beginning of the optimization. + IntermediateDoseOption (OptimizationIntermediateDoseOption): Use of intermediate dose in optimization. + """ + def __init__(self) -> None: ... + + MLC: str + + StartOption: OptimizationOption + + IntermediateDoseOption: OptimizationIntermediateDoseOption + + +class OptimizationOptionsIMPT: + """ + Options for IMPT optimization. + + Attributes: + MaximumNumberOfIterations (int): Maximum number of iterations for the IMPT optimizer. + """ + # Specify the initial state at the beginning of optimization. The calculation terminates upon convergence before the maximum number of iterations is reached or the maximum time has elapsed. + def __init__(self, maxIterations: int, initialState: OptimizationOption) -> None: + """ + Args: + maxIterations: Maximum number of iterations for IMRT optimization. + initialState: Initial state at the beginning of optimization. + """ + ... + + + MaximumNumberOfIterations: int + + +class OptimizationOptionsIMRT: + """ + Options for IMRT optimization. + + Attributes: + ConvergenceOption (OptimizationConvergenceOption): Terminate the optimization early if it is converged. + NumberOfStepsBeforeIntermediateDose (int): Number of steps before the intermediate dose is calculated. + MaximumNumberOfIterations (int): Maximum number of iterations for the IMRT optimizer. + """ + # Specify the initial state at the beginning of optimization and use intermediate dose after a specified number of iterations. The user specifies if the calculation terminates upon convergence before the maximum number of iterations is reached. If the intermediate dose is selected, the intermediate dose is calculated at least once. The subsequent cycles may be terminated early if the iteration has been converged. + @overload + def __init__(self, maxIterations: int, initialState: OptimizationOption, numberOfStepsBeforeIntermediateDose: int, convergenceOption: OptimizationConvergenceOption, mlcId: str) -> None: + """ + Args: + maxIterations: Maximum number of iterations for IMRT optimization. + initialState: Initial state at the beginning of optimization. + numberOfStepsBeforeIntermediateDose: Number of steps before the intermediate dose is calculated. + convergenceOption: Option to terminate optimization early if the iteration is converged. + mlcId: Identifier for the Multileaf Collimator (MLC). + """ + ... + + + # Specify the initial state at the beginning of optimization and use intermediate dose after a specified number of iterations. The user specifies if the calculation terminates upon convergence before the maximum number of iterations is reached. If the intermediate dose is selected, the intermediate dose is calculated once after which the optimization is restarted. This option is the same as the "Automatic Intermediate Dose" option in External Beam Planning. + @overload + def __init__(self, maxIterations: int, initialState: OptimizationOption, convergenceOption: OptimizationConvergenceOption, intermediateDoseOption: OptimizationIntermediateDoseOption, mlcId: str) -> None: + """ + Args: + maxIterations: Maximum number of iterations for IMRT optimization. + initialState: Initial state at the beginning of optimization. + convergenceOption: Option to terminate optimization early if the iteration is converged. + intermediateDoseOption: Specify if intermediate dose is calculated. + mlcId: Identifier for the Multileaf Collimator (MLC). + """ + ... + + + # Specify the initial state before optimization and whether the algorithm can terminate early if the iteration has already been converged. No intermediate dose is used in the optimization. + @overload + def __init__(self, maxIterations: int, initialState: OptimizationOption, convergenceOption: OptimizationConvergenceOption, mlcId: str) -> None: + """ + Args: + maxIterations: Maximum number of iterations for IMRT optimization. + initialState: Initial state at the beginning of optimization. + convergenceOption: Option to terminate optimization early if the iteration is converged. + mlcId: Identifier for the Multileaf Collimator (MLC). + """ + ... + + + ConvergenceOption: OptimizationConvergenceOption + + NumberOfStepsBeforeIntermediateDose: int + + MaximumNumberOfIterations: int + + +class OptimizationOptionsVMAT: + """ + Options for VMAT optimization. + + Attributes: + NumberOfOptimizationCycles (int): Number of VMAT optimization cycles. + """ + # Perform VMAT optimization using a specific starting condition. + @overload + def __init__(self, startOption: OptimizationOption, mlcId: str) -> None: + """ + Args: + startOption: Initial state for the optimizer. + mlcId: Identifier for the Multileaf Collimator (MLC). + """ + ... + + + # Perform a single cycle of VMAT optimization. Intermediate dose is optionally calculated after multi-resolution level 3. + @overload + def __init__(self, intermediateDoseOption: OptimizationIntermediateDoseOption, mlcId: str) -> None: + """ + Args: + intermediateDoseOption: Intermediate dose option. + mlcId: Identifier for the Multileaf Collimator (MLC). + """ + ... + + + # Perform a user-specified number of VMAT optimization cycles. During the first round, the intermediate dose is calculated after multi-resolution level 3, and the optimization re-starts at multi-resolution level 4. The subsequent rounds calculate first the intermediate dose and start the optimization from multi-resolution level 4. + @overload + def __init__(self, numberOfCycles: int, mlcId: str) -> None: + """ + Args: + numberOfCycles: Number of VMAT optimization cycles. + mlcId: Identifier for the Multileaf Collimator (MLC). + """ + ... + + + # For the internal use of the Eclipse Scripting API. + @overload + def __init__(self, startOption: OptimizationOption, mlcId: OptimizationIntermediateDoseOption, param3: int, param4: str) -> None: + ... + + + # Copy Constructor. + @overload + def __init__(self, options: OptimizationOptionsVMAT) -> None: + """ + Args: + options: An options object that is copied. + """ + ... + + + NumberOfOptimizationCycles: int + + +class PlanValidationResult: + """ + Represents plan validatation result + + Attributes: + InfoCount (int): The info count of this instance. + WarningCount (int): The warning count of this instance. + ErrorCount (int): The error count of this instance. + Details (Collections.Generic.ICollection[PlanValidationResultDetail]): The validation details of this instance. + StringPresentation (str): String representation of this instance. + """ + # Constructs empty PlanValidationResult. + @overload + def __init__(self) -> None: + ... + + + # Constructs a PlanValidationResult. + @overload + def __init__(self, details: Collections.Generic.ICollection[PlanValidationResultDetail]) -> None: + """ + Args: + details: Collection of validation details. + """ + ... + + + InfoCount: int + + WarningCount: int + + ErrorCount: int + + Details: Collections.Generic.ICollection[PlanValidationResultDetail] + + StringPresentation: str + + # Add validation detail to this instance. + def Add(self, detail: PlanValidationResultDetail) -> None: + """ + Args: + detail: New validation detail. + """ + ... + + + # Add validation component to this instance. + def Add(self, componentResult: PlanValidationResult) -> None: + """ + Args: + componentResult: Plan validation result component. + """ + ... + + + +class PlanValidationResultDetail: + """ + Represents plan validation detail. + + Attributes: + Plan (str): Identifies the plan of this instance. + MessageForUser (str): Localized message for user of this instance. + Classification (PlanValidationResultDetail+ResultClassification): Result classification of this instance. + Code (str): Unique validation detail code of this instance. + StringPresentation (str): String representation of this instance. + """ + # Constructs PlanValidationDetail. + def __init__(self, plan: str, messageForUser: str, classification: ResultClassification, code: str) -> None: + """ + Args: + plan: Identifies plan. + messageForUser: Localized message for user. + classification: Class of validation detail. + code: Unique validation detail code. + """ + ... + + + Plan: str + + MessageForUser: str + + Classification: PlanValidationResultDetail+ResultClassification + + Code: str + + StringPresentation: str + + # Result classification (static). + def GetClassification(self, detail: PlanValidationResultDetail) -> PlanValidationResultDetail+ResultClassification: + ... + + + +class PlanValidationResultEsapiDetail: + """ + A class for detailed plan validation result + + Attributes: + MessageForUser (str): Message for the user about the validation result detail. + Code (str): Detail code. + IsError (bool): Check if the result is a error (true) or a warning (false). + """ + # Constructor for PlanValidationResultEsapiDetail class. + def __init__(self, messageForUser: str, isError: bool, code: str) -> None: + """ + Args: + messageForUser: Message for the user. + isError: Is this reported as a error or as a warning. + code: Result code. + """ + ... + + + MessageForUser: str + + Code: str + + IsError: bool + + +class ProtonBeamMachineParameters: + """ + The parameters for the proton beam treatment unit. + + Attributes: + MachineId (str): The treatment unit identifier. + TechniqueId (str): Technique identifier. For example, "MODULAT_SCANNING", or "UNIFORM_SCANNING". + ToleranceId (str): Tolerance identifier. + """ + # Assigns the parameters to the properties for proton beams. + def __init__(self, machineId: str, techniqueId: str, toleranceId: str) -> None: + """ + Args: + machineId: The treatment unit identifier. + techniqueId: Technique identifier. "MODULAT_SCANNING" or "UNIFORM_SCANNING" for proton beams. + toleranceId: Tolerance identifier. + """ + ... + + + MachineId: str + + TechniqueId: str + + ToleranceId: str + + +class IonPlanNormalizationParameters: + """ + The parameters for proton plan normalization. + + Attributes: + NormalizationMode (PlanNormalizationMode): Normalization mode. + NormalizationValue (float): The treatment unit identifier. + VolumePercentage (float): Volume percentage factor. + """ + # Plan normalization parameters for user-defined target volume percentage and plan normalization value. For more information refer to the plan normalization options in the Eclipse Proton Reference Guide. + @overload + def __init__(self, normalizationMode: PlanNormalizationMode, normalizationValue: float, volumePercentage: float) -> None: + ... + + + # Plan normalization parameters user-defined plan normalization value. For more information refer to the plan normalization options in the Eclipse Proton Reference Guide. + @overload + def __init__(self, normalizationMode: PlanNormalizationMode, normalizationValue: float) -> None: + ... + + + # Plan normalization parameters for normalizing the maximum, mean, minimum dose of the target volume to 100%, or to no normalization. For more information refer to the plan normalization options in the Eclipse Proton Reference Guide. + @overload + def __init__(self, normalizationMode: PlanNormalizationMode) -> None: + ... + + + NormalizationMode: PlanNormalizationMode + + NormalizationValue: float + + VolumePercentage: float + + +class RailPosition: + """ + Setting for the moveable rail position (in or out) used for couch modeling in Eclipse. + """ + def __init__(self) -> None: ... + + +class SegmentProfilePoint: + """ + Represents a point of a segment profile. + + Attributes: + Position (VVector): The position of the point. + Value (bool): The value of the point: true if the point is inside the segment, false otherwise. + """ + # Constructs a SegmentProfilePoint. + def __init__(self, position: VVector, value: bool) -> None: + """ + Args: + position: Position of the point. + value: Value of the point. + """ + ... + + + Position: VVector + + Value: bool + + +class SegmentProfile: + """ + Represents the segment values along a line segment. + + Attributes: + Count (int): The number of points in the profile. + EdgeCoordinates (List[VVector]): Returns the coordinates of the edges of the segment along the segment profile. + """ + # Constructs a SegmentProfile. + def __init__(self, origin: VVector, step: VVector, data: Collections.BitArray) -> None: + """ + Args: + origin: Origin, i.e. position of first point of the profile. + step: Step length and direction between points on the profile. + data: Array of values of the profile. + """ + ... + + + Count: int + + EdgeCoordinates: List[VVector] + + # An enumerator for points in the profile. + def GetEnumerator(self) -> Iterable[SegmentProfilePoint]: + ... + + + # A non-generic version of the enumerator for points in the profile. + def GetEnumerator(self) -> Iterable[SegmentProfilePoint]: + ... + + + +class LogSeverity: + """ + The enumeration of log severities. + """ + def __init__(self) -> None: ... + + +class PlanType: + """ + The enumeration of plan types. + """ + def __init__(self) -> None: ... + + +class MLCPlanType: + """ + The enumeration of Multileaf Collimator (MLC) techniques. + """ + def __init__(self) -> None: ... + + +class PlanSetupApprovalStatus: + """ + The enumeration of plan approval statuses. + """ + def __init__(self) -> None: ... + + +class StructureApprovalStatus: + """ + The enumeration of structure approval statuses. + """ + def __init__(self) -> None: ... + + +class ProtonDeliveryTimeStatus: + """ + The enumeration of proton delivery time statuses. + """ + def __init__(self) -> None: ... + + +class ImageApprovalStatus: + """ + The enumeration of image approval statuses. + """ + def __init__(self) -> None: ... + + +class PlanSumOperation: + """ + PlanSum operation for PlanSetups in PlanSum. Indicates whether the plan is summed with (“+”) or subtracted from (“-”) the other plans in the sum. + """ + def __init__(self) -> None: ... + + +class DoseValuePresentation: + """ + Types of presentation for dose values. + """ + def __init__(self) -> None: ... + + +class VolumePresentation: + """ + Types of presentation for volume values. + """ + def __init__(self) -> None: ... + + +class PatientOrientation: + """ + The enumeration of patient orientations. + """ + def __init__(self) -> None: ... + + +class SeriesModality: + """ + The enumeration of series modalities. + """ + def __init__(self) -> None: ... + + +class BeamTechnique: + """ + An enumeration of beam techniques. + """ + def __init__(self) -> None: ... + + +class SetupTechnique: + """ + The enumeration of setup techniques for a beam. + """ + def __init__(self) -> None: ... + + +class GantryDirection: + """ + The enumeration of gantry rotation directions. + """ + def __init__(self) -> None: ... + + +class ImagingSetup: + """ + Set of available imaging setups. + """ + def __init__(self) -> None: ... + + +class BlockType: + """ + A type flag that tells whether a block is an aperture block or a shielding block. An aperture block is used to limit the radiated area while a shielding block is made to protect a sensitive organ. + """ + def __init__(self) -> None: ... + + +class CalculationType: + """ + Calculation type. + """ + def __init__(self) -> None: ... + + +class OptimizationObjectiveOperator: + """ + Optimization Objective Operator, which is used for setting the upper and lower optimization objectives. + """ + def __init__(self) -> None: ... + + +class OptimizationOption: + """ + Options for Optimization. + """ + def __init__(self) -> None: ... + + +class OptimizationIntermediateDoseOption: + """ + Options for using intermediate dose in optimization. + """ + def __init__(self) -> None: ... + + +class OptimizationConvergenceOption: + """ + Options for terminating optimization upon convergence. + """ + def __init__(self) -> None: ... + + +class DVHEstimateType: + """ + Represents the type of a DVH estimate curve + """ + def __init__(self) -> None: ... + + +class PlanUncertaintyType: + """ + Plan uncertainty type indicates the usage of associated uncertainty parameters, see + """ + def __init__(self) -> None: ... + + +class IonBeamScanMode: + """ + The method of beam scanning to be used during treatment. Used with IonBeams. + """ + def __init__(self) -> None: ... + + +class RangeShifterType: + """ + Type of the range shifter. + """ + def __init__(self) -> None: ... + + +class LateralSpreadingDeviceType: + """ + Type of the lateral spreading device. + """ + def __init__(self) -> None: ... + + +class PlanNormalizationMode: + """ + Plan normalization options for SetPlanNormalization + """ + def __init__(self) -> None: ... + + +class IonPlanOptimizationMode: + """ + Proton plan optimization mode. + """ + def __init__(self) -> None: ... + + +class RangeModulatorType: + """ + Type of the range modulator. + """ + def __init__(self) -> None: ... + + +class PatientSupportType: + """ + Patient support type. + """ + def __init__(self) -> None: ... + + +class ApplicationScriptType: + """ + The type of the application script. + """ + def __init__(self) -> None: ... + + +class ApplicationScriptApprovalStatus: + """ + The approval statuses of the application script. + """ + def __init__(self) -> None: ... + + +class RTPrescriptionTargetType: + """ + The type of the prescription target definition + """ + def __init__(self) -> None: ... + + +class RTPrescriptionConstraintType: + """ + Type of the RT prescription constraint. + """ + def __init__(self) -> None: ... + + +class PrescriptionType: + """ + Enumeration of prescription types. + """ + def __init__(self) -> None: ... + + +class PrescriptionModifier: + """ + Prescription modifier. + """ + def __init__(self) -> None: ... + + +class MeasureType: + """ + Enumeration of plan measure types. + """ + def __init__(self) -> None: ... + + +class MeasureModifier: + """ + Measure modifier + """ + def __init__(self) -> None: ... + + +class RegistrationApprovalStatus: + """ + The enumeration of registration approval statuses. + """ + def __init__(self) -> None: ... + + +class ApprovalHistoryEntry: + """ + An entry in the plan approval history. + """ + def __init__(self) -> None: ... + + +class StructureApprovalHistoryEntry: + """ + An entry in the structure approval history. + """ + def __init__(self) -> None: ... + + +class ImageApprovalHistoryEntry: + """ + An entry in the image approval history. + """ + def __init__(self) -> None: ... + + +class OpenLeavesMeetingPoint: + """ + Specifies where the open MLC leaves meet the structure outline in an MLC leaf fit operation. + """ + def __init__(self) -> None: ... + + +class ClosedLeavesMeetingPoint: + """ + Specifies where the closed MLC leaf pairs are parked in an MLC leaf fit operation. Bank_One: Varian = B, IEC MLCX = X1, IEC MLCY = Y1; Bank_Two: Varian = A, IEC MLCX = X2, IEC MLCY = Y2 + """ + def __init__(self) -> None: ... + + +class JawFitting: + """ + Specifies where collimator jaws are positioned in an MLC leaf fit operation. + """ + def __init__(self) -> None: ... + + +class RendererStrings: + """ + """ + def __init__(self) -> None: ... + + +class TreatmentSessionStatus: + """ + Status of the treatment session. + """ + def __init__(self) -> None: ... + + +class GoalPriority: + """ + Clinical Goal Priority + """ + def __init__(self) -> None: ... + + +class GoalEvalResult: + """ + Clinical Goal Evaluation Result + """ + def __init__(self) -> None: ... + + +class DVHEstimationStructureType: + """ + Structure type as defined in Planning Model Library: PTV or OAR + """ + def __init__(self) -> None: ... + + +class ParticleType: + """ + Particle types + """ + def __init__(self) -> None: ... + + +class ProtonBeamLineStatus: + """ + Status of proton beam line + """ + def __init__(self) -> None: ... + + +class CourseClinicalStatus: + """ + Clinical Status of Course + """ + def __init__(self) -> None: ... + + +class ResetSourcePositionsResult: + """ + Return value for + """ + def __init__(self) -> None: ... + + +class SetSourcePositionsResult: + """ + Return value for + """ + def __init__(self) -> None: ... + + +class BrachyTreatmentTechniqueType: + """ + The enumeration of Brachytherapy treatment techniques. + """ + def __init__(self) -> None: ... + + +class StructureCodeInfo: + """ + Represents structure code information. + + Attributes: + CodingScheme (str): The coding scheme of the structure code. + Code (str): The structure code as defined in the associated coding scheme. + """ + # Constructs a StructureCodeInfo. + def __init__(self, codingScheme: str, code: str) -> None: + """ + Args: + codingScheme: The coding scheme of the structure code. + code: The structure code as defined in the associated coding scheme. + """ + ... + + + CodingScheme: str + + Code: str + + # A string that represents the current object. + def ToString(self) -> str: + ... + + + # Checks if this object is equal to another object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: The other object to compare. + """ + ... + + + # Returns the hash code for this instance. Overrides Object.GetHashCode. + def GetHashCode(self) -> int: + ... + + + # Equality operator for StructureCodeInfo. + def op_Equality(self, left: StructureCodeInfo, right: StructureCodeInfo) -> bool: + """ + Args: + left: The first object to compare. + right: The second object to compare. + """ + ... + + + # Inequality operator for StructureCodeInfo. + def op_Inequality(self, left: StructureCodeInfo, right: StructureCodeInfo) -> bool: + """ + Args: + left: The first object to compare. + right: The second object to compare. + """ + ... + + + # Indicates whether the current object is equal to another object of the same type. + def Equals(self, other: StructureCodeInfo) -> bool: + """ + Args: + other: An object to compare with this object. + """ + ... + + + # This member is internal to the Eclipse Scripting API. + def GetSchema(self) -> Xml.Schema.XmlSchema: + ... + + + # This member is internal to the Eclipse Scripting API. + def ReadXml(self, reader: Xml.XmlReader) -> None: + """ + Args: + reader: The XmlReader stream from which the object is deserialized. + """ + ... + + + # Serialization support. + def WriteXml(self, writer: Xml.XmlWriter) -> None: + """ + Args: + writer: The System.Xml.XmlWriter stream to which the object is serialized. + """ + ... + + + +class UserIdentity: + """ + Represents the identity of an user, including the identifier (username) and the display name. + """ + # Creates a new UserIdentity value. + def __init__(self, id: str, displayName: str) -> None: + """ + Args: + id: The user identifier including the domain name, such as 'domain\user'. + displayName: The display name of the user. + """ + ... + + + +class ValidationException: + """ + ValidationException. + """ + # Exception thrown when data validation fails. + def __init__(self, reason: str) -> None: + """ + Args: + reason: A message that describes the failure. + """ + ... + + + +class VRect[T](Generic[T]): + """ + Represents a rectangle. + + Attributes: + X1 (T): The X1-coordinate of the rectangle. + Y1 (T): The Y1-coordinate of the rectangle. + X2 (T): The X2-coordinate of the rectangle. + Y2 (T): The Y2-coordinate of the rectangle. + + Note: + Currently limited to value types. + """ + # Constructs a VRect. + def __init__(self, x1: T, y1: T, x2: T, y2: T) -> None: + """ + Args: + x1: X1 coordinate of the rectangle. + y1: Y1 coordinate of the rectangle. + x2: X2 coordinate of the rectangle. + y2: Y2 coordinate of the rectangle. + """ + ... + + + X1: T + + Y1: T + + X2: T + + Y2: T + + # A string that represents the current object. + def ToString(self) -> str: + ... + + + # Checks if this object is equal to another object. + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: The other object to compare. + """ + ... + + + # Checks if this object is equal to another VRect object. + def Equals(self, other: VRect[T]) -> bool: + """ + Args: + other: The other object to compare. + """ + ... + + + # Equality operator for VRect. + def op_Equality(self, a: VRect[T], b: VRect[T]) -> bool: + """ + Args: + a: The first object to compare. + b: The second object to compare. + """ + ... + + + # Inequality operator for VRect. + def op_Inequality(self, a: VRect[T], b: VRect[T]) -> bool: + """ + Args: + a: The first object to compare. + b: The second object to compare. + """ + ... + + + # Returns the hash code for this instance. Overrides Object.GetHashCode. + def GetHashCode(self) -> int: + ... + + + +class VVector: + """ + Represents a displacement in 3D space. + + Attributes: + LengthSquared (float): The square of the length of the VVector. + Length (float): The length of the VVector. + x (float): The X component of the VVector. + y (float): The Y component of the VVector. + z (float): The Z component of the VVector. + """ + # Constructs a VVector. + def __init__(self, xi: float, yi: float, zi: float) -> None: + """ + Args: + xi: X component. + yi: Y component. + zi: Z component. + """ + ... + + + LengthSquared: float + + Length: float + + x: float + + y: float + + z: float + + # Updating VVector component value using VectorComponent indexing. + def Update(self, vc: Component, value: float) -> VVector: + """ + Args: + vc: Component enum that correspond to x,y and z components. + value: Value of 0,1 or 2 that correspond to x,y and z components. + """ + ... + + + # The distance between the locations represented by the given VVectors. + def Distance(self, left: VVector, right: VVector) -> float: + """ + Args: + left: First operand. + right: Second operand + """ + ... + + + # Scales this VVector so that its length becomes equal to unity. + def ScaleToUnitLength(self) -> None: + ... + + + # Scales this VVector so that its length becomes equal to unity. + def GetUnitLengthScaledVector(self) -> VVector: + ... + + + # The scalar product of this VVector and the given VVector. + def ScalarProduct(self, left: VVector) -> float: + """ + Args: + left: VVector that is second operand of the scalar product. + """ + ... + + + # The subtraction of VVectors. + def op_Subtraction(self, left: VVector, right: VVector) -> VVector: + """ + Args: + left: First operand. + right: Second operand. + """ + ... + + + # The addition of VVectors. + def op_Addition(self, left: VVector, right: VVector) -> VVector: + """ + Args: + left: First operand. + right: Second operand. + """ + ... + + + # The multiplication of a VVector and a double. + def op_Multiply(self, val: VVector, mul: float) -> VVector: + """ + Args: + val: VVector to multiply. + mul: Multiplier. + """ + ... + + + # The multiplication of a VVector and a double. + def op_Multiply(self, val: float, mul: VVector) -> VVector: + """ + Args: + val: VVector to multiply. + mul: Multiplier. + """ + ... + + + # The division of a VVector by a double. + def op_Division(self, val: VVector, div: float) -> VVector: + """ + Args: + val: VVector to divide. + div: Divisor. + """ + ... + + + # Equality comparison of VVector and Object. This method considers two instances of VVector.Undefined to be equal to each other. Otherwise, a vector is equal to an object only if the object is a VVector and vectors are equal. For epsilon-equal comparison, use + def Equals(self, obj: Any) -> bool: + """ + Args: + obj: Object to compare this to. + """ + ... + + + # Equality comparison of vectors. This method considers two instances of VVector.Undefined to be equal to each other. Otherwise, two vectors are equal only if the vectors components are equal. a == b, b == c, => a has to be equal to c. Epsilon equality comparison does not fulfill this condition with epsilon > 0.0. For epsilon-equal comparison, use + def Equals(self, other: VVector) -> bool: + """ + Args: + other: vector to compare this to. + """ + ... + + + # Epsilon-equality comparison of vectors. This method considers two instances of VVector.Undefined to be equal to each other. Otherwise, two vectors are equal only if the vectors components are within epsilon. + def EpsilonEqual(self, other: VVector, epsilon: float) -> bool: + """ + Args: + other: Vector to compare this to. + epsilon: Epsilon to use for the vector component comparison. + """ + ... + + + # Returns true if at least one of this vector components are equal to double.IsNaN or double.IsInfinity, false otherwise. + def IsUndefined(self) -> bool: + ... + + + # A hash code for the current object. + def GetHashCode(self) -> int: + ... + + + # Equality operator for vectors. This method considers two instances of VVector.Undefined to be equal to each other. Otherwise, two vectors are equal only if the vectors components are equal. For epsilon-equal comparison, use + def op_Equality(self, vv1: VVector, vv2: VVector) -> bool: + """ + Args: + vv1: First operand. + vv2: Second operand. + """ + ... + + + # Inequality operator for vectors. This method considers two instances of VVector.Undefined to be equal to each other. This operator considers two instances of vectors with undefined components to be inequal. For epsilon-equal comparison, use + def op_Inequality(self, vv1: VVector, vv2: VVector) -> bool: + """ + Args: + vv1: First operand. + vv2: Second operand. + """ + ... + + + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/Types/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/Types/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/VVector.pyi b/pyesapi/VMS/TPS/Common/Model/Types/VVector/VVector.pyi new file mode 100644 index 0000000..7c0b479 --- /dev/null +++ b/pyesapi/VMS/TPS/Common/Model/Types/VVector/VVector.pyi @@ -0,0 +1,18 @@ +""" +Type stubs for VMS.TPS.Common.Model.Types.VVector +Generated from .NET XML documentation +""" + +from typing import Any, List, Optional, Union, Dict, Iterable +from datetime import datetime +from System import Array, Double, Single, Int32, Boolean, String +from System.Collections.Generic import KeyValuePair +from System import Collections + +class Component: + """ + VVector component indexing. + """ + def __init__(self) -> None: ... + + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/VVector/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/Types/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/Types/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/Model/__init__.pyi b/pyesapi/VMS/TPS/Common/Model/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Common/__init__.pyi b/pyesapi/VMS/TPS/Common/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/Version/Version.pyi b/pyesapi/VMS/TPS/Version/Version.pyi new file mode 100644 index 0000000..9e512b4 --- /dev/null +++ b/pyesapi/VMS/TPS/Version/Version.pyi @@ -0,0 +1,29 @@ +""" +Type stubs for VMS.TPS.Version +Generated from .NET XML documentation +""" + +from typing import Any, List, Optional, Union, Dict, Iterable +from datetime import datetime +from System import Array, Double, Single, Int32, Boolean, String +from System.Collections.Generic import KeyValuePair +from System import Collections + +class VersionInfo: + """ + This class is a set of constants that specify build version information. Generated automatically from TpsNetVersion.in - do not edit by hand. The logic is copied from the VFC equivalents in TpsVersion.in. Names and identifiers are kept exactly the same as in the original VFC version to help in maintenance. + """ + def __init__(self) -> None: ... + +class VersionInfo: + """ + This class is a set of constants that specify build version information. Generated automatically from TpsNetVersion.in - do not edit by hand. The logic is copied from the VFC equivalents in TpsVersion.in. Names and identifiers are kept exactly the same as in the original VFC version to help in maintenance. + """ + def __init__(self) -> None: ... + +class VersionInfo: + """ + This class is a set of constants that specify build version information. Generated automatically from TpsNetVersion.in - do not edit by hand. The logic is copied from the VFC equivalents in TpsVersion.in. Names and identifiers are kept exactly the same as in the original VFC version to help in maintenance. + """ + def __init__(self) -> None: ... + diff --git a/pyesapi/VMS/TPS/Version/__init__.pyi b/pyesapi/VMS/TPS/Version/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/TPS/__init__.pyi b/pyesapi/VMS/TPS/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/__init__.pyi b/pyesapi/VMS/__init__.pyi new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/VMS/py.typed b/pyesapi/VMS/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/stubs/Microsoft/CSharp.py b/pyesapi/stubs/Microsoft/CSharp.py deleted file mode 100644 index 0811681..0000000 --- a/pyesapi/stubs/Microsoft/CSharp.py +++ /dev/null @@ -1,142 +0,0 @@ -# encoding: utf-8 -# module Microsoft.CSharp calls itself CSharp -# from System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class CSharpCodeProvider(CodeDomProvider, IComponent, IDisposable): - """ - Provides access to instances of the C# code generator and code compiler. - - CSharpCodeProvider() - CSharpCodeProvider(providerOptions: IDictionary[str, str]) - """ - def CreateCompiler(self): - # type: (self: CSharpCodeProvider) -> ICodeCompiler - """ - CreateCompiler(self: CSharpCodeProvider) -> ICodeCompiler - - Gets an instance of the C# code compiler. - Returns: An instance of the C# System.CodeDom.Compiler.ICodeCompiler implementation. - """ - pass - - def CreateGenerator(self, *__args): - # type: (self: CSharpCodeProvider) -> ICodeGenerator - """ - CreateGenerator(self: CSharpCodeProvider) -> ICodeGenerator - - Gets an instance of the C# code generator. - Returns: An instance of the C# System.CodeDom.Compiler.ICodeGenerator implementation. - """ - pass - - def Dispose(self): - # type: (self: Component, disposing: bool) - """ - Dispose(self: Component, disposing: bool) - Releases the unmanaged resources used by the System.ComponentModel.Component and optionally releases the managed resources. - - disposing: true to release both managed and unmanaged resources; false to release only unmanaged resources. - """ - pass - - def GenerateCodeFromMember(self, member, writer, options): - # type: (self: CSharpCodeProvider, member: CodeTypeMember, writer: TextWriter, options: CodeGeneratorOptions) - """ - GenerateCodeFromMember(self: CSharpCodeProvider, member: CodeTypeMember, writer: TextWriter, options: CodeGeneratorOptions) - Generates code for the specified class member using the specified text writer and code generator options. - - member: A System.CodeDom.CodeTypeMember to generate code for. - writer: The System.IO.TextWriter to write to. - options: The System.CodeDom.Compiler.CodeGeneratorOptions to use when generating the code. - """ - pass - - def GetConverter(self, type): - # type: (self: CSharpCodeProvider, type: Type) -> TypeConverter - """ - GetConverter(self: CSharpCodeProvider, type: Type) -> TypeConverter - - Gets a System.ComponentModel.TypeConverter for the specified type of object. - - type: The type of object to retrieve a type converter for. - Returns: A System.ComponentModel.TypeConverter for the specified type. - """ - pass - - def GetService(self, *args): #cannot find CLR method - # type: (self: Component, service: Type) -> object - """ - GetService(self: Component, service: Type) -> object - - Returns an object that represents a service provided by the System.ComponentModel.Component or by its System.ComponentModel.Container. - - service: A service provided by the System.ComponentModel.Component. - Returns: An System.Object that represents a service provided by the System.ComponentModel.Component, or null if the System.ComponentModel.Component does not provide the specified service. - """ - pass - - def MemberwiseClone(self, *args): #cannot find CLR method - # type: (self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - """ - MemberwiseClone(self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - - Creates a shallow copy of the current System.MarshalByRefObject object. - - cloneIdentity: false to delete the current System.MarshalByRefObject object's identity, which will cause the object to be assigned a new identity when it is marshaled across a remoting boundary. A value of false is usually appropriate. true to copy the current - System.MarshalByRefObject object's identity to its clone, which will cause remoting client calls to be routed to the remote server object. - - Returns: A shallow copy of the current System.MarshalByRefObject object. - MemberwiseClone(self: object) -> object - - Creates a shallow copy of the current System.Object. - Returns: A shallow copy of the current System.Object. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, providerOptions=None): - """ - __new__(cls: type) - __new__(cls: type, providerOptions: IDictionary[str, str]) - """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CanRaiseEvents = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a value indicating whether the component can raise an event. """ - - DesignMode = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a value that indicates whether the System.ComponentModel.Component is currently in design mode. """ - - Events = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the list of event handlers that are attached to this System.ComponentModel.Component. """ - - FileExtension = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the file name extension to use when creating source code files. - - Get: FileExtension(self: CSharpCodeProvider) -> str - """ - - - diff --git a/pyesapi/stubs/Microsoft/VisualBasic.py b/pyesapi/stubs/Microsoft/VisualBasic.py deleted file mode 100644 index 02898b0..0000000 --- a/pyesapi/stubs/Microsoft/VisualBasic.py +++ /dev/null @@ -1,149 +0,0 @@ -# encoding: utf-8 -# module Microsoft.VisualBasic calls itself VisualBasic -# from System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class VBCodeProvider(CodeDomProvider, IComponent, IDisposable): - """ - Provides access to instances of the Visual Basic code generator and code compiler. - - VBCodeProvider() - VBCodeProvider(providerOptions: IDictionary[str, str]) - """ - def CreateCompiler(self): - # type: (self: VBCodeProvider) -> ICodeCompiler - """ - CreateCompiler(self: VBCodeProvider) -> ICodeCompiler - - Gets an instance of the Visual Basic code compiler. - Returns: An instance of the Visual Basic System.CodeDom.Compiler.ICodeCompiler implementation. - """ - pass - - def CreateGenerator(self, *__args): - # type: (self: VBCodeProvider) -> ICodeGenerator - """ - CreateGenerator(self: VBCodeProvider) -> ICodeGenerator - - Gets an instance of the Visual Basic code generator. - Returns: An instance of the Visual Basic System.CodeDom.Compiler.ICodeGenerator implementation. - """ - pass - - def Dispose(self): - # type: (self: Component, disposing: bool) - """ - Dispose(self: Component, disposing: bool) - Releases the unmanaged resources used by the System.ComponentModel.Component and optionally releases the managed resources. - - disposing: true to release both managed and unmanaged resources; false to release only unmanaged resources. - """ - pass - - def GenerateCodeFromMember(self, member, writer, options): - # type: (self: VBCodeProvider, member: CodeTypeMember, writer: TextWriter, options: CodeGeneratorOptions) - """ - GenerateCodeFromMember(self: VBCodeProvider, member: CodeTypeMember, writer: TextWriter, options: CodeGeneratorOptions) - Generates code for the specified class member using the specified text writer and code generator options. - - member: A System.CodeDom.CodeTypeMember to generate code for. - writer: The System.IO.TextWriter to write to. - options: The System.CodeDom.Compiler.CodeGeneratorOptions to use when generating the code. - """ - pass - - def GetConverter(self, type): - # type: (self: VBCodeProvider, type: Type) -> TypeConverter - """ - GetConverter(self: VBCodeProvider, type: Type) -> TypeConverter - - Gets a System.ComponentModel.TypeConverter for the specified type of object. - - type: The type of object to retrieve a type converter for. - Returns: A System.ComponentModel.TypeConverter for the specified type. - """ - pass - - def GetService(self, *args): #cannot find CLR method - # type: (self: Component, service: Type) -> object - """ - GetService(self: Component, service: Type) -> object - - Returns an object that represents a service provided by the System.ComponentModel.Component or by its System.ComponentModel.Container. - - service: A service provided by the System.ComponentModel.Component. - Returns: An System.Object that represents a service provided by the System.ComponentModel.Component, or null if the System.ComponentModel.Component does not provide the specified service. - """ - pass - - def MemberwiseClone(self, *args): #cannot find CLR method - # type: (self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - """ - MemberwiseClone(self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - - Creates a shallow copy of the current System.MarshalByRefObject object. - - cloneIdentity: false to delete the current System.MarshalByRefObject object's identity, which will cause the object to be assigned a new identity when it is marshaled across a remoting boundary. A value of false is usually appropriate. true to copy the current - System.MarshalByRefObject object's identity to its clone, which will cause remoting client calls to be routed to the remote server object. - - Returns: A shallow copy of the current System.MarshalByRefObject object. - MemberwiseClone(self: object) -> object - - Creates a shallow copy of the current System.Object. - Returns: A shallow copy of the current System.Object. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, providerOptions=None): - """ - __new__(cls: type) - __new__(cls: type, providerOptions: IDictionary[str, str]) - """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CanRaiseEvents = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a value indicating whether the component can raise an event. """ - - DesignMode = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a value that indicates whether the System.ComponentModel.Component is currently in design mode. """ - - Events = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the list of event handlers that are attached to this System.ComponentModel.Component. """ - - FileExtension = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the file name extension to use when creating source code files. - - Get: FileExtension(self: VBCodeProvider) -> str - """ - - LanguageOptions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a language features identifier. - - Get: LanguageOptions(self: VBCodeProvider) -> LanguageOptions - """ - - - diff --git a/pyesapi/stubs/Microsoft/Win32/SafeHandles.py b/pyesapi/stubs/Microsoft/Win32/SafeHandles.py deleted file mode 100644 index 04e960c..0000000 --- a/pyesapi/stubs/Microsoft/Win32/SafeHandles.py +++ /dev/null @@ -1,537 +0,0 @@ -# encoding: utf-8 -# module Microsoft.Win32.SafeHandles calls itself SafeHandles -# from mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class CriticalHandleMinusOneIsInvalid(CriticalHandle, IDisposable): - """ Provides a base class for Win32 critical handle implementations in which the value of -1 indicates an invalid handle. """ - def Dispose(self): - # type: (self: CriticalHandle, disposing: bool) - """ - Dispose(self: CriticalHandle, disposing: bool) - Releases the unmanaged resources used by the System.Runtime.InteropServices.CriticalHandle class specifying whether to perform a normal dispose operation. - - disposing: true for a normal dispose operation; false to finalize the handle. - """ - pass - - def ReleaseHandle(self, *args): #cannot find CLR method - # type: (self: CriticalHandle) -> bool - """ - ReleaseHandle(self: CriticalHandle) -> bool - - When overridden in a derived class, executes the code required to free the handle. - Returns: true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a releaseHandleFailed MDA Managed Debugging Assistant. - """ - pass - - def SetHandle(self, *args): #cannot find CLR method - # type: (self: CriticalHandle, handle: IntPtr) - """ - SetHandle(self: CriticalHandle, handle: IntPtr) - Sets the handle to the specified pre-existing handle. - - handle: The pre-existing handle to use. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - IsInvalid = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the handle is invalid. - - Get: IsInvalid(self: CriticalHandleMinusOneIsInvalid) -> bool - """ - - - handle = None - - -class CriticalHandleZeroOrMinusOneIsInvalid(CriticalHandle, IDisposable): - """ Provides a base class for Win32 critical handle implementations in which the value of either 0 or -1 indicates an invalid handle. """ - def Dispose(self): - # type: (self: CriticalHandle, disposing: bool) - """ - Dispose(self: CriticalHandle, disposing: bool) - Releases the unmanaged resources used by the System.Runtime.InteropServices.CriticalHandle class specifying whether to perform a normal dispose operation. - - disposing: true for a normal dispose operation; false to finalize the handle. - """ - pass - - def ReleaseHandle(self, *args): #cannot find CLR method - # type: (self: CriticalHandle) -> bool - """ - ReleaseHandle(self: CriticalHandle) -> bool - - When overridden in a derived class, executes the code required to free the handle. - Returns: true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a releaseHandleFailed MDA Managed Debugging Assistant. - """ - pass - - def SetHandle(self, *args): #cannot find CLR method - # type: (self: CriticalHandle, handle: IntPtr) - """ - SetHandle(self: CriticalHandle, handle: IntPtr) - Sets the handle to the specified pre-existing handle. - - handle: The pre-existing handle to use. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - IsInvalid = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the handle is invalid. - - Get: IsInvalid(self: CriticalHandleZeroOrMinusOneIsInvalid) -> bool - """ - - - handle = None - - -class SafeAccessTokenHandle(SafeHandle, IDisposable): - # type: (handle: IntPtr) - """ SafeAccessTokenHandle(handle: IntPtr) """ - def Dispose(self): - # type: (self: SafeHandle, disposing: bool) - """ - Dispose(self: SafeHandle, disposing: bool) - Releases the unmanaged resources used by the System.Runtime.InteropServices.SafeHandle class specifying whether to perform a normal dispose operation. - - disposing: true for a normal dispose operation; false to finalize the handle. - """ - pass - - def ReleaseHandle(self, *args): #cannot find CLR method - # type: (self: SafeAccessTokenHandle) -> bool - """ ReleaseHandle(self: SafeAccessTokenHandle) -> bool """ - pass - - def SetHandle(self, *args): #cannot find CLR method - # type: (self: SafeHandle, handle: IntPtr) - """ - SetHandle(self: SafeHandle, handle: IntPtr) - Sets the handle to the specified pre-existing handle. - - handle: The pre-existing handle to use. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, handle): - """ __new__(cls: type, handle: IntPtr) """ - pass - - IsInvalid = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SafeAccessTokenHandle) -> bool - """ Get: IsInvalid(self: SafeAccessTokenHandle) -> bool """ - - - handle = None - InvalidHandle = None - - -class SafeHandleZeroOrMinusOneIsInvalid(SafeHandle, IDisposable): - """ Provides a base class for Win32 safe handle implementations in which the value of either 0 or -1 indicates an invalid handle. """ - def Dispose(self): - # type: (self: SafeHandle, disposing: bool) - """ - Dispose(self: SafeHandle, disposing: bool) - Releases the unmanaged resources used by the System.Runtime.InteropServices.SafeHandle class specifying whether to perform a normal dispose operation. - - disposing: true for a normal dispose operation; false to finalize the handle. - """ - pass - - def ReleaseHandle(self, *args): #cannot find CLR method - # type: (self: SafeHandle) -> bool - """ - ReleaseHandle(self: SafeHandle) -> bool - - When overridden in a derived class, executes the code required to free the handle. - Returns: true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a releaseHandleFailed MDA Managed Debugging Assistant. - """ - pass - - def SetHandle(self, *args): #cannot find CLR method - # type: (self: SafeHandle, handle: IntPtr) - """ - SetHandle(self: SafeHandle, handle: IntPtr) - Sets the handle to the specified pre-existing handle. - - handle: The pre-existing handle to use. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ __new__(cls: type, ownsHandle: bool) """ - pass - - IsInvalid = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the handle is invalid. - - Get: IsInvalid(self: SafeHandleZeroOrMinusOneIsInvalid) -> bool - """ - - - handle = None - - -class SafeFileHandle(SafeHandleZeroOrMinusOneIsInvalid, IDisposable): - """ - Represents a wrapper class for a file handle. - - SafeFileHandle(preexistingHandle: IntPtr, ownsHandle: bool) - """ - def Dispose(self): - # type: (self: SafeHandle, disposing: bool) - """ - Dispose(self: SafeHandle, disposing: bool) - Releases the unmanaged resources used by the System.Runtime.InteropServices.SafeHandle class specifying whether to perform a normal dispose operation. - - disposing: true for a normal dispose operation; false to finalize the handle. - """ - pass - - def ReleaseHandle(self, *args): #cannot find CLR method - # type: (self: SafeFileHandle) -> bool - """ ReleaseHandle(self: SafeFileHandle) -> bool """ - pass - - def SetHandle(self, *args): #cannot find CLR method - # type: (self: SafeHandle, handle: IntPtr) - """ - SetHandle(self: SafeHandle, handle: IntPtr) - Sets the handle to the specified pre-existing handle. - - handle: The pre-existing handle to use. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, preexistingHandle, ownsHandle): - """ __new__(cls: type, preexistingHandle: IntPtr, ownsHandle: bool) """ - pass - - handle = None - - -class SafeHandleMinusOneIsInvalid(SafeHandle, IDisposable): - """ Provides a base class for Win32 safe handle implementations in which the value of -1 indicates an invalid handle. """ - def Dispose(self): - # type: (self: SafeHandle, disposing: bool) - """ - Dispose(self: SafeHandle, disposing: bool) - Releases the unmanaged resources used by the System.Runtime.InteropServices.SafeHandle class specifying whether to perform a normal dispose operation. - - disposing: true for a normal dispose operation; false to finalize the handle. - """ - pass - - def ReleaseHandle(self, *args): #cannot find CLR method - # type: (self: SafeHandle) -> bool - """ - ReleaseHandle(self: SafeHandle) -> bool - - When overridden in a derived class, executes the code required to free the handle. - Returns: true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a releaseHandleFailed MDA Managed Debugging Assistant. - """ - pass - - def SetHandle(self, *args): #cannot find CLR method - # type: (self: SafeHandle, handle: IntPtr) - """ - SetHandle(self: SafeHandle, handle: IntPtr) - Sets the handle to the specified pre-existing handle. - - handle: The pre-existing handle to use. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ __new__(cls: type, ownsHandle: bool) """ - pass - - IsInvalid = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the handle is invalid. - - Get: IsInvalid(self: SafeHandleMinusOneIsInvalid) -> bool - """ - - - handle = None - - -class SafeProcessHandle(SafeHandleZeroOrMinusOneIsInvalid, IDisposable): - # type: (existingHandle: IntPtr, ownsHandle: bool) - """ SafeProcessHandle(existingHandle: IntPtr, ownsHandle: bool) """ - def Dispose(self): - # type: (self: SafeHandle, disposing: bool) - """ - Dispose(self: SafeHandle, disposing: bool) - Releases the unmanaged resources used by the System.Runtime.InteropServices.SafeHandle class specifying whether to perform a normal dispose operation. - - disposing: true for a normal dispose operation; false to finalize the handle. - """ - pass - - def ReleaseHandle(self, *args): #cannot find CLR method - # type: (self: SafeProcessHandle) -> bool - """ ReleaseHandle(self: SafeProcessHandle) -> bool """ - pass - - def SetHandle(self, *args): #cannot find CLR method - # type: (self: SafeHandle, handle: IntPtr) - """ - SetHandle(self: SafeHandle, handle: IntPtr) - Sets the handle to the specified pre-existing handle. - - handle: The pre-existing handle to use. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, existingHandle, ownsHandle): - """ __new__(cls: type, existingHandle: IntPtr, ownsHandle: bool) """ - pass - - handle = None - - -class SafeRegistryHandle(SafeHandleZeroOrMinusOneIsInvalid, IDisposable): - """ - Represents a safe handle to the Windows registry. - - SafeRegistryHandle(preexistingHandle: IntPtr, ownsHandle: bool) - """ - def Dispose(self): - # type: (self: SafeHandle, disposing: bool) - """ - Dispose(self: SafeHandle, disposing: bool) - Releases the unmanaged resources used by the System.Runtime.InteropServices.SafeHandle class specifying whether to perform a normal dispose operation. - - disposing: true for a normal dispose operation; false to finalize the handle. - """ - pass - - def ReleaseHandle(self, *args): #cannot find CLR method - # type: (self: SafeRegistryHandle) -> bool - """ ReleaseHandle(self: SafeRegistryHandle) -> bool """ - pass - - def SetHandle(self, *args): #cannot find CLR method - # type: (self: SafeHandle, handle: IntPtr) - """ - SetHandle(self: SafeHandle, handle: IntPtr) - Sets the handle to the specified pre-existing handle. - - handle: The pre-existing handle to use. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, preexistingHandle, ownsHandle): - """ __new__(cls: type, preexistingHandle: IntPtr, ownsHandle: bool) """ - pass - - handle = None - - -class SafeWaitHandle(SafeHandleZeroOrMinusOneIsInvalid, IDisposable): - """ - Represents a wrapper class for a wait handle. - - SafeWaitHandle(existingHandle: IntPtr, ownsHandle: bool) - """ - def Dispose(self): - # type: (self: SafeHandle, disposing: bool) - """ - Dispose(self: SafeHandle, disposing: bool) - Releases the unmanaged resources used by the System.Runtime.InteropServices.SafeHandle class specifying whether to perform a normal dispose operation. - - disposing: true for a normal dispose operation; false to finalize the handle. - """ - pass - - def ReleaseHandle(self, *args): #cannot find CLR method - # type: (self: SafeWaitHandle) -> bool - """ ReleaseHandle(self: SafeWaitHandle) -> bool """ - pass - - def SetHandle(self, *args): #cannot find CLR method - # type: (self: SafeHandle, handle: IntPtr) - """ - SetHandle(self: SafeHandle, handle: IntPtr) - Sets the handle to the specified pre-existing handle. - - handle: The pre-existing handle to use. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, existingHandle, ownsHandle): - """ __new__(cls: type, existingHandle: IntPtr, ownsHandle: bool) """ - pass - - handle = None - - -class SafeX509ChainHandle(SafeHandleZeroOrMinusOneIsInvalid, IDisposable): - # no doc - def Dispose(self): - # type: (self: SafeHandle, disposing: bool) - """ - Dispose(self: SafeHandle, disposing: bool) - Releases the unmanaged resources used by the System.Runtime.InteropServices.SafeHandle class specifying whether to perform a normal dispose operation. - - disposing: true for a normal dispose operation; false to finalize the handle. - """ - pass - - def ReleaseHandle(self, *args): #cannot find CLR method - # type: (self: SafeX509ChainHandle) -> bool - """ ReleaseHandle(self: SafeX509ChainHandle) -> bool """ - pass - - def SetHandle(self, *args): #cannot find CLR method - # type: (self: SafeHandle, handle: IntPtr) - """ - SetHandle(self: SafeHandle, handle: IntPtr) - Sets the handle to the specified pre-existing handle. - - handle: The pre-existing handle to use. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - handle = None - - diff --git a/pyesapi/stubs/Microsoft/Win32/__init__.py b/pyesapi/stubs/Microsoft/Win32/__init__.py deleted file mode 100644 index dd946ca..0000000 --- a/pyesapi/stubs/Microsoft/Win32/__init__.py +++ /dev/null @@ -1,1727 +0,0 @@ -# encoding: utf-8 -# module Microsoft.Win32 calls itself Win32 -# from mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class IntranetZoneCredentialPolicy(object, ICredentialPolicy): - """ - Defines a credential policy to be used for resource requests that are made using System.Net.WebRequest and its derived classes. - - IntranetZoneCredentialPolicy() - """ - def ShouldSendCredential(self, challengeUri, request, credential, authModule): - # type: (self: IntranetZoneCredentialPolicy, challengeUri: Uri, request: WebRequest, credential: NetworkCredential, authModule: IAuthenticationModule) -> bool - """ - ShouldSendCredential(self: IntranetZoneCredentialPolicy, challengeUri: Uri, request: WebRequest, credential: NetworkCredential, authModule: IAuthenticationModule) -> bool - - Returns a System.Boolean that indicates whether the client's credentials are sent with a request for a resource that was made using System.Net.WebRequest. - - challengeUri: The System.Uri that will receive the request. - request: The System.Net.WebRequest that represents the resource being requested. - credential: The System.Net.NetworkCredential that will be sent with the request if this method returns true. - authModule: The System.Net.IAuthenticationModule that will conduct the authentication, if authentication is required. - Returns: true if the requested resource is in the same domain as the client making the request; otherwise, false. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - -class PowerModeChangedEventArgs(EventArgs): - """ - Provides data for the Microsoft.Win32.SystemEvents.PowerModeChanged event. - - PowerModeChangedEventArgs(mode: PowerModes) - """ - @staticmethod # known case of __new__ - def __new__(self, mode): - """ __new__(cls: type, mode: PowerModes) """ - pass - - Mode = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an identifier that indicates the type of the power mode event that has occurred. - - Get: Mode(self: PowerModeChangedEventArgs) -> PowerModes - """ - - - -class PowerModeChangedEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the Microsoft.Win32.SystemEvents.PowerModeChanged event. - - PowerModeChangedEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: PowerModeChangedEventHandler, sender: object, e: PowerModeChangedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: PowerModeChangedEventHandler, sender: object, e: PowerModeChangedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: PowerModeChangedEventHandler, result: IAsyncResult) - """ EndInvoke(self: PowerModeChangedEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: PowerModeChangedEventHandler, sender: object, e: PowerModeChangedEventArgs) - """ Invoke(self: PowerModeChangedEventHandler, sender: object, e: PowerModeChangedEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class PowerModes(Enum, IComparable, IFormattable, IConvertible): - """ - Defines identifiers for power mode events reported by the operating system. - - enum PowerModes, values: Resume (1), StatusChange (2), Suspend (3) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Resume = None - StatusChange = None - Suspend = None - value__ = None - - -class Registry(object): - """ Provides Microsoft.Win32.RegistryKey objects that represent the root keys in the Windows registry, and static methods to access key/value pairs. """ - @staticmethod - def GetValue(keyName, valueName, defaultValue): - # type: (keyName: str, valueName: str, defaultValue: object) -> object - """ - GetValue(keyName: str, valueName: str, defaultValue: object) -> object - - Retrieves the value associated with the specified name, in the specified registry key. If the name is not found in the specified key, returns a default value that you provide, or null if the specified key does not exist. - - keyName: The full registry path of the key, beginning with a valid registry root, such as "HKEY_CURRENT_USER". - valueName: The name of the name/value pair. - defaultValue: The value to return if valueName does not exist. - Returns: null if the subkey specified by keyName does not exist; otherwise, the value associated with valueName, or defaultValue if valueName is not found. - """ - pass - - @staticmethod - def SetValue(keyName, valueName, value, valueKind=None): - # type: (keyName: str, valueName: str, value: object, valueKind: RegistryValueKind) - """ - SetValue(keyName: str, valueName: str, value: object, valueKind: RegistryValueKind) - Sets the name/value pair on the specified registry key, using the specified registry data type. If the specified key does not exist, it is created. - - keyName: The full registry path of the key, beginning with a valid registry root, such as "HKEY_CURRENT_USER". - valueName: The name of the name/value pair. - value: The value to be stored. - valueKind: The registry data type to use when storing the data. - SetValue(keyName: str, valueName: str, value: object) - Sets the specified name/value pair on the specified registry key. If the specified key does not exist, it is created. - - keyName: The full registry path of the key, beginning with a valid registry root, such as "HKEY_CURRENT_USER". - valueName: The name of the name/value pair. - value: The value to be stored. - """ - pass - - ClassesRoot = None - CurrentConfig = None - CurrentUser = None - DynData = None - LocalMachine = None - PerformanceData = None - Users = None - __all__ = [ - 'ClassesRoot', - 'CurrentConfig', - 'CurrentUser', - 'DynData', - 'GetValue', - 'LocalMachine', - 'PerformanceData', - 'SetValue', - 'Users', - ] - - -class RegistryHive(Enum, IComparable, IFormattable, IConvertible): - """ - Represents the possible values for a top-level node on a foreign machine. - - enum RegistryHive, values: ClassesRoot (-2147483648), CurrentConfig (-2147483643), CurrentUser (-2147483647), DynData (-2147483642), LocalMachine (-2147483646), PerformanceData (-2147483644), Users (-2147483645) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ClassesRoot = None - CurrentConfig = None - CurrentUser = None - DynData = None - LocalMachine = None - PerformanceData = None - Users = None - value__ = None - - -class RegistryKey(MarshalByRefObject, IDisposable): - """ Represents a key-level node in the Windows registry. This class is a registry encapsulation. """ - def Close(self): - # type: (self: RegistryKey) - """ - Close(self: RegistryKey) - Closes the key and flushes it to disk if its contents have been modified. - """ - pass - - def CreateSubKey(self, subkey, *__args): - # type: (self: RegistryKey, subkey: str) -> RegistryKey - """ - CreateSubKey(self: RegistryKey, subkey: str) -> RegistryKey - - Creates a new subkey or opens an existing subkey for write access. - - subkey: The name or path of the subkey to create or open. This string is not case-sensitive. - Returns: The newly created subkey, or null if the operation failed. If a zero-length string is specified for subkey, the current Microsoft.Win32.RegistryKey object is returned. - CreateSubKey(self: RegistryKey, subkey: str, permissionCheck: RegistryKeyPermissionCheck) -> RegistryKey - - Creates a new subkey or opens an existing subkey for write access, using the specified permission check option. - - subkey: The name or path of the subkey to create or open. This string is not case-sensitive. - permissionCheck: One of the enumeration values that specifies whether the key is opened for read or read/write access. - Returns: The newly created subkey, or null if the operation failed. If a zero-length string is specified for subkey, the current Microsoft.Win32.RegistryKey object is returned. - CreateSubKey(self: RegistryKey, subkey: str, permissionCheck: RegistryKeyPermissionCheck, options: RegistryOptions) -> RegistryKey - - Creates a subkey or opens a subkey for write access, using the specified permission check and registry options. - - subkey: The name or path of the subkey to create or open. - permissionCheck: One of the enumeration values that specifies whether the key is opened for read or read/write access. - options: The registry option to use; for example, that creates a volatile key. - Returns: The newly created subkey, or null if the operation failed. - CreateSubKey(self: RegistryKey, subkey: str, writable: bool) -> RegistryKey - CreateSubKey(self: RegistryKey, subkey: str, writable: bool, options: RegistryOptions) -> RegistryKey - CreateSubKey(self: RegistryKey, subkey: str, permissionCheck: RegistryKeyPermissionCheck, registrySecurity: RegistrySecurity) -> RegistryKey - - Creates a new subkey or opens an existing subkey for write access, using the specified permission check option and registry security. - - subkey: The name or path of the subkey to create or open. This string is not case-sensitive. - permissionCheck: One of the enumeration values that specifies whether the key is opened for read or read/write access. - registrySecurity: The access control security for the new key. - Returns: The newly created subkey, or null if the operation failed. If a zero-length string is specified for subkey, the current Microsoft.Win32.RegistryKey object is returned. - CreateSubKey(self: RegistryKey, subkey: str, permissionCheck: RegistryKeyPermissionCheck, registryOptions: RegistryOptions, registrySecurity: RegistrySecurity) -> RegistryKey - - Creates a subkey or opens a subkey for write access, using the specified permission check option, registry option, and registry security. - - subkey: The name or path of the subkey to create or open. - permissionCheck: One of the enumeration values that specifies whether the key is opened for read or read/write access. - registryOptions: The registry option to use. - registrySecurity: The access control security for the new subkey. - Returns: The newly created subkey, or null if the operation failed. - """ - pass - - def DeleteSubKey(self, subkey, throwOnMissingSubKey=None): - # type: (self: RegistryKey, subkey: str) - """ - DeleteSubKey(self: RegistryKey, subkey: str) - Deletes the specified subkey. - - subkey: The name of the subkey to delete. This string is not case-sensitive. - DeleteSubKey(self: RegistryKey, subkey: str, throwOnMissingSubKey: bool) - Deletes the specified subkey, and specifies whether an exception is raised if the subkey is not found. - - subkey: The name of the subkey to delete. This string is not case-sensitive. - throwOnMissingSubKey: Indicates whether an exception should be raised if the specified subkey cannot be found. If this argument is true and the specified subkey does not exist, an exception is raised. If this argument is false and the specified subkey does not exist, no - action is taken. - """ - pass - - def DeleteSubKeyTree(self, subkey, throwOnMissingSubKey=None): - # type: (self: RegistryKey, subkey: str) - """ - DeleteSubKeyTree(self: RegistryKey, subkey: str) - Deletes a subkey and any child subkeys recursively. - - subkey: The subkey to delete. This string is not case-sensitive. - DeleteSubKeyTree(self: RegistryKey, subkey: str, throwOnMissingSubKey: bool) - Deletes the specified subkey and any child subkeys recursively, and specifies whether an exception is raised if the subkey is not found. - - subkey: The name of the subkey to delete. This string is not case-sensitive. - throwOnMissingSubKey: Indicates whether an exception should be raised if the specified subkey cannot be found. If this argument is true and the specified subkey does not exist, an exception is raised. If this argument is false and the specified subkey does not exist, no - action is taken. - """ - pass - - def DeleteValue(self, name, throwOnMissingValue=None): - # type: (self: RegistryKey, name: str) - """ - DeleteValue(self: RegistryKey, name: str) - Deletes the specified value from this key. - - name: The name of the value to delete. - DeleteValue(self: RegistryKey, name: str, throwOnMissingValue: bool) - Deletes the specified value from this key, and specifies whether an exception is raised if the value is not found. - - name: The name of the value to delete. - throwOnMissingValue: Indicates whether an exception should be raised if the specified value cannot be found. If this argument is true and the specified value does not exist, an exception is raised. If this argument is false and the specified value does not exist, no - action is taken. - """ - pass - - def Dispose(self): - # type: (self: RegistryKey) - """ - Dispose(self: RegistryKey) - Releases all resources used by the current instance of the Microsoft.Win32.RegistryKey class. - """ - pass - - def Flush(self): - # type: (self: RegistryKey) - """ - Flush(self: RegistryKey) - Writes all the attributes of the specified open registry key into the registry. - """ - pass - - @staticmethod - def FromHandle(handle, view=None): - # type: (handle: SafeRegistryHandle) -> RegistryKey - """ - FromHandle(handle: SafeRegistryHandle) -> RegistryKey - - Creates a registry key from a specified handle. - - handle: The handle to the registry key. - Returns: A registry key. - FromHandle(handle: SafeRegistryHandle, view: RegistryView) -> RegistryKey - - Creates a registry key from a specified handle and registry view setting. - - handle: The handle to the registry key. - view: The registry view to use. - Returns: A registry key. - """ - pass - - def GetAccessControl(self, includeSections=None): - # type: (self: RegistryKey) -> RegistrySecurity - """ - GetAccessControl(self: RegistryKey) -> RegistrySecurity - - Returns the access control security for the current registry key. - Returns: An object that describes the access control permissions on the registry key represented by the current Microsoft.Win32.RegistryKey. - GetAccessControl(self: RegistryKey, includeSections: AccessControlSections) -> RegistrySecurity - - Returns the specified sections of the access control security for the current registry key. - - includeSections: A bitwise combination of enumeration values that specifies the type of security information to get. - Returns: An object that describes the access control permissions on the registry key represented by the current Microsoft.Win32.RegistryKey. - """ - pass - - def GetSubKeyNames(self): - # type: (self: RegistryKey) -> Array[str] - """ - GetSubKeyNames(self: RegistryKey) -> Array[str] - - Retrieves an array of strings that contains all the subkey names. - Returns: An array of strings that contains the names of the subkeys for the current key. - """ - pass - - def GetValue(self, name, defaultValue=None, options=None): - # type: (self: RegistryKey, name: str) -> object - """ - GetValue(self: RegistryKey, name: str) -> object - - Retrieves the value associated with the specified name. Returns null if the name/value pair does not exist in the registry. - - name: The name of the value to retrieve. This string is not case-sensitive. - Returns: The value associated with name, or null if name is not found. - GetValue(self: RegistryKey, name: str, defaultValue: object) -> object - - Retrieves the value associated with the specified name. If the name is not found, returns the default value that you provide. - - name: The name of the value to retrieve. This string is not case-sensitive. - defaultValue: The value to return if name does not exist. - Returns: The value associated with name, with any embedded environment variables left unexpanded, or defaultValue if name is not found. - GetValue(self: RegistryKey, name: str, defaultValue: object, options: RegistryValueOptions) -> object - - Retrieves the value associated with the specified name and retrieval options. If the name is not found, returns the default value that you provide. - - name: The name of the value to retrieve. This string is not case-sensitive. - defaultValue: The value to return if name does not exist. - options: One of the enumeration values that specifies optional processing of the retrieved value. - Returns: The value associated with name, processed according to the specified options, or defaultValue if name is not found. - """ - pass - - def GetValueKind(self, name): - # type: (self: RegistryKey, name: str) -> RegistryValueKind - """ - GetValueKind(self: RegistryKey, name: str) -> RegistryValueKind - - Retrieves the registry data type of the value associated with the specified name. - - name: The name of the value whose registry data type is to be retrieved. This string is not case-sensitive. - Returns: The registry data type of the value associated with name. - """ - pass - - def GetValueNames(self): - # type: (self: RegistryKey) -> Array[str] - """ - GetValueNames(self: RegistryKey) -> Array[str] - - Retrieves an array of strings that contains all the value names associated with this key. - Returns: An array of strings that contains the value names for the current key. - """ - pass - - def MemberwiseClone(self, *args): #cannot find CLR method - # type: (self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - """ - MemberwiseClone(self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - - Creates a shallow copy of the current System.MarshalByRefObject object. - - cloneIdentity: false to delete the current System.MarshalByRefObject object's identity, which will cause the object to be assigned a new identity when it is marshaled across a remoting boundary. A value of false is usually appropriate. true to copy the current - System.MarshalByRefObject object's identity to its clone, which will cause remoting client calls to be routed to the remote server object. - - Returns: A shallow copy of the current System.MarshalByRefObject object. - MemberwiseClone(self: object) -> object - - Creates a shallow copy of the current System.Object. - Returns: A shallow copy of the current System.Object. - """ - pass - - @staticmethod - def OpenBaseKey(hKey, view): - # type: (hKey: RegistryHive, view: RegistryView) -> RegistryKey - """ - OpenBaseKey(hKey: RegistryHive, view: RegistryView) -> RegistryKey - - Opens a new Microsoft.Win32.RegistryKey that represents the requested key on the local machine with the specified view. - - hKey: The HKEY to open. - view: The registry view to use. - Returns: The requested registry key. - """ - pass - - @staticmethod - def OpenRemoteBaseKey(hKey, machineName, view=None): - # type: (hKey: RegistryHive, machineName: str) -> RegistryKey - """ - OpenRemoteBaseKey(hKey: RegistryHive, machineName: str) -> RegistryKey - - Opens a new Microsoft.Win32.RegistryKey that represents the requested key on a remote machine. - - hKey: The HKEY to open, from the Microsoft.Win32.RegistryHive enumeration. - machineName: The remote machine. - Returns: The requested registry key. - OpenRemoteBaseKey(hKey: RegistryHive, machineName: str, view: RegistryView) -> RegistryKey - - Opens a new registry key that represents the requested key on a remote machine with the specified view. - - hKey: The HKEY to open from the Microsoft.Win32.RegistryHive enumeration.. - machineName: The remote machine. - view: The registry view to use. - Returns: The requested registry key. - """ - pass - - def OpenSubKey(self, name, *__args): - # type: (self: RegistryKey, name: str, writable: bool) -> RegistryKey - """ - OpenSubKey(self: RegistryKey, name: str, writable: bool) -> RegistryKey - - Retrieves a specified subkey, and specifies whether write access is to be applied to the key. - - name: Name or path of the subkey to open. - writable: Set to true if you need write access to the key. - Returns: The subkey requested, or null if the operation failed. - OpenSubKey(self: RegistryKey, name: str, permissionCheck: RegistryKeyPermissionCheck) -> RegistryKey - - Retrieves the specified subkey for read or read/write access. - - name: The name or path of the subkey to create or open. - permissionCheck: One of the enumeration values that specifies whether the key is opened for read or read/write access. - Returns: The subkey requested, or null if the operation failed. - OpenSubKey(self: RegistryKey, name: str, rights: RegistryRights) -> RegistryKey - OpenSubKey(self: RegistryKey, name: str, permissionCheck: RegistryKeyPermissionCheck, rights: RegistryRights) -> RegistryKey - - Retrieves the specified subkey for read or read/write access, requesting the specified access rights. - - name: The name or path of the subkey to create or open. - permissionCheck: One of the enumeration values that specifies whether the key is opened for read or read/write access. - rights: A bitwise combination of enumeration values that specifies the desired security access. - Returns: The subkey requested, or null if the operation failed. - OpenSubKey(self: RegistryKey, name: str) -> RegistryKey - - Retrieves a subkey as read-only. - - name: The name or path of the subkey to open as read-only. - Returns: The subkey requested, or null if the operation failed. - """ - pass - - def SetAccessControl(self, registrySecurity): - # type: (self: RegistryKey, registrySecurity: RegistrySecurity) - """ - SetAccessControl(self: RegistryKey, registrySecurity: RegistrySecurity) - Applies Windows access control security to an existing registry key. - - registrySecurity: The access control security to apply to the current subkey. - """ - pass - - def SetValue(self, name, value, valueKind=None): - # type: (self: RegistryKey, name: str, value: object) - """ - SetValue(self: RegistryKey, name: str, value: object) - Sets the specified name/value pair. - - name: The name of the value to store. - value: The data to be stored. - SetValue(self: RegistryKey, name: str, value: object, valueKind: RegistryValueKind) - Sets the value of a name/value pair in the registry key, using the specified registry data type. - - name: The name of the value to be stored. - value: The data to be stored. - valueKind: The registry data type to use when storing the data. - """ - pass - - def ToString(self): - # type: (self: RegistryKey) -> str - """ - ToString(self: RegistryKey) -> str - - Retrieves a string representation of this key. - Returns: A string representing the key. If the specified key is invalid (cannot be found) then null is returned. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Handle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a Microsoft.Win32.SafeHandles.SafeRegistryHandle object that represents the registry key that the current Microsoft.Win32.RegistryKey object encapsulates. - - Get: Handle(self: RegistryKey) -> SafeRegistryHandle - """ - - Name = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Retrieves the name of the key. - - Get: Name(self: RegistryKey) -> str - """ - - SubKeyCount = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Retrieves the count of subkeys of the current key. - - Get: SubKeyCount(self: RegistryKey) -> int - """ - - ValueCount = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Retrieves the count of values in the key. - - Get: ValueCount(self: RegistryKey) -> int - """ - - View = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the view that was used to create the registry key. - - Get: View(self: RegistryKey) -> RegistryView - """ - - - -class RegistryKeyPermissionCheck(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies whether security checks are performed when opening registry keys and accessing their name/value pairs. - - enum RegistryKeyPermissionCheck, values: Default (0), ReadSubTree (1), ReadWriteSubTree (2) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Default = None - ReadSubTree = None - ReadWriteSubTree = None - value__ = None - - -class RegistryOptions(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies options to use when creating a registry key. - - enum (flags) RegistryOptions, values: None (0), Volatile (1) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - None = None - value__ = None - Volatile = None - - -class RegistryValueKind(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies the data types to use when storing values in the registry, or identifies the data type of a value in the registry. - - enum RegistryValueKind, values: Binary (3), DWord (4), ExpandString (2), MultiString (7), None (-1), QWord (11), String (1), Unknown (0) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Binary = None - DWord = None - ExpandString = None - MultiString = None - None = None - QWord = None - String = None - Unknown = None - value__ = None - - -class RegistryValueOptions(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies optional behavior when retrieving name/value pairs from a registry key. - - enum (flags) RegistryValueOptions, values: DoNotExpandEnvironmentNames (1), None (0) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - DoNotExpandEnvironmentNames = None - None = None - value__ = None - - -class RegistryView(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies which registry view to target on a 64-bit operating system. - - enum RegistryView, values: Default (0), Registry32 (512), Registry64 (256) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Default = None - Registry32 = None - Registry64 = None - value__ = None - - -class SessionEndedEventArgs(EventArgs): - """ - Provides data for the Microsoft.Win32.SystemEvents.SessionEnded event. - - SessionEndedEventArgs(reason: SessionEndReasons) - """ - @staticmethod # known case of __new__ - def __new__(self, reason): - """ __new__(cls: type, reason: SessionEndReasons) """ - pass - - Reason = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an identifier that indicates how the session ended. - - Get: Reason(self: SessionEndedEventArgs) -> SessionEndReasons - """ - - - -class SessionEndedEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the Microsoft.Win32.SystemEvents.SessionEnded event. - - SessionEndedEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: SessionEndedEventHandler, sender: object, e: SessionEndedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: SessionEndedEventHandler, sender: object, e: SessionEndedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: SessionEndedEventHandler, result: IAsyncResult) - """ EndInvoke(self: SessionEndedEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: SessionEndedEventHandler, sender: object, e: SessionEndedEventArgs) - """ Invoke(self: SessionEndedEventHandler, sender: object, e: SessionEndedEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class SessionEndingEventArgs(EventArgs): - """ - Provides data for the Microsoft.Win32.SystemEvents.SessionEnding event. - - SessionEndingEventArgs(reason: SessionEndReasons) - """ - @staticmethod # known case of __new__ - def __new__(self, reason): - """ __new__(cls: type, reason: SessionEndReasons) """ - pass - - Cancel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a value indicating whether to cancel the user request to end the session. - - Get: Cancel(self: SessionEndingEventArgs) -> bool - - Set: Cancel(self: SessionEndingEventArgs) = value - """ - - Reason = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the reason the session is ending. - - Get: Reason(self: SessionEndingEventArgs) -> SessionEndReasons - """ - - - -class SessionEndingEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the Microsoft.Win32.SystemEvents.SessionEnding event from the operating system. - - SessionEndingEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: SessionEndingEventHandler, sender: object, e: SessionEndingEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: SessionEndingEventHandler, sender: object, e: SessionEndingEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: SessionEndingEventHandler, result: IAsyncResult) - """ EndInvoke(self: SessionEndingEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: SessionEndingEventHandler, sender: object, e: SessionEndingEventArgs) - """ Invoke(self: SessionEndingEventHandler, sender: object, e: SessionEndingEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class SessionEndReasons(Enum, IComparable, IFormattable, IConvertible): - """ - Defines identifiers that represent how the current logon session is ending. - - enum SessionEndReasons, values: Logoff (1), SystemShutdown (2) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Logoff = None - SystemShutdown = None - value__ = None - - -class SessionSwitchEventArgs(EventArgs): - """ - Provides data for the Microsoft.Win32.SystemEvents.SessionSwitch event. - - SessionSwitchEventArgs(reason: SessionSwitchReason) - """ - @staticmethod # known case of __new__ - def __new__(self, reason): - """ __new__(cls: type, reason: SessionSwitchReason) """ - pass - - Reason = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an identifier that indicates the type of session change event. - - Get: Reason(self: SessionSwitchEventArgs) -> SessionSwitchReason - """ - - - -class SessionSwitchEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the Microsoft.Win32.SystemEvents.SessionSwitch event. - - SessionSwitchEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: SessionSwitchEventHandler, sender: object, e: SessionSwitchEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: SessionSwitchEventHandler, sender: object, e: SessionSwitchEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: SessionSwitchEventHandler, result: IAsyncResult) - """ EndInvoke(self: SessionSwitchEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: SessionSwitchEventHandler, sender: object, e: SessionSwitchEventArgs) - """ Invoke(self: SessionSwitchEventHandler, sender: object, e: SessionSwitchEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class SessionSwitchReason(Enum, IComparable, IFormattable, IConvertible): - """ - Defines identifiers used to represent the type of a session switch event. - - enum SessionSwitchReason, values: ConsoleConnect (1), ConsoleDisconnect (2), RemoteConnect (3), RemoteDisconnect (4), SessionLock (7), SessionLogoff (6), SessionLogon (5), SessionRemoteControl (9), SessionUnlock (8) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ConsoleConnect = None - ConsoleDisconnect = None - RemoteConnect = None - RemoteDisconnect = None - SessionLock = None - SessionLogoff = None - SessionLogon = None - SessionRemoteControl = None - SessionUnlock = None - value__ = None - - -class SystemEvents(object): - """ Provides access to system event notifications. This class cannot be inherited. """ - @staticmethod - def CreateTimer(interval): - # type: (interval: int) -> IntPtr - """ - CreateTimer(interval: int) -> IntPtr - - Creates a new window timer associated with the system events window. - - interval: Specifies the interval between timer notifications, in milliseconds. - Returns: The ID of the new timer. - """ - pass - - @staticmethod - def InvokeOnEventsThread(method): - # type: (method: Delegate) - """ - InvokeOnEventsThread(method: Delegate) - Invokes the specified delegate using the thread that listens for system events. - - method: A delegate to invoke using the thread that listens for system events. - """ - pass - - @staticmethod - def KillTimer(timerId): - # type: (timerId: IntPtr) - """ - KillTimer(timerId: IntPtr) - Terminates the timer specified by the given id. - - timerId: The ID of the timer to terminate. - """ - pass - - DisplaySettingsChanged = None - DisplaySettingsChanging = None - EventsThreadShutdown = None - InstalledFontsChanged = None - LowMemory = None - PaletteChanged = None - PowerModeChanged = None - SessionEnded = None - SessionEnding = None - SessionSwitch = None - TimeChanged = None - TimerElapsed = None - UserPreferenceChanged = None - UserPreferenceChanging = None - - -class TimerElapsedEventArgs(EventArgs): - """ - Provides data for the Microsoft.Win32.SystemEvents.TimerElapsed event. - - TimerElapsedEventArgs(timerId: IntPtr) - """ - @staticmethod # known case of __new__ - def __new__(self, timerId): - """ __new__(cls: type, timerId: IntPtr) """ - pass - - TimerId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the ID number for the timer. - - Get: TimerId(self: TimerElapsedEventArgs) -> IntPtr - """ - - - -class TimerElapsedEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the Microsoft.Win32.SystemEvents.TimerElapsed event. - - TimerElapsedEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: TimerElapsedEventHandler, sender: object, e: TimerElapsedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: TimerElapsedEventHandler, sender: object, e: TimerElapsedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: TimerElapsedEventHandler, result: IAsyncResult) - """ EndInvoke(self: TimerElapsedEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: TimerElapsedEventHandler, sender: object, e: TimerElapsedEventArgs) - """ Invoke(self: TimerElapsedEventHandler, sender: object, e: TimerElapsedEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class UserPreferenceCategory(Enum, IComparable, IFormattable, IConvertible): - """ - Defines identifiers that represent categories of user preferences. - - enum UserPreferenceCategory, values: Accessibility (1), Color (2), Desktop (3), General (4), Icon (5), Keyboard (6), Locale (13), Menu (7), Mouse (8), Policy (9), Power (10), Screensaver (11), VisualStyle (14), Window (12) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Accessibility = None - Color = None - Desktop = None - General = None - Icon = None - Keyboard = None - Locale = None - Menu = None - Mouse = None - Policy = None - Power = None - Screensaver = None - value__ = None - VisualStyle = None - Window = None - - -class UserPreferenceChangedEventArgs(EventArgs): - """ - Provides data for the Microsoft.Win32.SystemEvents.UserPreferenceChanged event. - - UserPreferenceChangedEventArgs(category: UserPreferenceCategory) - """ - @staticmethod # known case of __new__ - def __new__(self, category): - """ __new__(cls: type, category: UserPreferenceCategory) """ - pass - - Category = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the category of user preferences that has changed. - - Get: Category(self: UserPreferenceChangedEventArgs) -> UserPreferenceCategory - """ - - - -class UserPreferenceChangedEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the Microsoft.Win32.SystemEvents.UserPreferenceChanged event. - - UserPreferenceChangedEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: UserPreferenceChangedEventHandler, sender: object, e: UserPreferenceChangedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: UserPreferenceChangedEventHandler, sender: object, e: UserPreferenceChangedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: UserPreferenceChangedEventHandler, result: IAsyncResult) - """ EndInvoke(self: UserPreferenceChangedEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: UserPreferenceChangedEventHandler, sender: object, e: UserPreferenceChangedEventArgs) - """ Invoke(self: UserPreferenceChangedEventHandler, sender: object, e: UserPreferenceChangedEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class UserPreferenceChangingEventArgs(EventArgs): - """ - Provides data for the Microsoft.Win32.SystemEvents.UserPreferenceChanging event. - - UserPreferenceChangingEventArgs(category: UserPreferenceCategory) - """ - @staticmethod # known case of __new__ - def __new__(self, category): - """ __new__(cls: type, category: UserPreferenceCategory) """ - pass - - Category = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the category of user preferences that is changing. - - Get: Category(self: UserPreferenceChangingEventArgs) -> UserPreferenceCategory - """ - - - -class UserPreferenceChangingEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the Microsoft.Win32.SystemEvents.UserPreferenceChanging event. - - UserPreferenceChangingEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: UserPreferenceChangingEventHandler, sender: object, e: UserPreferenceChangingEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: UserPreferenceChangingEventHandler, sender: object, e: UserPreferenceChangingEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: UserPreferenceChangingEventHandler, result: IAsyncResult) - """ EndInvoke(self: UserPreferenceChangingEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: UserPreferenceChangingEventHandler, sender: object, e: UserPreferenceChangingEventArgs) - """ Invoke(self: UserPreferenceChangingEventHandler, sender: object, e: UserPreferenceChangingEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -# variables with complex values - diff --git a/pyesapi/stubs/Microsoft/__init__.py b/pyesapi/stubs/Microsoft/__init__.py deleted file mode 100644 index 5d1a3f9..0000000 --- a/pyesapi/stubs/Microsoft/__init__.py +++ /dev/null @@ -1,11 +0,0 @@ -# encoding: utf-8 -# module Microsoft -# from mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# no classes -# variables with complex values - diff --git a/pyesapi/stubs/System/Array.py b/pyesapi/stubs/System/Array.py deleted file mode 100644 index f11c699..0000000 --- a/pyesapi/stubs/System/Array.py +++ /dev/null @@ -1,2 +0,0 @@ -class Array: - ... diff --git a/pyesapi/stubs/System/Collections/Concurrent.py b/pyesapi/stubs/System/Collections/Concurrent.py deleted file mode 100644 index 8ea4047..0000000 --- a/pyesapi/stubs/System/Collections/Concurrent.py +++ /dev/null @@ -1,947 +0,0 @@ -# encoding: utf-8 -# module System.Collections.Concurrent calls itself Concurrent -# from mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# functions - -def Partitioner(*args, **kwargs): # real signature unknown - """ Provides common partitioning strategies for arrays, lists, and enumerables. """ - pass - -# classes - -class BlockingCollection(object, IEnumerable[T], IEnumerable, ICollection, IDisposable, IReadOnlyCollection[T]): - # type: () - """ - BlockingCollection[T]() - BlockingCollection[T](boundedCapacity: int) - BlockingCollection[T](collection: IProducerConsumerCollection[T], boundedCapacity: int) - BlockingCollection[T](collection: IProducerConsumerCollection[T]) - """ - def Add(self, item, cancellationToken=None): - # type: (self: BlockingCollection[T], item: T) - """ - Add(self: BlockingCollection[T], item: T) - Adds the item to the System.Collections.Concurrent.BlockingCollection. - - item: The item to be added to the collection. The value can be a null reference. - Add(self: BlockingCollection[T], item: T, cancellationToken: CancellationToken) - Adds the item to the System.Collections.Concurrent.BlockingCollection. - - item: The item to be added to the collection. The value can be a null reference. - cancellationToken: A cancellation token to observe. - """ - pass - - @staticmethod - def AddToAny(collections, item, cancellationToken=None): - # type: (collections: Array[BlockingCollection[T]], item: T) -> int - """ - AddToAny(collections: Array[BlockingCollection[T]], item: T) -> int - AddToAny(collections: Array[BlockingCollection[T]], item: T, cancellationToken: CancellationToken) -> int - """ - pass - - def CompleteAdding(self): - # type: (self: BlockingCollection[T]) - """ - CompleteAdding(self: BlockingCollection[T]) - Marks the System.Collections.Concurrent.BlockingCollection instances as not accepting any more additions. - """ - pass - - def CopyTo(self, array, index): - # type: (self: BlockingCollection[T], array: Array[T], index: int) - """ CopyTo(self: BlockingCollection[T], array: Array[T], index: int) """ - pass - - def Dispose(self): - # type: (self: BlockingCollection[T]) - """ - Dispose(self: BlockingCollection[T]) - Releases all resources used by the current instance of the System.Collections.Concurrent.BlockingCollection class. - """ - pass - - def GetConsumingEnumerable(self, cancellationToken=None): - # type: (self: BlockingCollection[T]) -> IEnumerable[T] - """ - GetConsumingEnumerable(self: BlockingCollection[T]) -> IEnumerable[T] - - Provides a consuming System.Collections.Generics.IEnumerable for items in the collection. - Returns: An System.Collections.Generics.IEnumerable that removes and returns items from the collection. - GetConsumingEnumerable(self: BlockingCollection[T], cancellationToken: CancellationToken) -> IEnumerable[T] - - Provides a consuming System.Collections.Generics.IEnumerable for items in the collection. - - cancellationToken: A cancellation token to observe. - Returns: An System.Collections.Generics.IEnumerable that removes and returns items from the collection. - """ - pass - - def Take(self, cancellationToken=None): - # type: (self: BlockingCollection[T]) -> T - """ - Take(self: BlockingCollection[T]) -> T - - Takes an item from the System.Collections.Concurrent.BlockingCollection. - Returns: The item removed from the collection. - Take(self: BlockingCollection[T], cancellationToken: CancellationToken) -> T - - Takes an item from the System.Collections.Concurrent.BlockingCollection. - - cancellationToken: Object that can be used to cancel the take operation. - Returns: The item removed from the collection. - """ - pass - - @staticmethod - def TakeFromAny(collections, item, cancellationToken=None): - # type: (collections: Array[BlockingCollection[T]]) -> (int, T) - """ - TakeFromAny(collections: Array[BlockingCollection[T]]) -> (int, T) - TakeFromAny(collections: Array[BlockingCollection[T]], cancellationToken: CancellationToken) -> (int, T) - """ - pass - - def ToArray(self): - # type: (self: BlockingCollection[T]) -> Array[T] - """ - ToArray(self: BlockingCollection[T]) -> Array[T] - - Copies the items from the System.Collections.Concurrent.BlockingCollection instance into a new array. - Returns: An array containing copies of the elements of the collection. - """ - pass - - def TryAdd(self, item, *__args): - # type: (self: BlockingCollection[T], item: T) -> bool - """ - TryAdd(self: BlockingCollection[T], item: T) -> bool - - Attempts to add the specified item to the System.Collections.Concurrent.BlockingCollection. - - item: The item to be added to the collection. - Returns: true if item could be added; otherwise false. If the item is a duplicate, and the underlying collection does not accept duplicate items, then an System.InvalidOperationException is thrown. - TryAdd(self: BlockingCollection[T], item: T, timeout: TimeSpan) -> bool - - Attempts to add the specified item to the System.Collections.Concurrent.BlockingCollection. - - item: The item to be added to the collection. - timeout: A System.TimeSpan that represents the number of milliseconds to wait, or a System.TimeSpan that represents -1 milliseconds to wait indefinitely. - Returns: true if the item could be added to the collection within the specified time span; otherwise, false. - TryAdd(self: BlockingCollection[T], item: T, millisecondsTimeout: int) -> bool - - Attempts to add the specified item to the System.Collections.Concurrent.BlockingCollection within the specified time period. - - item: The item to be added to the collection. - millisecondsTimeout: The number of milliseconds to wait, or System.Threading.Timeout.Infinite (-1) to wait indefinitely. - Returns: true if the item could be added to the collection within the specified time; otherwise, false. If the item is a duplicate, and the underlying collection does not accept duplicate items, then an System.InvalidOperationException is thrown. - TryAdd(self: BlockingCollection[T], item: T, millisecondsTimeout: int, cancellationToken: CancellationToken) -> bool - - Attempts to add the specified item to the System.Collections.Concurrent.BlockingCollection within the specified time period, while observing a cancellation token. - - item: The item to be added to the collection. - millisecondsTimeout: The number of milliseconds to wait, or System.Threading.Timeout.Infinite (-1) to wait indefinitely. - cancellationToken: A cancellation token to observe. - Returns: true if the item could be added to the collection within the specified time; otherwise, false. If the item is a duplicate, and the underlying collection does not accept duplicate items, then an System.InvalidOperationException is thrown. - """ - pass - - @staticmethod - def TryAddToAny(collections, item, *__args): - # type: (collections: Array[BlockingCollection[T]], item: T) -> int - """ - TryAddToAny(collections: Array[BlockingCollection[T]], item: T) -> int - TryAddToAny(collections: Array[BlockingCollection[T]], item: T, timeout: TimeSpan) -> int - TryAddToAny(collections: Array[BlockingCollection[T]], item: T, millisecondsTimeout: int) -> int - TryAddToAny(collections: Array[BlockingCollection[T]], item: T, millisecondsTimeout: int, cancellationToken: CancellationToken) -> int - """ - pass - - def TryTake(self, item, *__args): - # type: (self: BlockingCollection[T]) -> (bool, T) - """ - TryTake(self: BlockingCollection[T]) -> (bool, T) - TryTake(self: BlockingCollection[T], timeout: TimeSpan) -> (bool, T) - TryTake(self: BlockingCollection[T], millisecondsTimeout: int) -> (bool, T) - TryTake(self: BlockingCollection[T], millisecondsTimeout: int, cancellationToken: CancellationToken) -> (bool, T) - """ - pass - - @staticmethod - def TryTakeFromAny(collections, item, *__args): - # type: (collections: Array[BlockingCollection[T]]) -> (int, T) - """ - TryTakeFromAny(collections: Array[BlockingCollection[T]]) -> (int, T) - TryTakeFromAny(collections: Array[BlockingCollection[T]], timeout: TimeSpan) -> (int, T) - TryTakeFromAny(collections: Array[BlockingCollection[T]], millisecondsTimeout: int) -> (int, T) - TryTakeFromAny(collections: Array[BlockingCollection[T]], millisecondsTimeout: int, cancellationToken: CancellationToken) -> (int, T) - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+yx.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[T](enumerable: IEnumerable[T], value: T) -> bool """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, boundedCapacity: int) - __new__(cls: type, collection: IProducerConsumerCollection[T], boundedCapacity: int) - __new__(cls: type, collection: IProducerConsumerCollection[T]) - """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - BoundedCapacity = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the bounded capacity of this System.Collections.Concurrent.BlockingCollection instance. - - Get: BoundedCapacity(self: BlockingCollection[T]) -> int - """ - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of items contained in the System.Collections.Concurrent.BlockingCollection. - - Get: Count(self: BlockingCollection[T]) -> int - """ - - IsAddingCompleted = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets whether this System.Collections.Concurrent.BlockingCollection has been marked as complete for adding. - - Get: IsAddingCompleted(self: BlockingCollection[T]) -> bool - """ - - IsCompleted = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets whether this System.Collections.Concurrent.BlockingCollection has been marked as complete for adding and is empty. - - Get: IsCompleted(self: BlockingCollection[T]) -> bool - """ - - - -class ConcurrentBag(object, IProducerConsumerCollection[T], IEnumerable[T], IEnumerable, ICollection, IReadOnlyCollection[T]): - # type: () - """ - ConcurrentBag[T]() - ConcurrentBag[T](collection: IEnumerable[T]) - """ - def Add(self, item): - # type: (self: ConcurrentBag[T], item: T) - """ - Add(self: ConcurrentBag[T], item: T) - Adds an object to the System.Collections.Concurrent.ConcurrentBag. - - item: The object to be added to the System.Collections.Concurrent.ConcurrentBag. The value can be a null reference (Nothing in Visual Basic) for reference types. - """ - pass - - def CopyTo(self, array, index): - # type: (self: ConcurrentBag[T], array: Array[T], index: int) - """ CopyTo(self: ConcurrentBag[T], array: Array[T], index: int) """ - pass - - def GetEnumerator(self): - # type: (self: ConcurrentBag[T]) -> IEnumerator[T] - """ - GetEnumerator(self: ConcurrentBag[T]) -> IEnumerator[T] - - Returns an enumerator that iterates through the System.Collections.Concurrent.ConcurrentBag. - Returns: An enumerator for the contents of the System.Collections.Concurrent.ConcurrentBag. - """ - pass - - def ToArray(self): - # type: (self: ConcurrentBag[T]) -> Array[T] - """ - ToArray(self: ConcurrentBag[T]) -> Array[T] - - Copies the System.Collections.Concurrent.ConcurrentBag elements to a new array. - Returns: A new array containing a snapshot of elements copied from the System.Collections.Concurrent.ConcurrentBag. - """ - pass - - def TryPeek(self, result): - # type: (self: ConcurrentBag[T]) -> (bool, T) - """ TryPeek(self: ConcurrentBag[T]) -> (bool, T) """ - pass - - def TryTake(self, result): - # type: (self: ConcurrentBag[T]) -> (bool, T) - """ TryTake(self: ConcurrentBag[T]) -> (bool, T) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[T](enumerable: IEnumerable[T], value: T) -> bool """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, collection=None): - """ - __new__(cls: type) - __new__(cls: type, collection: IEnumerable[T]) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.Concurrent.ConcurrentBag. - - Get: Count(self: ConcurrentBag[T]) -> int - """ - - IsEmpty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the System.Collections.Concurrent.ConcurrentBag is empty. - - Get: IsEmpty(self: ConcurrentBag[T]) -> bool - """ - - - -class ConcurrentDictionary(object, IDictionary[TKey, TValue], ICollection[KeyValuePair[TKey, TValue]], IEnumerable[KeyValuePair[TKey, TValue]], IEnumerable, IDictionary, ICollection, IReadOnlyDictionary[TKey, TValue], IReadOnlyCollection[KeyValuePair[TKey, TValue]]): - # type: (concurrencyLevel: int, capacity: int) - """ - ConcurrentDictionary[TKey, TValue](concurrencyLevel: int, capacity: int) - ConcurrentDictionary[TKey, TValue]() - ConcurrentDictionary[TKey, TValue](collection: IEnumerable[KeyValuePair[TKey, TValue]]) - ConcurrentDictionary[TKey, TValue](comparer: IEqualityComparer[TKey]) - ConcurrentDictionary[TKey, TValue](collection: IEnumerable[KeyValuePair[TKey, TValue]], comparer: IEqualityComparer[TKey]) - ConcurrentDictionary[TKey, TValue](concurrencyLevel: int, collection: IEnumerable[KeyValuePair[TKey, TValue]], comparer: IEqualityComparer[TKey]) - ConcurrentDictionary[TKey, TValue](concurrencyLevel: int, capacity: int, comparer: IEqualityComparer[TKey]) - """ - def AddOrUpdate(self, key, *__args): - # type: (self: ConcurrentDictionary[TKey, TValue], key: TKey, addValueFactory: Func[TKey, TArg, TValue], updateValueFactory: Func[TKey, TValue, TArg, TValue], factoryArgument: TArg) -> TValue - """ - AddOrUpdate[TArg](self: ConcurrentDictionary[TKey, TValue], key: TKey, addValueFactory: Func[TKey, TArg, TValue], updateValueFactory: Func[TKey, TValue, TArg, TValue], factoryArgument: TArg) -> TValue - AddOrUpdate(self: ConcurrentDictionary[TKey, TValue], key: TKey, addValueFactory: Func[TKey, TValue], updateValueFactory: Func[TKey, TValue, TValue]) -> TValue - AddOrUpdate(self: ConcurrentDictionary[TKey, TValue], key: TKey, addValue: TValue, updateValueFactory: Func[TKey, TValue, TValue]) -> TValue - """ - pass - - def Clear(self): - # type: (self: ConcurrentDictionary[TKey, TValue]) - """ - Clear(self: ConcurrentDictionary[TKey, TValue]) - Removes all keys and values from the System.Collections.Concurrent.ConcurrentDictionary. - """ - pass - - def ContainsKey(self, key): - # type: (self: ConcurrentDictionary[TKey, TValue], key: TKey) -> bool - """ - ContainsKey(self: ConcurrentDictionary[TKey, TValue], key: TKey) -> bool - - Determines whether the System.Collections.Concurrent.ConcurrentDictionary contains the specified key. - - key: The key to locate in the System.Collections.Concurrent.ConcurrentDictionary. - Returns: true if the System.Collections.Concurrent.ConcurrentDictionary contains an element with the specified key; otherwise, false. - """ - pass - - def GetEnumerator(self): - # type: (self: ConcurrentDictionary[TKey, TValue]) -> IEnumerator[KeyValuePair[TKey, TValue]] - """ - GetEnumerator(self: ConcurrentDictionary[TKey, TValue]) -> IEnumerator[KeyValuePair[TKey, TValue]] - - Returns an enumerator that iterates through the System.Collections.Concurrent.ConcurrentDictionary. - Returns: An enumerator for the System.Collections.Concurrent.ConcurrentDictionary. - """ - pass - - def GetOrAdd(self, key, *__args): - # type: (self: ConcurrentDictionary[TKey, TValue], key: TKey, valueFactory: Func[TKey, TValue]) -> TValue - """ - GetOrAdd(self: ConcurrentDictionary[TKey, TValue], key: TKey, valueFactory: Func[TKey, TValue]) -> TValue - - Adds a key/value pair to the System.Collections.Concurrent.ConcurrentDictionary if the key does not already exist. - - key: The key of the element to add. - valueFactory: The function used to generate a value for the key - Returns: The value for the key. This will be either the existing value for the key if the key is already in the dictionary, or the new value for the key as returned by valueFactory if the key was not in the dictionary. - GetOrAdd(self: ConcurrentDictionary[TKey, TValue], key: TKey, value: TValue) -> TValue - - Adds a key/value pair to the System.Collections.Concurrent.ConcurrentDictionary if the key does not already exist. - - key: The key of the element to add. - value: the value to be added, if the key does not already exist - Returns: The value for the key. This will be either the existing value for the key if the key is already in the dictionary, or the new value if the key was not in the dictionary. - GetOrAdd[TArg](self: ConcurrentDictionary[TKey, TValue], key: TKey, valueFactory: Func[TKey, TArg, TValue], factoryArgument: TArg) -> TValue - """ - pass - - def ToArray(self): - # type: (self: ConcurrentDictionary[TKey, TValue]) -> Array[KeyValuePair[TKey, TValue]] - """ - ToArray(self: ConcurrentDictionary[TKey, TValue]) -> Array[KeyValuePair[TKey, TValue]] - - Copies the key and value pairs stored in the System.Collections.Concurrent.ConcurrentDictionary to a new array. - Returns: A new array containing a snapshot of key and value pairs copied from the System.Collections.Concurrent.ConcurrentDictionary. - """ - pass - - def TryAdd(self, key, value): - # type: (self: ConcurrentDictionary[TKey, TValue], key: TKey, value: TValue) -> bool - """ - TryAdd(self: ConcurrentDictionary[TKey, TValue], key: TKey, value: TValue) -> bool - - Attempts to add the specified key and value to the System.Collections.Concurrent.ConcurrentDictionary. - - key: The key of the element to add. - value: The value of the element to add. The value can be a null reference (Nothing in Visual Basic) for reference types. - Returns: true if the key/value pair was added to the System.Collections.Concurrent.ConcurrentDictionary successfully. If the key already exists, this method returns false. - """ - pass - - def TryGetValue(self, key, value): - # type: (self: ConcurrentDictionary[TKey, TValue], key: TKey) -> (bool, TValue) - """ TryGetValue(self: ConcurrentDictionary[TKey, TValue], key: TKey) -> (bool, TValue) """ - pass - - def TryRemove(self, key, value): - # type: (self: ConcurrentDictionary[TKey, TValue], key: TKey) -> (bool, TValue) - """ TryRemove(self: ConcurrentDictionary[TKey, TValue], key: TKey) -> (bool, TValue) """ - pass - - def TryUpdate(self, key, newValue, comparisonValue): - # type: (self: ConcurrentDictionary[TKey, TValue], key: TKey, newValue: TValue, comparisonValue: TValue) -> bool - """ - TryUpdate(self: ConcurrentDictionary[TKey, TValue], key: TKey, newValue: TValue, comparisonValue: TValue) -> bool - - Compares the existing value for the specified key with a specified value, and if they are equal, updates the key with a third value. - - key: The key whose value is compared with comparisonValue and possibly replaced. - newValue: The value that replaces the value of the element with key if the comparison results in equality. - comparisonValue: The value that is compared to the value of the element with key. - Returns: true if the value with key was equal to comparisonValue and replaced with newValue; otherwise, false. - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary[TKey, TValue], key: TKey) -> bool - - Determines whether the System.Collections.Generic.IDictionary contains an element with the specified key. - - key: The key to locate in the System.Collections.Generic.IDictionary. - Returns: true if the System.Collections.Generic.IDictionary contains an element with the key; otherwise, false. - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, concurrencyLevel: int, capacity: int) - __new__(cls: type, collection: IEnumerable[KeyValuePair[TKey, TValue]]) - __new__(cls: type, comparer: IEqualityComparer[TKey]) - __new__(cls: type, collection: IEnumerable[KeyValuePair[TKey, TValue]], comparer: IEqualityComparer[TKey]) - __new__(cls: type, concurrencyLevel: int, collection: IEnumerable[KeyValuePair[TKey, TValue]], comparer: IEqualityComparer[TKey]) - __new__(cls: type, concurrencyLevel: int, capacity: int, comparer: IEqualityComparer[TKey]) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of key/value pairs contained in the System.Collections.Concurrent.ConcurrentDictionary. - - Get: Count(self: ConcurrentDictionary[TKey, TValue]) -> int - """ - - IsEmpty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the System.Collections.Concurrent.ConcurrentDictionary is empty. - - Get: IsEmpty(self: ConcurrentDictionary[TKey, TValue]) -> bool - """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection containing the keys in the System.Collections.Generic.Dictionary{TKey,TValue}. - - Get: Keys(self: ConcurrentDictionary[TKey, TValue]) -> ICollection[TKey] - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection containing the values in the System.Collections.Generic.Dictionary{TKey,TValue}. - - Get: Values(self: ConcurrentDictionary[TKey, TValue]) -> ICollection[TValue] - """ - - - -class ConcurrentQueue(object, IProducerConsumerCollection[T], IEnumerable[T], IEnumerable, ICollection, IReadOnlyCollection[T]): - # type: () - """ - ConcurrentQueue[T]() - ConcurrentQueue[T](collection: IEnumerable[T]) - """ - def CopyTo(self, array, index): - # type: (self: ConcurrentQueue[T], array: Array[T], index: int) - """ CopyTo(self: ConcurrentQueue[T], array: Array[T], index: int) """ - pass - - def Enqueue(self, item): - # type: (self: ConcurrentQueue[T], item: T) - """ - Enqueue(self: ConcurrentQueue[T], item: T) - Adds an object to the end of the System.Collections.Concurrent.ConcurrentQueue. - - item: The object to add to the end of the System.Collections.Concurrent.ConcurrentQueue. The value can be a null reference (Nothing in Visual Basic) for reference types. - """ - pass - - def GetEnumerator(self): - # type: (self: ConcurrentQueue[T]) -> IEnumerator[T] - """ - GetEnumerator(self: ConcurrentQueue[T]) -> IEnumerator[T] - - Returns an enumerator that iterates through the System.Collections.Concurrent.ConcurrentQueue. - Returns: An enumerator for the contents of the System.Collections.Concurrent.ConcurrentQueue. - """ - pass - - def ToArray(self): - # type: (self: ConcurrentQueue[T]) -> Array[T] - """ - ToArray(self: ConcurrentQueue[T]) -> Array[T] - - Copies the elements stored in the System.Collections.Concurrent.ConcurrentQueue to a new array. - Returns: A new array containing a snapshot of elements copied from the System.Collections.Concurrent.ConcurrentQueue. - """ - pass - - def TryDequeue(self, result): - # type: (self: ConcurrentQueue[T]) -> (bool, T) - """ TryDequeue(self: ConcurrentQueue[T]) -> (bool, T) """ - pass - - def TryPeek(self, result): - # type: (self: ConcurrentQueue[T]) -> (bool, T) - """ TryPeek(self: ConcurrentQueue[T]) -> (bool, T) """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[T](enumerable: IEnumerable[T], value: T) -> bool """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, collection=None): - """ - __new__(cls: type) - __new__(cls: type, collection: IEnumerable[T]) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.Concurrent.ConcurrentQueue. - - Get: Count(self: ConcurrentQueue[T]) -> int - """ - - IsEmpty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the System.Collections.Concurrent.ConcurrentQueue is empty. - - Get: IsEmpty(self: ConcurrentQueue[T]) -> bool - """ - - - -class ConcurrentStack(object, IProducerConsumerCollection[T], IEnumerable[T], IEnumerable, ICollection, IReadOnlyCollection[T]): - # type: () - """ - ConcurrentStack[T]() - ConcurrentStack[T](collection: IEnumerable[T]) - """ - def Clear(self): - # type: (self: ConcurrentStack[T]) - """ - Clear(self: ConcurrentStack[T]) - Removes all objects from the System.Collections.Concurrent.ConcurrentStack. - """ - pass - - def CopyTo(self, array, index): - # type: (self: ConcurrentStack[T], array: Array[T], index: int) - """ CopyTo(self: ConcurrentStack[T], array: Array[T], index: int) """ - pass - - def GetEnumerator(self): - # type: (self: ConcurrentStack[T]) -> IEnumerator[T] - """ - GetEnumerator(self: ConcurrentStack[T]) -> IEnumerator[T] - - Returns an enumerator that iterates through the System.Collections.Concurrent.ConcurrentStack. - Returns: An enumerator for the System.Collections.Concurrent.ConcurrentStack. - """ - pass - - def Push(self, item): - # type: (self: ConcurrentStack[T], item: T) - """ - Push(self: ConcurrentStack[T], item: T) - Inserts an object at the top of the System.Collections.Concurrent.ConcurrentStack. - - item: The object to push onto the System.Collections.Concurrent.ConcurrentStack. The value can be a null reference (Nothing in Visual Basic) for reference types. - """ - pass - - def PushRange(self, items, startIndex=None, count=None): - # type: (self: ConcurrentStack[T], items: Array[T])PushRange(self: ConcurrentStack[T], items: Array[T], startIndex: int, count: int) - """ PushRange(self: ConcurrentStack[T], items: Array[T])PushRange(self: ConcurrentStack[T], items: Array[T], startIndex: int, count: int) """ - pass - - def ToArray(self): - # type: (self: ConcurrentStack[T]) -> Array[T] - """ - ToArray(self: ConcurrentStack[T]) -> Array[T] - - Copies the items stored in the System.Collections.Concurrent.ConcurrentStack to a new array. - Returns: A new array containing a snapshot of elements copied from the System.Collections.Concurrent.ConcurrentStack. - """ - pass - - def TryPeek(self, result): - # type: (self: ConcurrentStack[T]) -> (bool, T) - """ TryPeek(self: ConcurrentStack[T]) -> (bool, T) """ - pass - - def TryPop(self, result): - # type: (self: ConcurrentStack[T]) -> (bool, T) - """ TryPop(self: ConcurrentStack[T]) -> (bool, T) """ - pass - - def TryPopRange(self, items, startIndex=None, count=None): - # type: (self: ConcurrentStack[T], items: Array[T]) -> int - """ - TryPopRange(self: ConcurrentStack[T], items: Array[T]) -> int - TryPopRange(self: ConcurrentStack[T], items: Array[T], startIndex: int, count: int) -> int - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[T](enumerable: IEnumerable[T], value: T) -> bool """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, collection=None): - """ - __new__(cls: type) - __new__(cls: type, collection: IEnumerable[T]) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.Concurrent.ConcurrentStack. - - Get: Count(self: ConcurrentStack[T]) -> int - """ - - IsEmpty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the System.Collections.Concurrent.ConcurrentStack is empty. - - Get: IsEmpty(self: ConcurrentStack[T]) -> bool - """ - - - -class EnumerablePartitionerOptions(Enum, IComparable, IFormattable, IConvertible): - # type: (flags) EnumerablePartitionerOptions, values: NoBuffering (1), None (0) - """ enum (flags) EnumerablePartitionerOptions, values: NoBuffering (1), None (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - NoBuffering = None - None = None - value__ = None - - -class IProducerConsumerCollection(IEnumerable[T], IEnumerable, ICollection): - # no doc - def CopyTo(self, array, index): - # type: (self: IProducerConsumerCollection[T], array: Array[T], index: int) - """ CopyTo(self: IProducerConsumerCollection[T], array: Array[T], index: int) """ - pass - - def ToArray(self): - # type: (self: IProducerConsumerCollection[T]) -> Array[T] - """ - ToArray(self: IProducerConsumerCollection[T]) -> Array[T] - - Copies the elements contained in the System.Collections.Concurrent.IProducerConsumerCollection to a new array. - Returns: A new array containing the elements copied from the System.Collections.Concurrent.IProducerConsumerCollection. - """ - pass - - def TryAdd(self, item): - # type: (self: IProducerConsumerCollection[T], item: T) -> bool - """ - TryAdd(self: IProducerConsumerCollection[T], item: T) -> bool - - Attempts to add an object to the System.Collections.Concurrent.IProducerConsumerCollection. - - item: The object to add to the System.Collections.Concurrent.IProducerConsumerCollection. - Returns: true if the object was added successfully; otherwise, false. - """ - pass - - def TryTake(self, item): - # type: (self: IProducerConsumerCollection[T]) -> (bool, T) - """ TryTake(self: IProducerConsumerCollection[T]) -> (bool, T) """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[T](enumerable: IEnumerable[T], value: T) -> bool """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - -class OrderablePartitioner(Partitioner[TSource]): - # no doc - def GetDynamicPartitions(self): - # type: (self: OrderablePartitioner[TSource]) -> IEnumerable[TSource] - """ - GetDynamicPartitions(self: OrderablePartitioner[TSource]) -> IEnumerable[TSource] - - Creates an object that can partition the underlying collection into a variable number of partitions. - Returns: An object that can create partitions over the underlying data source. - """ - pass - - def GetOrderableDynamicPartitions(self): - # type: (self: OrderablePartitioner[TSource]) -> IEnumerable[KeyValuePair[Int64, TSource]] - """ - GetOrderableDynamicPartitions(self: OrderablePartitioner[TSource]) -> IEnumerable[KeyValuePair[Int64, TSource]] - - Creates an object that can partition the underlying collection into a variable number of partitions. - Returns: An object that can create partitions over the underlying data source. - """ - pass - - def GetOrderablePartitions(self, partitionCount): - # type: (self: OrderablePartitioner[TSource], partitionCount: int) -> IList[IEnumerator[KeyValuePair[Int64, TSource]]] - """ - GetOrderablePartitions(self: OrderablePartitioner[TSource], partitionCount: int) -> IList[IEnumerator[KeyValuePair[Int64, TSource]]] - - Partitions the underlying collection into the specified number of orderable partitions. - - partitionCount: The number of partitions to create. - Returns: A list containing partitionCount enumerators. - """ - pass - - def GetPartitions(self, partitionCount): - # type: (self: OrderablePartitioner[TSource], partitionCount: int) -> IList[IEnumerator[TSource]] - """ - GetPartitions(self: OrderablePartitioner[TSource], partitionCount: int) -> IList[IEnumerator[TSource]] - - Partitions the underlying collection into the given number of ordered partitions. - - partitionCount: The number of partitions to create. - Returns: A list containing partitionCount enumerators. - """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ __new__(cls: type, keysOrderedInEachPartition: bool, keysOrderedAcrossPartitions: bool, keysNormalized: bool) """ - pass - - KeysNormalized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets whether order keys are normalized. - - Get: KeysNormalized(self: OrderablePartitioner[TSource]) -> bool - """ - - KeysOrderedAcrossPartitions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets whether elements in an earlier partition always come before elements in a later partition. - - Get: KeysOrderedAcrossPartitions(self: OrderablePartitioner[TSource]) -> bool - """ - - KeysOrderedInEachPartition = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets whether elements in each partition are yielded in the order of increasing keys. - - Get: KeysOrderedInEachPartition(self: OrderablePartitioner[TSource]) -> bool - """ - - - diff --git a/pyesapi/stubs/System/Collections/Generic.py b/pyesapi/stubs/System/Collections/Generic.py deleted file mode 100644 index 1bdb1d4..0000000 --- a/pyesapi/stubs/System/Collections/Generic.py +++ /dev/null @@ -1,2726 +0,0 @@ -# encoding: utf-8 -# module System.Collections.Generic calls itself Generic -# from mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class Comparer(object, IComparer, IComparer[T]): - # no doc - def Compare(self, x, y): - # type: (self: Comparer[T], x: T, y: T) -> int - """ - Compare(self: Comparer[T], x: T, y: T) -> int - - When overridden in a derived class, performs a comparison of two objects of the same type and returns a value indicating whether one object is less than, equal to, or greater than the other. - - x: The first object to compare. - y: The second object to compare. - Returns: A signed integer that indicates the relative values of x and y, as shown in the following table.Value Meaning Less than zero x is less than y.Zero x equals y.Greater than zero x is greater than y. - """ - pass - - @staticmethod - def Create(comparison): - # type: (comparison: Comparison[T]) -> Comparer[T] - """ Create(comparison: Comparison[T]) -> Comparer[T] """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - -class Dictionary(object, IDictionary[TKey, TValue], ICollection[KeyValuePair[TKey, TValue]], IEnumerable[KeyValuePair[TKey, TValue]], IEnumerable, IDictionary, ICollection, IReadOnlyDictionary[TKey, TValue], IReadOnlyCollection[KeyValuePair[TKey, TValue]], ISerializable, IDeserializationCallback): - # type: () - """ - Dictionary[TKey, TValue]() - Dictionary[TKey, TValue](capacity: int) - Dictionary[TKey, TValue](comparer: IEqualityComparer[TKey]) - Dictionary[TKey, TValue](capacity: int, comparer: IEqualityComparer[TKey]) - Dictionary[TKey, TValue](dictionary: IDictionary[TKey, TValue], comparer: IEqualityComparer[TKey]) - Dictionary[TKey, TValue](dictionary: IDictionary[TKey, TValue]) - """ - def Add(self, key, value): - # type: (self: Dictionary[TKey, TValue], key: TKey, value: TValue) - """ - Add(self: Dictionary[TKey, TValue], key: TKey, value: TValue) - Adds the specified key and value to the dictionary. - - key: The key of the element to add. - value: The value of the element to add. The value can be null for reference types. - """ - pass - - def Clear(self): - # type: (self: Dictionary[TKey, TValue]) - """ - Clear(self: Dictionary[TKey, TValue]) - Removes all keys and values from the System.Collections.Generic.Dictionary. - """ - pass - - def ContainsKey(self, key): - # type: (self: Dictionary[TKey, TValue], key: TKey) -> bool - """ - ContainsKey(self: Dictionary[TKey, TValue], key: TKey) -> bool - - Determines whether the System.Collections.Generic.Dictionary contains the specified key. - - key: The key to locate in the System.Collections.Generic.Dictionary. - Returns: true if the System.Collections.Generic.Dictionary contains an element with the specified key; otherwise, false. - """ - pass - - def ContainsValue(self, value): - # type: (self: Dictionary[TKey, TValue], value: TValue) -> bool - """ - ContainsValue(self: Dictionary[TKey, TValue], value: TValue) -> bool - - Determines whether the System.Collections.Generic.Dictionary contains a specific value. - - value: The value to locate in the System.Collections.Generic.Dictionary. The value can be null for reference types. - Returns: true if the System.Collections.Generic.Dictionary contains an element with the specified value; otherwise, false. - """ - pass - - def GetEnumerator(self): - # type: (self: Dictionary[TKey, TValue]) -> Enumerator - """ - GetEnumerator(self: Dictionary[TKey, TValue]) -> Enumerator - - Returns an enumerator that iterates through the System.Collections.Generic.Dictionary. - Returns: A System.Collections.Generic.Dictionary structure for the System.Collections.Generic.Dictionary. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: Dictionary[TKey, TValue], info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: Dictionary[TKey, TValue], info: SerializationInfo, context: StreamingContext) - Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.Collections.Generic.Dictionary instance. - - info: A System.Runtime.Serialization.SerializationInfo object that contains the information required to serialize the System.Collections.Generic.Dictionary instance. - context: A System.Runtime.Serialization.StreamingContext structure that contains the source and destination of the serialized stream associated with the System.Collections.Generic.Dictionary instance. - """ - pass - - def OnDeserialization(self, sender): - # type: (self: Dictionary[TKey, TValue], sender: object) - """ - OnDeserialization(self: Dictionary[TKey, TValue], sender: object) - Implements the System.Runtime.Serialization.ISerializable interface and raises the deserialization event when the deserialization is complete. - - sender: The source of the deserialization event. - """ - pass - - def Remove(self, key): - # type: (self: Dictionary[TKey, TValue], key: TKey) -> bool - """ - Remove(self: Dictionary[TKey, TValue], key: TKey) -> bool - - Removes the value with the specified key from the System.Collections.Generic.Dictionary. - - key: The key of the element to remove. - Returns: true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found in the System.Collections.Generic.Dictionary. - """ - pass - - def TryGetValue(self, key, value): - # type: (self: Dictionary[TKey, TValue], key: TKey) -> (bool, TValue) - """ TryGetValue(self: Dictionary[TKey, TValue], key: TKey) -> (bool, TValue) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary[TKey, TValue], key: TKey) -> bool - - Determines whether the System.Collections.Generic.IDictionary contains an element with the specified key. - - key: The key to locate in the System.Collections.Generic.IDictionary. - Returns: true if the System.Collections.Generic.IDictionary contains an element with the key; otherwise, false. - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, capacity: int) - __new__(cls: type, comparer: IEqualityComparer[TKey]) - __new__(cls: type, capacity: int, comparer: IEqualityComparer[TKey]) - __new__(cls: type, dictionary: IDictionary[TKey, TValue]) - __new__(cls: type, dictionary: IDictionary[TKey, TValue], comparer: IEqualityComparer[TKey]) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ - __repr__(self: Dictionary[TKey, TValue]) -> str - __repr__(self: Dictionary[K, V]) -> str - """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Comparer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the System.Collections.Generic.IEqualityComparer that is used to determine equality of keys for the dictionary. - - Get: Comparer(self: Dictionary[TKey, TValue]) -> IEqualityComparer[TKey] - """ - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of key/value pairs contained in the System.Collections.Generic.Dictionary. - - Get: Count(self: Dictionary[TKey, TValue]) -> int - """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection containing the keys in the System.Collections.Generic.Dictionary. - - Get: Keys(self: Dictionary[TKey, TValue]) -> KeyCollection - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection containing the values in the System.Collections.Generic.Dictionary. - - Get: Values(self: Dictionary[TKey, TValue]) -> ValueCollection - """ - - - Enumerator = None - KeyCollection = None - ValueCollection = None - - -class EqualityComparer(object, IEqualityComparer, IEqualityComparer[T]): - # no doc - def Equals(self, *__args): - # type: (self: EqualityComparer[T], x: T, y: T) -> bool - """ - Equals(self: EqualityComparer[T], x: T, y: T) -> bool - - When overridden in a derived class, determines whether two objects of type T are equal. - - x: The first object to compare. - y: The second object to compare. - Returns: true if the specified objects are equal; otherwise, false. - """ - pass - - def GetHashCode(self, obj=None): - # type: (self: EqualityComparer[T], obj: T) -> int - """ - GetHashCode(self: EqualityComparer[T], obj: T) -> int - - When overridden in a derived class, serves as a hash function for the specified object for hashing algorithms and data structures, such as a hash table. - - obj: The object for which to get a hash code. - Returns: A hash code for the specified object. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - -class ICollection(IEnumerable[T], IEnumerable): - # no doc - def Add(self, item): - # type: (self: ICollection[T], item: T) - """ - Add(self: ICollection[T], item: T) - Adds an item to the System.Collections.Generic.ICollection. - - item: The object to add to the System.Collections.Generic.ICollection. - """ - pass - - def Clear(self): - # type: (self: ICollection[T]) - """ - Clear(self: ICollection[T]) - Removes all items from the System.Collections.Generic.ICollection. - """ - pass - - def Contains(self, item): - # type: (self: ICollection[T], item: T) -> bool - """ - Contains(self: ICollection[T], item: T) -> bool - - Determines whether the System.Collections.Generic.ICollection contains a specific value. - - item: The object to locate in the System.Collections.Generic.ICollection. - Returns: true if item is found in the System.Collections.Generic.ICollection; otherwise, false. - """ - pass - - def CopyTo(self, array, arrayIndex): - # type: (self: ICollection[T], array: Array[T], arrayIndex: int) - """ CopyTo(self: ICollection[T], array: Array[T], arrayIndex: int) """ - pass - - def Remove(self, item): - # type: (self: ICollection[T], item: T) -> bool - """ - Remove(self: ICollection[T], item: T) -> bool - - Removes the first occurrence of a specific object from the System.Collections.Generic.ICollection. - - item: The object to remove from the System.Collections.Generic.ICollection. - Returns: true if item was successfully removed from the System.Collections.Generic.ICollection; otherwise, false. This method also returns false if item is not found in the original System.Collections.Generic.ICollection. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[T](enumerable: IEnumerable[T], value: T) -> bool """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.Generic.ICollection. - - Get: Count(self: ICollection[T]) -> int - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.Generic.ICollection is read-only. - - Get: IsReadOnly(self: ICollection[T]) -> bool - """ - - - -class IComparer: - # no doc - def Compare(self, x, y): - # type: (self: IComparer[T], x: T, y: T) -> int - """ - Compare(self: IComparer[T], x: T, y: T) -> int - - Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. - - x: The first object to compare. - y: The second object to compare. - Returns: A signed integer that indicates the relative values of x and y, as shown in the following table.Value Meaning Less than zerox is less than y.Zerox equals y.Greater than zerox is greater than y. - """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IDictionary(ICollection[KeyValuePair[TKey, TValue]], IEnumerable[KeyValuePair[TKey, TValue]], IEnumerable): - # no doc - def Add(self, key, value): - # type: (self: IDictionary[TKey, TValue], key: TKey, value: TValue) - """ - Add(self: IDictionary[TKey, TValue], key: TKey, value: TValue) - Adds an element with the provided key and value to the System.Collections.Generic.IDictionary. - - key: The object to use as the key of the element to add. - value: The object to use as the value of the element to add. - """ - pass - - def ContainsKey(self, key): - # type: (self: IDictionary[TKey, TValue], key: TKey) -> bool - """ - ContainsKey(self: IDictionary[TKey, TValue], key: TKey) -> bool - - Determines whether the System.Collections.Generic.IDictionary contains an element with the specified key. - - key: The key to locate in the System.Collections.Generic.IDictionary. - Returns: true if the System.Collections.Generic.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def Remove(self, key): - # type: (self: IDictionary[TKey, TValue], key: TKey) -> bool - """ - Remove(self: IDictionary[TKey, TValue], key: TKey) -> bool - - Removes the element with the specified key from the System.Collections.Generic.IDictionary. - - key: The key of the element to remove. - Returns: true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original System.Collections.Generic.IDictionary. - """ - pass - - def TryGetValue(self, key, value): - # type: (self: IDictionary[TKey, TValue], key: TKey) -> (bool, TValue) - """ TryGetValue(self: IDictionary[TKey, TValue], key: TKey) -> (bool, TValue) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__(self: ICollection[KeyValuePair[TKey, TValue]], item: KeyValuePair[TKey, TValue]) -> bool """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.Generic.ICollection containing the keys of the System.Collections.Generic.IDictionary. - - Get: Keys(self: IDictionary[TKey, TValue]) -> ICollection[TKey] - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.Generic.ICollection containing the values in the System.Collections.Generic.IDictionary. - - Get: Values(self: IDictionary[TKey, TValue]) -> ICollection[TValue] - """ - - - -class IEnumerable(IEnumerable): - # no doc - def GetEnumerator(self): - # type: (self: IEnumerable[T]) -> IEnumerator[T] - """ - GetEnumerator(self: IEnumerable[T]) -> IEnumerator[T] - - Returns an enumerator that iterates through the collection. - Returns: A System.Collections.Generic.IEnumerator that can be used to iterate through the collection. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IEnumerator(IDisposable, IEnumerator): - # no doc - def next(self, *args): #cannot find CLR method - # type: (self: object) -> object - """ next(self: object) -> object """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__[T](self: IEnumerator[T]) -> object """ - pass - - Current = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the element in the collection at the current position of the enumerator. - - Get: Current(self: IEnumerator[T]) -> T - """ - - - -class IEqualityComparer: - # no doc - def Equals(self, x, y): - # type: (self: IEqualityComparer[T], x: T, y: T) -> bool - """ - Equals(self: IEqualityComparer[T], x: T, y: T) -> bool - - Determines whether the specified objects are equal. - - x: The first object of type T to compare. - y: The second object of type T to compare. - Returns: true if the specified objects are equal; otherwise, false. - """ - pass - - def GetHashCode(self, obj): - # type: (self: IEqualityComparer[T], obj: T) -> int - """ - GetHashCode(self: IEqualityComparer[T], obj: T) -> int - - Returns a hash code for the specified object. - - obj: The System.Object for which a hash code is to be returned. - Returns: A hash code for the specified object. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IList(ICollection[T], IEnumerable[T], IEnumerable): - # no doc - def IndexOf(self, item): - # type: (self: IList[T], item: T) -> int - """ - IndexOf(self: IList[T], item: T) -> int - - Determines the index of a specific item in the System.Collections.Generic.IList. - - item: The object to locate in the System.Collections.Generic.IList. - Returns: The index of item if found in the list; otherwise, -1. - """ - pass - - def Insert(self, index, item): - # type: (self: IList[T], index: int, item: T) - """ - Insert(self: IList[T], index: int, item: T) - Inserts an item to the System.Collections.Generic.IList at the specified index. - - index: The zero-based index at which item should be inserted. - item: The object to insert into the System.Collections.Generic.IList. - """ - pass - - def RemoveAt(self, index): - # type: (self: IList[T], index: int) - """ - RemoveAt(self: IList[T], index: int) - Removes the System.Collections.Generic.IList item at the specified index. - - index: The zero-based index of the item to remove. - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: ICollection[T], item: T) -> bool - - Determines whether the System.Collections.Generic.ICollection contains a specific value. - - item: The object to locate in the System.Collections.Generic.ICollection. - Returns: true if item is found in the System.Collections.Generic.ICollection; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - -class IReadOnlyCollection(IEnumerable[T], IEnumerable): - # no doc - def __contains__(self, *args): #cannot find CLR method - """ __contains__[T](enumerable: IEnumerable[T], value: T) -> bool """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IReadOnlyCollection[T]) -> int - """ Get: Count(self: IReadOnlyCollection[T]) -> int """ - - - -class IReadOnlyDictionary(IReadOnlyCollection[KeyValuePair[TKey, TValue]], IEnumerable[KeyValuePair[TKey, TValue]], IEnumerable): - # no doc - def ContainsKey(self, key): - # type: (self: IReadOnlyDictionary[TKey, TValue], key: TKey) -> bool - """ ContainsKey(self: IReadOnlyDictionary[TKey, TValue], key: TKey) -> bool """ - pass - - def TryGetValue(self, key, value): - # type: (self: IReadOnlyDictionary[TKey, TValue], key: TKey) -> (bool, TValue) - """ TryGetValue(self: IReadOnlyDictionary[TKey, TValue], key: TKey) -> (bool, TValue) """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[KeyValuePair`2](enumerable: IEnumerable[KeyValuePair[TKey, TValue]], value: KeyValuePair[TKey, TValue]) -> bool """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IReadOnlyDictionary[TKey, TValue]) -> IEnumerable[TKey] - """ Get: Keys(self: IReadOnlyDictionary[TKey, TValue]) -> IEnumerable[TKey] """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IReadOnlyDictionary[TKey, TValue]) -> IEnumerable[TValue] - """ Get: Values(self: IReadOnlyDictionary[TKey, TValue]) -> IEnumerable[TValue] """ - - - -class IReadOnlyList(IReadOnlyCollection[T], IEnumerable[T], IEnumerable): - # no doc - def __contains__(self, *args): #cannot find CLR method - """ __contains__[T](enumerable: IEnumerable[T], value: T) -> bool """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - -class ISet(ICollection[T], IEnumerable[T], IEnumerable): - # no doc - def Add(self, item): - # type: (self: ISet[T], item: T) -> bool - """ - Add(self: ISet[T], item: T) -> bool - - Adds an element to the current set and returns a value to indicate if the element was successfully added. - - item: The element to add to the set. - Returns: true if the element is added to the set; false if the element is already in the set. - """ - pass - - def ExceptWith(self, other): - # type: (self: ISet[T], other: IEnumerable[T]) - """ - ExceptWith(self: ISet[T], other: IEnumerable[T]) - Removes all elements in the specified collection from the current set. - - other: The collection of items to remove from the set. - """ - pass - - def IntersectWith(self, other): - # type: (self: ISet[T], other: IEnumerable[T]) - """ - IntersectWith(self: ISet[T], other: IEnumerable[T]) - Modifies the current set so that it contains only elements that are also in a specified collection. - - other: The collection to compare to the current set. - """ - pass - - def IsProperSubsetOf(self, other): - # type: (self: ISet[T], other: IEnumerable[T]) -> bool - """ - IsProperSubsetOf(self: ISet[T], other: IEnumerable[T]) -> bool - - Determines whether the current set is a proper (strict) subset of a specified collection. - - other: The collection to compare to the current set. - Returns: true if the current set is a proper subset of other; otherwise, false. - """ - pass - - def IsProperSupersetOf(self, other): - # type: (self: ISet[T], other: IEnumerable[T]) -> bool - """ - IsProperSupersetOf(self: ISet[T], other: IEnumerable[T]) -> bool - - Determines whether the current set is a proper (strict) superset of a specified collection. - - other: The collection to compare to the current set. - Returns: true if the current set is a proper superset of other; otherwise, false. - """ - pass - - def IsSubsetOf(self, other): - # type: (self: ISet[T], other: IEnumerable[T]) -> bool - """ - IsSubsetOf(self: ISet[T], other: IEnumerable[T]) -> bool - - Determines whether a set is a subset of a specified collection. - - other: The collection to compare to the current set. - Returns: true if the current set is a subset of other; otherwise, false. - """ - pass - - def IsSupersetOf(self, other): - # type: (self: ISet[T], other: IEnumerable[T]) -> bool - """ - IsSupersetOf(self: ISet[T], other: IEnumerable[T]) -> bool - - Determines whether the current set is a superset of a specified collection. - - other: The collection to compare to the current set. - Returns: true if the current set is a superset of other; otherwise, false. - """ - pass - - def Overlaps(self, other): - # type: (self: ISet[T], other: IEnumerable[T]) -> bool - """ - Overlaps(self: ISet[T], other: IEnumerable[T]) -> bool - - Determines whether the current set overlaps with the specified collection. - - other: The collection to compare to the current set. - Returns: true if the current set and other share at least one common element; otherwise, false. - """ - pass - - def SetEquals(self, other): - # type: (self: ISet[T], other: IEnumerable[T]) -> bool - """ - SetEquals(self: ISet[T], other: IEnumerable[T]) -> bool - - Determines whether the current set and the specified collection contain the same elements. - - other: The collection to compare to the current set. - Returns: true if the current set is equal to other; otherwise, false. - """ - pass - - def SymmetricExceptWith(self, other): - # type: (self: ISet[T], other: IEnumerable[T]) - """ - SymmetricExceptWith(self: ISet[T], other: IEnumerable[T]) - Modifies the current set so that it contains only elements that are present either in the current set or in the specified collection, but not both. - - other: The collection to compare to the current set. - """ - pass - - def UnionWith(self, other): - # type: (self: ISet[T], other: IEnumerable[T]) - """ - UnionWith(self: ISet[T], other: IEnumerable[T]) - Modifies the current set so that it contains all elements that are present in both the current set and in the specified collection. - - other: The collection to compare to the current set. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: ICollection[T], item: T) -> bool - - Determines whether the System.Collections.Generic.ICollection contains a specific value. - - item: The object to locate in the System.Collections.Generic.ICollection. - Returns: true if item is found in the System.Collections.Generic.ICollection; otherwise, false. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - -class KeyNotFoundException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when the key specified for accessing an element in a collection does not match any key in the collection. - - KeyNotFoundException() - KeyNotFoundException(message: str) - KeyNotFoundException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class KeyValuePair(object): - # type: (key: TKey, value: TValue) - """ KeyValuePair[TKey, TValue](key: TKey, value: TValue) """ - def ToString(self): - # type: (self: KeyValuePair[TKey, TValue]) -> str - """ - ToString(self: KeyValuePair[TKey, TValue]) -> str - - Returns a string representation of the System.Collections.Generic.KeyValuePair, using the string representations of the key and value. - Returns: A string representation of the System.Collections.Generic.KeyValuePair, which includes the string representations of the key and value. - """ - pass - - @staticmethod # known case of __new__ - def __new__(self, key, value): - """ - __new__[KeyValuePair`2]() -> KeyValuePair[TKey, TValue] - - __new__(cls: type, key: TKey, value: TValue) - """ - pass - - Key = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the key in the key/value pair. - - Get: Key(self: KeyValuePair[TKey, TValue]) -> TKey - """ - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value in the key/value pair. - - Get: Value(self: KeyValuePair[TKey, TValue]) -> TValue - """ - - - -class LinkedList(object, ICollection[T], IEnumerable[T], IEnumerable, ICollection, IReadOnlyCollection[T], ISerializable, IDeserializationCallback): - # type: () - """ - LinkedList[T]() - LinkedList[T](collection: IEnumerable[T]) - """ - def AddAfter(self, node, *__args): - # type: (self: LinkedList[T], node: LinkedListNode[T], newNode: LinkedListNode[T]) - """ - AddAfter(self: LinkedList[T], node: LinkedListNode[T], newNode: LinkedListNode[T]) - Adds the specified new node after the specified existing node in the System.Collections.Generic.LinkedList. - - node: The System.Collections.Generic.LinkedListNode after which to insert newNode. - newNode: The new System.Collections.Generic.LinkedListNode to add to the System.Collections.Generic.LinkedList. - AddAfter(self: LinkedList[T], node: LinkedListNode[T], value: T) -> LinkedListNode[T] - - Adds a new node containing the specified value after the specified existing node in the System.Collections.Generic.LinkedList. - - node: The System.Collections.Generic.LinkedListNode after which to insert a new System.Collections.Generic.LinkedListNode containing value. - value: The value to add to the System.Collections.Generic.LinkedList. - Returns: The new System.Collections.Generic.LinkedListNode containing value. - """ - pass - - def AddBefore(self, node, *__args): - # type: (self: LinkedList[T], node: LinkedListNode[T], value: T) -> LinkedListNode[T] - """ - AddBefore(self: LinkedList[T], node: LinkedListNode[T], value: T) -> LinkedListNode[T] - - Adds a new node containing the specified value before the specified existing node in the System.Collections.Generic.LinkedList. - - node: The System.Collections.Generic.LinkedListNode before which to insert a new System.Collections.Generic.LinkedListNode containing value. - value: The value to add to the System.Collections.Generic.LinkedList. - Returns: The new System.Collections.Generic.LinkedListNode containing value. - AddBefore(self: LinkedList[T], node: LinkedListNode[T], newNode: LinkedListNode[T]) - Adds the specified new node before the specified existing node in the System.Collections.Generic.LinkedList. - - node: The System.Collections.Generic.LinkedListNode before which to insert newNode. - newNode: The new System.Collections.Generic.LinkedListNode to add to the System.Collections.Generic.LinkedList. - """ - pass - - def AddFirst(self, *__args): - # type: (self: LinkedList[T], value: T) -> LinkedListNode[T] - """ - AddFirst(self: LinkedList[T], value: T) -> LinkedListNode[T] - - Adds a new node containing the specified value at the start of the System.Collections.Generic.LinkedList. - - value: The value to add at the start of the System.Collections.Generic.LinkedList. - Returns: The new System.Collections.Generic.LinkedListNode containing value. - AddFirst(self: LinkedList[T], node: LinkedListNode[T]) - Adds the specified new node at the start of the System.Collections.Generic.LinkedList. - - node: The new System.Collections.Generic.LinkedListNode to add at the start of the System.Collections.Generic.LinkedList. - """ - pass - - def AddLast(self, *__args): - # type: (self: LinkedList[T], value: T) -> LinkedListNode[T] - """ - AddLast(self: LinkedList[T], value: T) -> LinkedListNode[T] - - Adds a new node containing the specified value at the end of the System.Collections.Generic.LinkedList. - - value: The value to add at the end of the System.Collections.Generic.LinkedList. - Returns: The new System.Collections.Generic.LinkedListNode containing value. - AddLast(self: LinkedList[T], node: LinkedListNode[T]) - Adds the specified new node at the end of the System.Collections.Generic.LinkedList. - - node: The new System.Collections.Generic.LinkedListNode to add at the end of the System.Collections.Generic.LinkedList. - """ - pass - - def Clear(self): - # type: (self: LinkedList[T]) - """ - Clear(self: LinkedList[T]) - Removes all nodes from the System.Collections.Generic.LinkedList. - """ - pass - - def Contains(self, value): - # type: (self: LinkedList[T], value: T) -> bool - """ - Contains(self: LinkedList[T], value: T) -> bool - - Determines whether a value is in the System.Collections.Generic.LinkedList. - - value: The value to locate in the System.Collections.Generic.LinkedList. The value can be null for reference types. - Returns: true if value is found in the System.Collections.Generic.LinkedList; otherwise, false. - """ - pass - - def CopyTo(self, array, index): - # type: (self: LinkedList[T], array: Array[T], index: int) - """ CopyTo(self: LinkedList[T], array: Array[T], index: int) """ - pass - - def Find(self, value): - # type: (self: LinkedList[T], value: T) -> LinkedListNode[T] - """ - Find(self: LinkedList[T], value: T) -> LinkedListNode[T] - - Finds the first node that contains the specified value. - - value: The value to locate in the System.Collections.Generic.LinkedList. - Returns: The first System.Collections.Generic.LinkedListNode that contains the specified value, if found; otherwise, null. - """ - pass - - def FindLast(self, value): - # type: (self: LinkedList[T], value: T) -> LinkedListNode[T] - """ - FindLast(self: LinkedList[T], value: T) -> LinkedListNode[T] - - Finds the last node that contains the specified value. - - value: The value to locate in the System.Collections.Generic.LinkedList. - Returns: The last System.Collections.Generic.LinkedListNode that contains the specified value, if found; otherwise, null. - """ - pass - - def GetEnumerator(self): - # type: (self: LinkedList[T]) -> Enumerator - """ - GetEnumerator(self: LinkedList[T]) -> Enumerator - - Returns an enumerator that iterates through the System.Collections.Generic.LinkedList. - Returns: An System.Collections.Generic.LinkedList for the System.Collections.Generic.LinkedList. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: LinkedList[T], info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: LinkedList[T], info: SerializationInfo, context: StreamingContext) - Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.Collections.Generic.LinkedList instance. - - info: A System.Runtime.Serialization.SerializationInfo object that contains the information required to serialize the System.Collections.Generic.LinkedList instance. - context: A System.Runtime.Serialization.StreamingContext object that contains the source and destination of the serialized stream associated with the System.Collections.Generic.LinkedList instance. - """ - pass - - def OnDeserialization(self, sender): - # type: (self: LinkedList[T], sender: object) - """ - OnDeserialization(self: LinkedList[T], sender: object) - Implements the System.Runtime.Serialization.ISerializable interface and raises the deserialization event when the deserialization is complete. - - sender: The source of the deserialization event. - """ - pass - - def Remove(self, *__args): - # type: (self: LinkedList[T], value: T) -> bool - """ - Remove(self: LinkedList[T], value: T) -> bool - - Removes the first occurrence of the specified value from the System.Collections.Generic.LinkedList. - - value: The value to remove from the System.Collections.Generic.LinkedList. - Returns: true if the element containing value is successfully removed; otherwise, false. This method also returns false if value was not found in the original System.Collections.Generic.LinkedList. - Remove(self: LinkedList[T], node: LinkedListNode[T]) - Removes the specified node from the System.Collections.Generic.LinkedList. - - node: The System.Collections.Generic.LinkedListNode to remove from the System.Collections.Generic.LinkedList. - """ - pass - - def RemoveFirst(self): - # type: (self: LinkedList[T]) - """ - RemoveFirst(self: LinkedList[T]) - Removes the node at the start of the System.Collections.Generic.LinkedList. - """ - pass - - def RemoveLast(self): - # type: (self: LinkedList[T]) - """ - RemoveLast(self: LinkedList[T]) - Removes the node at the end of the System.Collections.Generic.LinkedList. - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: ICollection[T], item: T) -> bool - - Determines whether the System.Collections.Generic.ICollection contains a specific value. - - item: The object to locate in the System.Collections.Generic.ICollection. - Returns: true if item is found in the System.Collections.Generic.ICollection; otherwise, false. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, collection=None): - """ - __new__(cls: type) - __new__(cls: type, collection: IEnumerable[T]) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of nodes actually contained in the System.Collections.Generic.LinkedList. - - Get: Count(self: LinkedList[T]) -> int - """ - - First = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the first node of the System.Collections.Generic.LinkedList. - - Get: First(self: LinkedList[T]) -> LinkedListNode[T] - """ - - Last = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the last node of the System.Collections.Generic.LinkedList. - - Get: Last(self: LinkedList[T]) -> LinkedListNode[T] - """ - - - Enumerator = None - - -class LinkedListNode(object): - # type: (value: T) - """ LinkedListNode[T](value: T) """ - @staticmethod # known case of __new__ - def __new__(self, value): - """ __new__(cls: type, value: T) """ - pass - - List = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the System.Collections.Generic.LinkedList that the System.Collections.Generic.LinkedListNode belongs to. - - Get: List(self: LinkedListNode[T]) -> LinkedList[T] - """ - - Next = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the next node in the System.Collections.Generic.LinkedList. - - Get: Next(self: LinkedListNode[T]) -> LinkedListNode[T] - """ - - Previous = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the previous node in the System.Collections.Generic.LinkedList. - - Get: Previous(self: LinkedListNode[T]) -> LinkedListNode[T] - """ - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value contained in the node. - - Get: Value(self: LinkedListNode[T]) -> T - - Set: Value(self: LinkedListNode[T]) = value - """ - - - -class List(object, IList[T], ICollection[T], IEnumerable[T], IEnumerable, IList, ICollection, IReadOnlyList[T], IReadOnlyCollection[T]): - # type: () - """ - List[T]() - List[T](capacity: int) - List[T](collection: IEnumerable[T]) - """ - def Add(self, item): - # type: (self: List[T], item: T) - """ - Add(self: List[T], item: T) - Adds an object to the end of the System.Collections.Generic.List. - - item: The object to be added to the end of the System.Collections.Generic.List. The value can be null for reference types. - """ - pass - - def AddRange(self, collection): - # type: (self: List[T], collection: IEnumerable[T]) - """ - AddRange(self: List[T], collection: IEnumerable[T]) - Adds the elements of the specified collection to the end of the System.Collections.Generic.List. - - collection: The collection whose elements should be added to the end of the System.Collections.Generic.List. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type. - """ - pass - - def AsReadOnly(self): - # type: (self: List[T]) -> ReadOnlyCollection[T] - """ - AsReadOnly(self: List[T]) -> ReadOnlyCollection[T] - - Returns a read-only System.Collections.Generic.IList wrapper for the current collection. - Returns: A System.Collections.ObjectModel.ReadOnlyCollection that acts as a read-only wrapper around the current System.Collections.Generic.List. - """ - pass - - def BinarySearch(self, *__args): - # type: (self: List[T], index: int, count: int, item: T, comparer: IComparer[T]) -> int - """ - BinarySearch(self: List[T], index: int, count: int, item: T, comparer: IComparer[T]) -> int - - Searches a range of elements in the sorted System.Collections.Generic.List for an element using the specified comparer and returns the zero-based index of the element. - - index: The zero-based starting index of the range to search. - count: The length of the range to search. - item: The object to locate. The value can be null for reference types. - comparer: The System.Collections.Generic.IComparer implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer. - Returns: The zero-based index of item in the sorted System.Collections.Generic.List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the - bitwise complement of System.Collections.Generic.List. - - BinarySearch(self: List[T], item: T) -> int - - Searches the entire sorted System.Collections.Generic.List for an element using the default comparer and returns the zero-based index of the element. - - item: The object to locate. The value can be null for reference types. - Returns: The zero-based index of item in the sorted System.Collections.Generic.List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the - bitwise complement of System.Collections.Generic.List. - - BinarySearch(self: List[T], item: T, comparer: IComparer[T]) -> int - - Searches the entire sorted System.Collections.Generic.List for an element using the specified comparer and returns the zero-based index of the element. - - item: The object to locate. The value can be null for reference types. - comparer: The System.Collections.Generic.IComparer implementation to use when comparing elements.-or-null to use the default comparer System.Collections.Generic.Comparer. - Returns: The zero-based index of item in the sorted System.Collections.Generic.List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the - bitwise complement of System.Collections.Generic.List. - """ - pass - - def Clear(self): - # type: (self: List[T]) - """ - Clear(self: List[T]) - Removes all elements from the System.Collections.Generic.List. - """ - pass - - def Contains(self, item): - # type: (self: List[T], item: T) -> bool - """ - Contains(self: List[T], item: T) -> bool - - Determines whether an element is in the System.Collections.Generic.List. - - item: The object to locate in the System.Collections.Generic.List. The value can be null for reference types. - Returns: true if item is found in the System.Collections.Generic.List; otherwise, false. - """ - pass - - def ConvertAll(self, converter): - # type: (self: List[T], converter: Converter[T, TOutput]) -> List[TOutput] - """ ConvertAll[TOutput](self: List[T], converter: Converter[T, TOutput]) -> List[TOutput] """ - pass - - def CopyTo(self, *__args): - # type: (self: List[T], index: int, array: Array[T], arrayIndex: int, count: int)CopyTo(self: List[T], array: Array[T])CopyTo(self: List[T], array: Array[T], arrayIndex: int) - """ CopyTo(self: List[T], index: int, array: Array[T], arrayIndex: int, count: int)CopyTo(self: List[T], array: Array[T])CopyTo(self: List[T], array: Array[T], arrayIndex: int) """ - pass - - def Exists(self, match): - # type: (self: List[T], match: Predicate[T]) -> bool - """ - Exists(self: List[T], match: Predicate[T]) -> bool - - Determines whether the System.Collections.Generic.List contains elements that match the conditions defined by the specified predicate. - - match: The System.Predicate delegate that defines the conditions of the elements to search for. - Returns: true if the System.Collections.Generic.List contains one or more elements that match the conditions defined by the specified predicate; otherwise, false. - """ - pass - - def Find(self, match): - # type: (self: List[T], match: Predicate[T]) -> T - """ - Find(self: List[T], match: Predicate[T]) -> T - - Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire System.Collections.Generic.List. - - match: The System.Predicate delegate that defines the conditions of the element to search for. - Returns: The first element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T. - """ - pass - - def FindAll(self, match): - # type: (self: List[T], match: Predicate[T]) -> List[T] - """ - FindAll(self: List[T], match: Predicate[T]) -> List[T] - - Retrieves all the elements that match the conditions defined by the specified predicate. - - match: The System.Predicate delegate that defines the conditions of the elements to search for. - Returns: A System.Collections.Generic.List containing all the elements that match the conditions defined by the specified predicate, if found; otherwise, an empty System.Collections.Generic.List. - """ - pass - - def FindIndex(self, *__args): - # type: (self: List[T], match: Predicate[T]) -> int - """ - FindIndex(self: List[T], match: Predicate[T]) -> int - - Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire System.Collections.Generic.List. - - match: The System.Predicate delegate that defines the conditions of the element to search for. - FindIndex(self: List[T], startIndex: int, match: Predicate[T]) -> int - - Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the System.Collections.Generic.List that extends from the specified index - to the last element. - - - startIndex: The zero-based starting index of the search. - match: The System.Predicate delegate that defines the conditions of the element to search for. - FindIndex(self: List[T], startIndex: int, count: int, match: Predicate[T]) -> int - - Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the System.Collections.Generic.List that starts at the specified index and - contains the specified number of elements. - - - startIndex: The zero-based starting index of the search. - count: The number of elements in the section to search. - match: The System.Predicate delegate that defines the conditions of the element to search for. - """ - pass - - def FindLast(self, match): - # type: (self: List[T], match: Predicate[T]) -> T - """ - FindLast(self: List[T], match: Predicate[T]) -> T - - Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire System.Collections.Generic.List. - - match: The System.Predicate delegate that defines the conditions of the element to search for. - Returns: The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T. - """ - pass - - def FindLastIndex(self, *__args): - # type: (self: List[T], match: Predicate[T]) -> int - """ - FindLastIndex(self: List[T], match: Predicate[T]) -> int - - Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire System.Collections.Generic.List. - - match: The System.Predicate delegate that defines the conditions of the element to search for. - FindLastIndex(self: List[T], startIndex: int, match: Predicate[T]) -> int - - Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the System.Collections.Generic.List that extends from the first element to - the specified index. - - - startIndex: The zero-based starting index of the backward search. - match: The System.Predicate delegate that defines the conditions of the element to search for. - FindLastIndex(self: List[T], startIndex: int, count: int, match: Predicate[T]) -> int - - Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the range of elements in the System.Collections.Generic.List that contains the specified number of - elements and ends at the specified index. - - - startIndex: The zero-based starting index of the backward search. - count: The number of elements in the section to search. - match: The System.Predicate delegate that defines the conditions of the element to search for. - """ - pass - - def ForEach(self, action): - # type: (self: List[T], action: Action[T]) - """ - ForEach(self: List[T], action: Action[T]) - Performs the specified action on each element of the System.Collections.Generic.List. - - action: The System.Action delegate to perform on each element of the System.Collections.Generic.List. - """ - pass - - def GetEnumerator(self): - # type: (self: List[T]) -> Enumerator - """ - GetEnumerator(self: List[T]) -> Enumerator - - Returns an enumerator that iterates through the System.Collections.Generic.List. - Returns: A System.Collections.Generic.List for the System.Collections.Generic.List. - """ - pass - - def GetRange(self, index, count): - # type: (self: List[T], index: int, count: int) -> List[T] - """ - GetRange(self: List[T], index: int, count: int) -> List[T] - - Creates a shallow copy of a range of elements in the source System.Collections.Generic.List. - - index: The zero-based System.Collections.Generic.List index at which the range starts. - count: The number of elements in the range. - Returns: A shallow copy of a range of elements in the source System.Collections.Generic.List. - """ - pass - - def IndexOf(self, item, index=None, count=None): - # type: (self: List[T], item: T) -> int - """ - IndexOf(self: List[T], item: T) -> int - - Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.Generic.List. - - item: The object to locate in the System.Collections.Generic.List. The value can be null for reference types. - IndexOf(self: List[T], item: T, index: int) -> int - - Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the System.Collections.Generic.List that extends from the specified index to the last element. - - item: The object to locate in the System.Collections.Generic.List. The value can be null for reference types. - index: The zero-based starting index of the search. 0 (zero) is valid in an empty list. - IndexOf(self: List[T], item: T, index: int, count: int) -> int - - Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the System.Collections.Generic.List that starts at the specified index and contains the specified number of elements. - - item: The object to locate in the System.Collections.Generic.List. The value can be null for reference types. - index: The zero-based starting index of the search. 0 (zero) is valid in an empty list. - count: The number of elements in the section to search. - """ - pass - - def Insert(self, index, item): - # type: (self: List[T], index: int, item: T) - """ - Insert(self: List[T], index: int, item: T) - Inserts an element into the System.Collections.Generic.List at the specified index. - - index: The zero-based index at which item should be inserted. - item: The object to insert. The value can be null for reference types. - """ - pass - - def InsertRange(self, index, collection): - # type: (self: List[T], index: int, collection: IEnumerable[T]) - """ - InsertRange(self: List[T], index: int, collection: IEnumerable[T]) - Inserts the elements of a collection into the System.Collections.Generic.List at the specified index. - - index: The zero-based index at which the new elements should be inserted. - collection: The collection whose elements should be inserted into the System.Collections.Generic.List. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type. - """ - pass - - def LastIndexOf(self, item, index=None, count=None): - # type: (self: List[T], item: T) -> int - """ - LastIndexOf(self: List[T], item: T) -> int - - Searches for the specified object and returns the zero-based index of the last occurrence within the entire System.Collections.Generic.List. - - item: The object to locate in the System.Collections.Generic.List. The value can be null for reference types. - LastIndexOf(self: List[T], item: T, index: int) -> int - - Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the System.Collections.Generic.List that extends from the first element to the specified index. - - item: The object to locate in the System.Collections.Generic.List. The value can be null for reference types. - index: The zero-based starting index of the backward search. - LastIndexOf(self: List[T], item: T, index: int, count: int) -> int - - Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the System.Collections.Generic.List that contains the specified number of elements and ends at the specified index. - - item: The object to locate in the System.Collections.Generic.List. The value can be null for reference types. - index: The zero-based starting index of the backward search. - count: The number of elements in the section to search. - """ - pass - - def Remove(self, item): - # type: (self: List[T], item: T) -> bool - """ - Remove(self: List[T], item: T) -> bool - - Removes the first occurrence of a specific object from the System.Collections.Generic.List. - - item: The object to remove from the System.Collections.Generic.List. The value can be null for reference types. - Returns: true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the System.Collections.Generic.List. - """ - pass - - def RemoveAll(self, match): - # type: (self: List[T], match: Predicate[T]) -> int - """ - RemoveAll(self: List[T], match: Predicate[T]) -> int - - Removes all the elements that match the conditions defined by the specified predicate. - - match: The System.Predicate delegate that defines the conditions of the elements to remove. - Returns: The number of elements removed from the System.Collections.Generic.List . - """ - pass - - def RemoveAt(self, index): - # type: (self: List[T], index: int) - """ - RemoveAt(self: List[T], index: int) - Removes the element at the specified index of the System.Collections.Generic.List. - - index: The zero-based index of the element to remove. - """ - pass - - def RemoveRange(self, index, count): - # type: (self: List[T], index: int, count: int) - """ - RemoveRange(self: List[T], index: int, count: int) - Removes a range of elements from the System.Collections.Generic.List. - - index: The zero-based starting index of the range of elements to remove. - count: The number of elements to remove. - """ - pass - - def Reverse(self, index=None, count=None): - # type: (self: List[T], index: int, count: int) - """ - Reverse(self: List[T], index: int, count: int) - Reverses the order of the elements in the specified range. - - index: The zero-based starting index of the range to reverse. - count: The number of elements in the range to reverse. - Reverse(self: List[T]) - Reverses the order of the elements in the entire System.Collections.Generic.List. - """ - pass - - def Sort(self, *__args): - # type: (self: List[T]) - """ - Sort(self: List[T]) - Sorts the elements in the entire System.Collections.Generic.List using the default comparer. - Sort(self: List[T], comparer: IComparer[T]) - Sorts the elements in the entire System.Collections.Generic.List using the specified comparer. - - comparer: The System.Collections.Generic.IComparer implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer. - Sort(self: List[T], index: int, count: int, comparer: IComparer[T]) - Sorts the elements in a range of elements in System.Collections.Generic.List using the specified comparer. - - index: The zero-based starting index of the range to sort. - count: The length of the range to sort. - comparer: The System.Collections.Generic.IComparer implementation to use when comparing elements, or null to use the default comparer System.Collections.Generic.Comparer. - Sort(self: List[T], comparison: Comparison[T]) - Sorts the elements in the entire System.Collections.Generic.List using the specified System.Comparison. - - comparison: The System.Comparison to use when comparing elements. - """ - pass - - def ToArray(self): - # type: (self: List[T]) -> Array[T] - """ - ToArray(self: List[T]) -> Array[T] - - Copies the elements of the System.Collections.Generic.List to a new array. - Returns: An array containing copies of the elements of the System.Collections.Generic.List. - """ - pass - - def TrimExcess(self): - # type: (self: List[T]) - """ - TrimExcess(self: List[T]) - Sets the capacity to the actual number of elements in the System.Collections.Generic.List, if that number is less than a threshold value. - """ - pass - - def TrueForAll(self, match): - # type: (self: List[T], match: Predicate[T]) -> bool - """ - TrueForAll(self: List[T], match: Predicate[T]) -> bool - - Determines whether every element in the System.Collections.Generic.List matches the conditions defined by the specified predicate. - - match: The System.Predicate delegate that defines the conditions to check against the elements. - Returns: true if every element in the System.Collections.Generic.List matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: ICollection[T], item: T) -> bool - - Determines whether the System.Collections.Generic.ICollection contains a specific value. - - item: The object to locate in the System.Collections.Generic.ICollection. - Returns: true if item is found in the System.Collections.Generic.ICollection; otherwise, false. - __contains__(self: IList, value: object) -> bool - - Determines whether the System.Collections.IList contains a specific value. - - value: The object to locate in the System.Collections.IList. - Returns: true if the System.Object is found in the System.Collections.IList; otherwise, false. - """ - pass - - def __delitem__(self, *args): #cannot find CLR method - """ x.__delitem__(y) <==> del x[y]x.__delitem__(y) <==> del x[y]x.__delitem__(y) <==> del x[y] """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __getslice__(self, *args): #cannot find CLR method - """ - __getslice__(self: List[T], x: int, y: int) -> List[T] - __getslice__(self: List[T], x: int, y: int) -> List[T] - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, capacity: int) - __new__(cls: type, collection: IEnumerable[T]) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ - __repr__(self: List[T]) -> str - __repr__(self: List[T]) -> str - """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Capacity = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the total number of elements the internal data structure can hold without resizing. - - Get: Capacity(self: List[T]) -> int - - Set: Capacity(self: List[T]) = value - """ - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements actually contained in the System.Collections.Generic.List. - - Get: Count(self: List[T]) -> int - """ - - - Enumerator = None - - -class Queue(object, IEnumerable[T], IEnumerable, ICollection, IReadOnlyCollection[T]): - # type: () - """ - Queue[T]() - Queue[T](capacity: int) - Queue[T](collection: IEnumerable[T]) - """ - def Clear(self): - # type: (self: Queue[T]) - """ - Clear(self: Queue[T]) - Removes all objects from the System.Collections.Generic.Queue. - """ - pass - - def Contains(self, item): - # type: (self: Queue[T], item: T) -> bool - """ - Contains(self: Queue[T], item: T) -> bool - - Determines whether an element is in the System.Collections.Generic.Queue. - - item: The object to locate in the System.Collections.Generic.Queue. The value can be null for reference types. - Returns: true if item is found in the System.Collections.Generic.Queue; otherwise, false. - """ - pass - - def CopyTo(self, array, arrayIndex): - # type: (self: Queue[T], array: Array[T], arrayIndex: int) - """ CopyTo(self: Queue[T], array: Array[T], arrayIndex: int) """ - pass - - def Dequeue(self): - # type: (self: Queue[T]) -> T - """ - Dequeue(self: Queue[T]) -> T - - Removes and returns the object at the beginning of the System.Collections.Generic.Queue. - Returns: The object that is removed from the beginning of the System.Collections.Generic.Queue. - """ - pass - - def Enqueue(self, item): - # type: (self: Queue[T], item: T) - """ - Enqueue(self: Queue[T], item: T) - Adds an object to the end of the System.Collections.Generic.Queue. - - item: The object to add to the System.Collections.Generic.Queue. The value can be null for reference types. - """ - pass - - def GetEnumerator(self): - # type: (self: Queue[T]) -> Enumerator - """ - GetEnumerator(self: Queue[T]) -> Enumerator - - Returns an enumerator that iterates through the System.Collections.Generic.Queue. - Returns: An System.Collections.Generic.Queue for the System.Collections.Generic.Queue. - """ - pass - - def Peek(self): - # type: (self: Queue[T]) -> T - """ - Peek(self: Queue[T]) -> T - - Returns the object at the beginning of the System.Collections.Generic.Queue without removing it. - Returns: The object at the beginning of the System.Collections.Generic.Queue. - """ - pass - - def ToArray(self): - # type: (self: Queue[T]) -> Array[T] - """ - ToArray(self: Queue[T]) -> Array[T] - - Copies the System.Collections.Generic.Queue elements to a new array. - Returns: A new array containing elements copied from the System.Collections.Generic.Queue. - """ - pass - - def TrimExcess(self): - # type: (self: Queue[T]) - """ - TrimExcess(self: Queue[T]) - Sets the capacity to the actual number of elements in the System.Collections.Generic.Queue, if that number is less than 90 percent of current capacity. - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[T](enumerable: IEnumerable[T], value: T) -> bool """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, capacity: int) - __new__(cls: type, collection: IEnumerable[T]) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.Generic.Queue. - - Get: Count(self: Queue[T]) -> int - """ - - - Enumerator = None - - -class SortedDictionary(object, IDictionary[TKey, TValue], ICollection[KeyValuePair[TKey, TValue]], IEnumerable[KeyValuePair[TKey, TValue]], IEnumerable, IDictionary, ICollection, IReadOnlyDictionary[TKey, TValue], IReadOnlyCollection[KeyValuePair[TKey, TValue]]): - # type: () - """ - SortedDictionary[TKey, TValue]() - SortedDictionary[TKey, TValue](comparer: IComparer[TKey]) - SortedDictionary[TKey, TValue](dictionary: IDictionary[TKey, TValue]) - SortedDictionary[TKey, TValue](dictionary: IDictionary[TKey, TValue], comparer: IComparer[TKey]) - """ - def Add(self, key, value): - # type: (self: SortedDictionary[TKey, TValue], key: TKey, value: TValue) - """ - Add(self: SortedDictionary[TKey, TValue], key: TKey, value: TValue) - Adds an element with the specified key and value into the System.Collections.Generic.SortedDictionary. - - key: The key of the element to add. - value: The value of the element to add. The value can be null for reference types. - """ - pass - - def Clear(self): - # type: (self: SortedDictionary[TKey, TValue]) - """ - Clear(self: SortedDictionary[TKey, TValue]) - Removes all elements from the System.Collections.Generic.SortedDictionary. - """ - pass - - def ContainsKey(self, key): - # type: (self: SortedDictionary[TKey, TValue], key: TKey) -> bool - """ - ContainsKey(self: SortedDictionary[TKey, TValue], key: TKey) -> bool - - Determines whether the System.Collections.Generic.SortedDictionary contains an element with the specified key. - - key: The key to locate in the System.Collections.Generic.SortedDictionary. - Returns: true if the System.Collections.Generic.SortedDictionary contains an element with the specified key; otherwise, false. - """ - pass - - def ContainsValue(self, value): - # type: (self: SortedDictionary[TKey, TValue], value: TValue) -> bool - """ - ContainsValue(self: SortedDictionary[TKey, TValue], value: TValue) -> bool - - Determines whether the System.Collections.Generic.SortedDictionary contains an element with the specified value. - - value: The value to locate in the System.Collections.Generic.SortedDictionary. The value can be null for reference types. - Returns: true if the System.Collections.Generic.SortedDictionary contains an element with the specified value; otherwise, false. - """ - pass - - def CopyTo(self, array, index): - # type: (self: SortedDictionary[TKey, TValue], array: Array[KeyValuePair[TKey, TValue]], index: int) - """ CopyTo(self: SortedDictionary[TKey, TValue], array: Array[KeyValuePair[TKey, TValue]], index: int) """ - pass - - def GetEnumerator(self): - # type: (self: SortedDictionary[TKey, TValue]) -> Enumerator - """ - GetEnumerator(self: SortedDictionary[TKey, TValue]) -> Enumerator - - Returns an enumerator that iterates through the System.Collections.Generic.SortedDictionary. - Returns: A System.Collections.Generic.SortedDictionary for the System.Collections.Generic.SortedDictionary. - """ - pass - - def Remove(self, key): - # type: (self: SortedDictionary[TKey, TValue], key: TKey) -> bool - """ - Remove(self: SortedDictionary[TKey, TValue], key: TKey) -> bool - - Removes the element with the specified key from the System.Collections.Generic.SortedDictionary. - - key: The key of the element to remove. - Returns: true if the element is successfully removed; otherwise, false. This method also returns false if key is not found in the System.Collections.Generic.SortedDictionary. - """ - pass - - def TryGetValue(self, key, value): - # type: (self: SortedDictionary[TKey, TValue], key: TKey) -> (bool, TValue) - """ TryGetValue(self: SortedDictionary[TKey, TValue], key: TKey) -> (bool, TValue) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary[TKey, TValue], key: TKey) -> bool - - Determines whether the System.Collections.Generic.IDictionary contains an element with the specified key. - - key: The key to locate in the System.Collections.Generic.IDictionary. - Returns: true if the System.Collections.Generic.IDictionary contains an element with the key; otherwise, false. - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, dictionary: IDictionary[TKey, TValue]) - __new__(cls: type, dictionary: IDictionary[TKey, TValue], comparer: IComparer[TKey]) - __new__(cls: type, comparer: IComparer[TKey]) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Comparer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the System.Collections.Generic.IComparer used to order the elements of the System.Collections.Generic.SortedDictionary. - - Get: Comparer(self: SortedDictionary[TKey, TValue]) -> IComparer[TKey] - """ - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of key/value pairs contained in the System.Collections.Generic.SortedDictionary. - - Get: Count(self: SortedDictionary[TKey, TValue]) -> int - """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection containing the keys in the System.Collections.Generic.SortedDictionary. - - Get: Keys(self: SortedDictionary[TKey, TValue]) -> KeyCollection - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection containing the values in the System.Collections.Generic.SortedDictionary. - - Get: Values(self: SortedDictionary[TKey, TValue]) -> ValueCollection - """ - - - Enumerator = None - KeyCollection = None - ValueCollection = None - - -class SortedList(object, IDictionary[TKey, TValue], ICollection[KeyValuePair[TKey, TValue]], IEnumerable[KeyValuePair[TKey, TValue]], IEnumerable, IDictionary, ICollection, IReadOnlyDictionary[TKey, TValue], IReadOnlyCollection[KeyValuePair[TKey, TValue]]): - # type: () - """ - SortedList[TKey, TValue]() - SortedList[TKey, TValue](capacity: int) - SortedList[TKey, TValue](comparer: IComparer[TKey]) - SortedList[TKey, TValue](capacity: int, comparer: IComparer[TKey]) - SortedList[TKey, TValue](dictionary: IDictionary[TKey, TValue]) - SortedList[TKey, TValue](dictionary: IDictionary[TKey, TValue], comparer: IComparer[TKey]) - """ - def Add(self, key, value): - # type: (self: SortedList[TKey, TValue], key: TKey, value: TValue) - """ - Add(self: SortedList[TKey, TValue], key: TKey, value: TValue) - Adds an element with the specified key and value into the System.Collections.Generic.SortedList. - - key: The key of the element to add. - value: The value of the element to add. The value can be null for reference types. - """ - pass - - def Clear(self): - # type: (self: SortedList[TKey, TValue]) - """ - Clear(self: SortedList[TKey, TValue]) - Removes all elements from the System.Collections.Generic.SortedList. - """ - pass - - def ContainsKey(self, key): - # type: (self: SortedList[TKey, TValue], key: TKey) -> bool - """ - ContainsKey(self: SortedList[TKey, TValue], key: TKey) -> bool - - Determines whether the System.Collections.Generic.SortedList contains a specific key. - - key: The key to locate in the System.Collections.Generic.SortedList. - Returns: true if the System.Collections.Generic.SortedList contains an element with the specified key; otherwise, false. - """ - pass - - def ContainsValue(self, value): - # type: (self: SortedList[TKey, TValue], value: TValue) -> bool - """ - ContainsValue(self: SortedList[TKey, TValue], value: TValue) -> bool - - Determines whether the System.Collections.Generic.SortedList contains a specific value. - - value: The value to locate in the System.Collections.Generic.SortedList. The value can be null for reference types. - Returns: true if the System.Collections.Generic.SortedList contains an element with the specified value; otherwise, false. - """ - pass - - def GetEnumerator(self): - # type: (self: SortedList[TKey, TValue]) -> IEnumerator[KeyValuePair[TKey, TValue]] - """ - GetEnumerator(self: SortedList[TKey, TValue]) -> IEnumerator[KeyValuePair[TKey, TValue]] - - Returns an enumerator that iterates through the System.Collections.Generic.SortedList. - Returns: An System.Collections.Generic.IEnumerator of type System.Collections.Generic.KeyValuePair for the System.Collections.Generic.SortedList. - """ - pass - - def IndexOfKey(self, key): - # type: (self: SortedList[TKey, TValue], key: TKey) -> int - """ - IndexOfKey(self: SortedList[TKey, TValue], key: TKey) -> int - - Searches for the specified key and returns the zero-based index within the entire System.Collections.Generic.SortedList. - - key: The key to locate in the System.Collections.Generic.SortedList. - Returns: The zero-based index of key within the entire System.Collections.Generic.SortedList, if found; otherwise, -1. - """ - pass - - def IndexOfValue(self, value): - # type: (self: SortedList[TKey, TValue], value: TValue) -> int - """ - IndexOfValue(self: SortedList[TKey, TValue], value: TValue) -> int - - Searches for the specified value and returns the zero-based index of the first occurrence within the entire System.Collections.Generic.SortedList. - - value: The value to locate in the System.Collections.Generic.SortedList. The value can be null for reference types. - Returns: The zero-based index of the first occurrence of value within the entire System.Collections.Generic.SortedList, if found; otherwise, -1. - """ - pass - - def Remove(self, key): - # type: (self: SortedList[TKey, TValue], key: TKey) -> bool - """ - Remove(self: SortedList[TKey, TValue], key: TKey) -> bool - - Removes the element with the specified key from the System.Collections.Generic.SortedList. - - key: The key of the element to remove. - Returns: true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original System.Collections.Generic.SortedList. - """ - pass - - def RemoveAt(self, index): - # type: (self: SortedList[TKey, TValue], index: int) - """ - RemoveAt(self: SortedList[TKey, TValue], index: int) - Removes the element at the specified index of the System.Collections.Generic.SortedList. - - index: The zero-based index of the element to remove. - """ - pass - - def TrimExcess(self): - # type: (self: SortedList[TKey, TValue]) - """ - TrimExcess(self: SortedList[TKey, TValue]) - Sets the capacity to the actual number of elements in the System.Collections.Generic.SortedList, if that number is less than 90 percent of current capacity. - """ - pass - - def TryGetValue(self, key, value): - # type: (self: SortedList[TKey, TValue], key: TKey) -> (bool, TValue) - """ TryGetValue(self: SortedList[TKey, TValue], key: TKey) -> (bool, TValue) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary[TKey, TValue], key: TKey) -> bool - - Determines whether the System.Collections.Generic.IDictionary contains an element with the specified key. - - key: The key to locate in the System.Collections.Generic.IDictionary. - Returns: true if the System.Collections.Generic.IDictionary contains an element with the key; otherwise, false. - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, capacity: int) - __new__(cls: type, comparer: IComparer[TKey]) - __new__(cls: type, capacity: int, comparer: IComparer[TKey]) - __new__(cls: type, dictionary: IDictionary[TKey, TValue]) - __new__(cls: type, dictionary: IDictionary[TKey, TValue], comparer: IComparer[TKey]) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Capacity = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the number of elements that the System.Collections.Generic.SortedList can contain. - - Get: Capacity(self: SortedList[TKey, TValue]) -> int - - Set: Capacity(self: SortedList[TKey, TValue]) = value - """ - - Comparer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the System.Collections.Generic.IComparer for the sorted list. - - Get: Comparer(self: SortedList[TKey, TValue]) -> IComparer[TKey] - """ - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of key/value pairs contained in the System.Collections.Generic.SortedList. - - Get: Count(self: SortedList[TKey, TValue]) -> int - """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection containing the keys in the System.Collections.Generic.SortedList. - - Get: Keys(self: SortedList[TKey, TValue]) -> IList[TKey] - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection containing the values in the System.Collections.Generic.SortedList. - - Get: Values(self: SortedList[TKey, TValue]) -> IList[TValue] - """ - - - -class SortedSet(object, ISet[T], ICollection[T], IEnumerable[T], IEnumerable, ICollection, ISerializable, IDeserializationCallback, IReadOnlyCollection[T]): - # type: () - """ - SortedSet[T]() - SortedSet[T](collection: IEnumerable[T]) - SortedSet[T](collection: IEnumerable[T], comparer: IComparer[T]) - SortedSet[T](comparer: IComparer[T]) - """ - def Add(self, item): - # type: (self: SortedSet[T], item: T) -> bool - """ - Add(self: SortedSet[T], item: T) -> bool - - Adds an element to the set and returns a value that indicates if it was successfully added. - - item: The element to add to the set. - Returns: true if item is added to the set; otherwise, false. - """ - pass - - def Clear(self): - # type: (self: SortedSet[T]) - """ - Clear(self: SortedSet[T]) - Removes all elements from the set. - """ - pass - - def Contains(self, item): - # type: (self: SortedSet[T], item: T) -> bool - """ - Contains(self: SortedSet[T], item: T) -> bool - - Determines whether the set contains a specific element. - - item: The element to locate in the set. - Returns: true if the set contains item; otherwise, false. - """ - pass - - def CopyTo(self, array, index=None, count=None): - # type: (self: SortedSet[T], array: Array[T])CopyTo(self: SortedSet[T], array: Array[T], index: int)CopyTo(self: SortedSet[T], array: Array[T], index: int, count: int) - """ CopyTo(self: SortedSet[T], array: Array[T])CopyTo(self: SortedSet[T], array: Array[T], index: int)CopyTo(self: SortedSet[T], array: Array[T], index: int, count: int) """ - pass - - @staticmethod - def CreateSetComparer(memberEqualityComparer=None): - # type: () -> IEqualityComparer[SortedSet[T]] - """ - CreateSetComparer() -> IEqualityComparer[SortedSet[T]] - - Returns an System.Collections.IEqualityComparer object that can be used to create a collection that contains individual sets. - Returns: A comparer for creating a collection of sets. - CreateSetComparer(memberEqualityComparer: IEqualityComparer[T]) -> IEqualityComparer[SortedSet[T]] - - Returns an System.Collections.IEqualityComparer object, according to a specified comparer, that can be used to create a collection that contains individual sets. - - memberEqualityComparer: The comparer to use for creating the returned comparer. - Returns: A comparer for creating a collection of sets. - """ - pass - - def ExceptWith(self, other): - # type: (self: SortedSet[T], other: IEnumerable[T]) - """ - ExceptWith(self: SortedSet[T], other: IEnumerable[T]) - Removes all elements that are in a specified collection from the current System.Collections.Generic.SortedSet object. - - other: The collection of items to remove from the System.Collections.Generic.SortedSet object. - """ - pass - - def GetEnumerator(self): - # type: (self: SortedSet[T]) -> Enumerator - """ - GetEnumerator(self: SortedSet[T]) -> Enumerator - - Returns an enumerator that iterates through the System.Collections.Generic.SortedSet. - Returns: An enumerator that iterates through the System.Collections.Generic.SortedSet. - """ - pass - - def GetObjectData(self, *args): #cannot find CLR method - # type: (self: SortedSet[T], info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: SortedSet[T], info: SerializationInfo, context: StreamingContext) - Implements the System.Runtime.Serialization.ISerializable interface and returns the data that you must have to serialize a System.Collections.Generic.SortedSet object. - - info: A System.Runtime.Serialization.SerializationInfo object that contains the information that is required to serialize the System.Collections.Generic.SortedSet object. - context: A System.Runtime.Serialization.StreamingContext structure that contains the source and destination of the serialized stream associated with the System.Collections.Generic.SortedSet object. - """ - pass - - def GetViewBetween(self, lowerValue, upperValue): - # type: (self: SortedSet[T], lowerValue: T, upperValue: T) -> SortedSet[T] - """ - GetViewBetween(self: SortedSet[T], lowerValue: T, upperValue: T) -> SortedSet[T] - - Returns a view of a subset in a System.Collections.Generic.SortedSet. - - lowerValue: The lowest desired value in the view. - upperValue: The highest desired value in the view. - Returns: A subset view that contains only the values in the specified range. - """ - pass - - def IntersectWith(self, other): - # type: (self: SortedSet[T], other: IEnumerable[T]) - """ - IntersectWith(self: SortedSet[T], other: IEnumerable[T]) - Modifies the current System.Collections.Generic.SortedSet object so that it contains only elements that are also in a specified collection. - - other: The collection to compare to the current System.Collections.Generic.SortedSet object. - """ - pass - - def IsProperSubsetOf(self, other): - # type: (self: SortedSet[T], other: IEnumerable[T]) -> bool - """ - IsProperSubsetOf(self: SortedSet[T], other: IEnumerable[T]) -> bool - - Determines whether a System.Collections.Generic.SortedSet object is a proper subset of the specified collection. - - other: The collection to compare to the current System.Collections.Generic.SortedSet object. - Returns: true if the System.Collections.Generic.SortedSet object is a proper subset of other; otherwise, false. - """ - pass - - def IsProperSupersetOf(self, other): - # type: (self: SortedSet[T], other: IEnumerable[T]) -> bool - """ - IsProperSupersetOf(self: SortedSet[T], other: IEnumerable[T]) -> bool - - Determines whether a System.Collections.Generic.SortedSet object is a proper superset of the specified collection. - - other: The collection to compare to the current System.Collections.Generic.SortedSet object. - Returns: true if the System.Collections.Generic.SortedSet object is a proper superset of other; otherwise, false. - """ - pass - - def IsSubsetOf(self, other): - # type: (self: SortedSet[T], other: IEnumerable[T]) -> bool - """ - IsSubsetOf(self: SortedSet[T], other: IEnumerable[T]) -> bool - - Determines whether a System.Collections.Generic.SortedSet object is a subset of the specified collection. - - other: The collection to compare to the current System.Collections.Generic.SortedSet object. - Returns: true if the current System.Collections.Generic.SortedSet object is a subset of other; otherwise, false. - """ - pass - - def IsSupersetOf(self, other): - # type: (self: SortedSet[T], other: IEnumerable[T]) -> bool - """ - IsSupersetOf(self: SortedSet[T], other: IEnumerable[T]) -> bool - - Determines whether a System.Collections.Generic.SortedSet object is a superset of the specified collection. - - other: The collection to compare to the current System.Collections.Generic.SortedSet object. - Returns: true if the System.Collections.Generic.SortedSet object is a superset of other; otherwise, false. - """ - pass - - def OnDeserialization(self, *args): #cannot find CLR method - # type: (self: SortedSet[T], sender: object) - """ - OnDeserialization(self: SortedSet[T], sender: object) - Implements the System.Runtime.Serialization.ISerializable interface, and raises the deserialization event when the deserialization is completed. - - sender: The source of the deserialization event. - """ - pass - - def Overlaps(self, other): - # type: (self: SortedSet[T], other: IEnumerable[T]) -> bool - """ - Overlaps(self: SortedSet[T], other: IEnumerable[T]) -> bool - - Determines whether the current System.Collections.Generic.SortedSet object and a specified collection share common elements. - - other: The collection to compare to the current System.Collections.Generic.SortedSet object. - Returns: true if the System.Collections.Generic.SortedSet object and other share at least one common element; otherwise, false. - """ - pass - - def Remove(self, item): - # type: (self: SortedSet[T], item: T) -> bool - """ - Remove(self: SortedSet[T], item: T) -> bool - - Removes a specified item from the System.Collections.Generic.SortedSet. - - item: The element to remove. - Returns: true if the element is found and successfully removed; otherwise, false. - """ - pass - - def RemoveWhere(self, match): - # type: (self: SortedSet[T], match: Predicate[T]) -> int - """ - RemoveWhere(self: SortedSet[T], match: Predicate[T]) -> int - - Removes all elements that match the conditions defined by the specified predicate from a System.Collections.Generic.SortedSet. - - match: The delegate that defines the conditions of the elements to remove. - Returns: The number of elements that were removed from the System.Collections.Generic.SortedSet collection.. - """ - pass - - def Reverse(self): - # type: (self: SortedSet[T]) -> IEnumerable[T] - """ - Reverse(self: SortedSet[T]) -> IEnumerable[T] - - Returns an System.Collections.Generic.IEnumerable that iterates over the System.Collections.Generic.SortedSet in reverse order. - Returns: An enumerator that iterates over the System.Collections.Generic.SortedSet in reverse order. - """ - pass - - def SetEquals(self, other): - # type: (self: SortedSet[T], other: IEnumerable[T]) -> bool - """ - SetEquals(self: SortedSet[T], other: IEnumerable[T]) -> bool - - Determines whether the current System.Collections.Generic.SortedSet object and the specified collection contain the same elements. - - other: The collection to compare to the current System.Collections.Generic.SortedSet object. - Returns: true if the current System.Collections.Generic.SortedSet object is equal to other; otherwise, false. - """ - pass - - def SymmetricExceptWith(self, other): - # type: (self: SortedSet[T], other: IEnumerable[T]) - """ - SymmetricExceptWith(self: SortedSet[T], other: IEnumerable[T]) - Modifies the current System.Collections.Generic.SortedSet object so that it contains only elements that are present either in the current object or in the specified collection, but not both. - - other: The collection to compare to the current System.Collections.Generic.SortedSet object. - """ - pass - - def TryGetValue(self, equalValue, actualValue): - # type: (self: SortedSet[T], equalValue: T) -> (bool, T) - """ TryGetValue(self: SortedSet[T], equalValue: T) -> (bool, T) """ - pass - - def UnionWith(self, other): - # type: (self: SortedSet[T], other: IEnumerable[T]) - """ - UnionWith(self: SortedSet[T], other: IEnumerable[T]) - Modifies the current System.Collections.Generic.SortedSet object so that it contains all elements that are present in both the current object and in the specified collection. - - other: The collection to compare to the current System.Collections.Generic.SortedSet object. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: ICollection[T], item: T) -> bool - - Determines whether the System.Collections.Generic.ICollection contains a specific value. - - item: The object to locate in the System.Collections.Generic.ICollection. - Returns: true if item is found in the System.Collections.Generic.ICollection; otherwise, false. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, comparer: IComparer[T]) - __new__(cls: type, collection: IEnumerable[T]) - __new__(cls: type, collection: IEnumerable[T], comparer: IComparer[T]) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Comparer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the System.Collections.Generic.IEqualityComparer object that is used to determine equality for the values in the System.Collections.Generic.SortedSet. - - Get: Comparer(self: SortedSet[T]) -> IComparer[T] - """ - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements in the System.Collections.Generic.SortedSet. - - Get: Count(self: SortedSet[T]) -> int - """ - - Max = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the maximum value in the System.Collections.Generic.SortedSet, as defined by the comparer. - - Get: Max(self: SortedSet[T]) -> T - """ - - Min = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the minimum value in the System.Collections.Generic.SortedSet, as defined by the comparer. - - Get: Min(self: SortedSet[T]) -> T - """ - - - Enumerator = None - - -class Stack(object, IEnumerable[T], IEnumerable, ICollection, IReadOnlyCollection[T]): - # type: () - """ - Stack[T]() - Stack[T](capacity: int) - Stack[T](collection: IEnumerable[T]) - """ - def Clear(self): - # type: (self: Stack[T]) - """ - Clear(self: Stack[T]) - Removes all objects from the System.Collections.Generic.Stack. - """ - pass - - def Contains(self, item): - # type: (self: Stack[T], item: T) -> bool - """ - Contains(self: Stack[T], item: T) -> bool - - Determines whether an element is in the System.Collections.Generic.Stack. - - item: The object to locate in the System.Collections.Generic.Stack. The value can be null for reference types. - Returns: true if item is found in the System.Collections.Generic.Stack; otherwise, false. - """ - pass - - def CopyTo(self, array, arrayIndex): - # type: (self: Stack[T], array: Array[T], arrayIndex: int) - """ CopyTo(self: Stack[T], array: Array[T], arrayIndex: int) """ - pass - - def GetEnumerator(self): - # type: (self: Stack[T]) -> Enumerator - """ - GetEnumerator(self: Stack[T]) -> Enumerator - - Returns an enumerator for the System.Collections.Generic.Stack. - Returns: An System.Collections.Generic.Stack for the System.Collections.Generic.Stack. - """ - pass - - def Peek(self): - # type: (self: Stack[T]) -> T - """ - Peek(self: Stack[T]) -> T - - Returns the object at the top of the System.Collections.Generic.Stack without removing it. - Returns: The object at the top of the System.Collections.Generic.Stack. - """ - pass - - def Pop(self): - # type: (self: Stack[T]) -> T - """ - Pop(self: Stack[T]) -> T - - Removes and returns the object at the top of the System.Collections.Generic.Stack. - Returns: The object removed from the top of the System.Collections.Generic.Stack. - """ - pass - - def Push(self, item): - # type: (self: Stack[T], item: T) - """ - Push(self: Stack[T], item: T) - Inserts an object at the top of the System.Collections.Generic.Stack. - - item: The object to push onto the System.Collections.Generic.Stack. The value can be null for reference types. - """ - pass - - def ToArray(self): - # type: (self: Stack[T]) -> Array[T] - """ - ToArray(self: Stack[T]) -> Array[T] - - Copies the System.Collections.Generic.Stack to a new array. - Returns: A new array containing copies of the elements of the System.Collections.Generic.Stack. - """ - pass - - def TrimExcess(self): - # type: (self: Stack[T]) - """ - TrimExcess(self: Stack[T]) - Sets the capacity to the actual number of elements in the System.Collections.Generic.Stack, if that number is less than 90 percent of current capacity. - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[T](enumerable: IEnumerable[T], value: T) -> bool """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, capacity: int) - __new__(cls: type, collection: IEnumerable[T]) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.Generic.Stack. - - Get: Count(self: Stack[T]) -> int - """ - - - Enumerator = None - - diff --git a/pyesapi/stubs/System/Collections/ObjectModel.py b/pyesapi/stubs/System/Collections/ObjectModel.py deleted file mode 100644 index 9bca4a0..0000000 --- a/pyesapi/stubs/System/Collections/ObjectModel.py +++ /dev/null @@ -1,721 +0,0 @@ -# encoding: utf-8 -# module System.Collections.ObjectModel calls itself ObjectModel -# from mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class Collection(object, IList[T], ICollection[T], IEnumerable[T], IEnumerable, IList, ICollection, IReadOnlyList[T], IReadOnlyCollection[T]): - # type: () - """ - Collection[T]() - Collection[T](list: IList[T]) - """ - def Add(self, item): - # type: (self: Collection[T], item: T) - """ - Add(self: Collection[T], item: T) - Adds an object to the end of the System.Collections.ObjectModel.Collection. - - item: The object to be added to the end of the System.Collections.ObjectModel.Collection. The value can be null for reference types. - """ - pass - - def Clear(self): - # type: (self: Collection[T]) - """ - Clear(self: Collection[T]) - Removes all elements from the System.Collections.ObjectModel.Collection. - """ - pass - - def ClearItems(self, *args): #cannot find CLR method - # type: (self: Collection[T]) - """ - ClearItems(self: Collection[T]) - Removes all elements from the System.Collections.ObjectModel.Collection. - """ - pass - - def Contains(self, item): - # type: (self: Collection[T], item: T) -> bool - """ - Contains(self: Collection[T], item: T) -> bool - - Determines whether an element is in the System.Collections.ObjectModel.Collection. - - item: The object to locate in the System.Collections.ObjectModel.Collection. The value can be null for reference types. - Returns: true if item is found in the System.Collections.ObjectModel.Collection; otherwise, false. - """ - pass - - def CopyTo(self, array, index): - # type: (self: Collection[T], array: Array[T], index: int) - """ CopyTo(self: Collection[T], array: Array[T], index: int) """ - pass - - def GetEnumerator(self): - # type: (self: Collection[T]) -> IEnumerator[T] - """ - GetEnumerator(self: Collection[T]) -> IEnumerator[T] - - Returns an enumerator that iterates through the System.Collections.ObjectModel.Collection. - Returns: An System.Collections.Generic.IEnumerator for the System.Collections.ObjectModel.Collection. - """ - pass - - def IndexOf(self, item): - # type: (self: Collection[T], item: T) -> int - """ - IndexOf(self: Collection[T], item: T) -> int - - Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.ObjectModel.Collection. - - item: The object to locate in the System.Collections.Generic.List. The value can be null for reference types. - Returns: The zero-based index of the first occurrence of item within the entire System.Collections.ObjectModel.Collection, if found; otherwise, -1. - """ - pass - - def Insert(self, index, item): - # type: (self: Collection[T], index: int, item: T) - """ - Insert(self: Collection[T], index: int, item: T) - Inserts an element into the System.Collections.ObjectModel.Collection at the specified index. - - index: The zero-based index at which item should be inserted. - item: The object to insert. The value can be null for reference types. - """ - pass - - def InsertItem(self, *args): #cannot find CLR method - # type: (self: Collection[T], index: int, item: T) - """ - InsertItem(self: Collection[T], index: int, item: T) - Inserts an element into the System.Collections.ObjectModel.Collection at the specified index. - - index: The zero-based index at which item should be inserted. - item: The object to insert. The value can be null for reference types. - """ - pass - - def Remove(self, item): - # type: (self: Collection[T], item: T) -> bool - """ - Remove(self: Collection[T], item: T) -> bool - - Removes the first occurrence of a specific object from the System.Collections.ObjectModel.Collection. - - item: The object to remove from the System.Collections.ObjectModel.Collection. The value can be null for reference types. - Returns: true if item is successfully removed; otherwise, false. This method also returns false if item was not found in the original System.Collections.ObjectModel.Collection. - """ - pass - - def RemoveAt(self, index): - # type: (self: Collection[T], index: int) - """ - RemoveAt(self: Collection[T], index: int) - Removes the element at the specified index of the System.Collections.ObjectModel.Collection. - - index: The zero-based index of the element to remove. - """ - pass - - def RemoveItem(self, *args): #cannot find CLR method - # type: (self: Collection[T], index: int) - """ - RemoveItem(self: Collection[T], index: int) - Removes the element at the specified index of the System.Collections.ObjectModel.Collection. - - index: The zero-based index of the element to remove. - """ - pass - - def SetItem(self, *args): #cannot find CLR method - # type: (self: Collection[T], index: int, item: T) - """ - SetItem(self: Collection[T], index: int, item: T) - Replaces the element at the specified index. - - index: The zero-based index of the element to replace. - item: The new value for the element at the specified index. The value can be null for reference types. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: ICollection[T], item: T) -> bool - - Determines whether the System.Collections.Generic.ICollection contains a specific value. - - item: The object to locate in the System.Collections.Generic.ICollection. - Returns: true if item is found in the System.Collections.Generic.ICollection; otherwise, false. - __contains__(self: IList, value: object) -> bool - - Determines whether the System.Collections.IList contains a specific value. - - value: The object to locate in the System.Collections.IList. - Returns: true if the System.Object is found in the System.Collections.IList; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, list=None): - """ - __new__(cls: type) - __new__(cls: type, list: IList[T]) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements actually contained in the System.Collections.ObjectModel.Collection. - - Get: Count(self: Collection[T]) -> int - """ - - Items = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a System.Collections.Generic.IList wrapper around the System.Collections.ObjectModel.Collection. """ - - - -class KeyedCollection(Collection[TItem], IList[TItem], ICollection[TItem], IEnumerable[TItem], IEnumerable, IList, ICollection, IReadOnlyList[TItem], IReadOnlyCollection[TItem]): - # no doc - def ChangeItemKey(self, *args): #cannot find CLR method - # type: (self: KeyedCollection[TKey, TItem], item: TItem, newKey: TKey) - """ - ChangeItemKey(self: KeyedCollection[TKey, TItem], item: TItem, newKey: TKey) - Changes the key associated with the specified element in the lookup dictionary. - - item: The element to change the key of. - newKey: The new key for item. - """ - pass - - def ClearItems(self, *args): #cannot find CLR method - # type: (self: KeyedCollection[TKey, TItem]) - """ - ClearItems(self: KeyedCollection[TKey, TItem]) - Removes all elements from the System.Collections.ObjectModel.KeyedCollection. - """ - pass - - def Contains(self, *__args): - # type: (self: KeyedCollection[TKey, TItem], key: TKey) -> bool - """ - Contains(self: KeyedCollection[TKey, TItem], key: TKey) -> bool - - Determines whether the collection contains an element with the specified key. - - key: The key to locate in the System.Collections.ObjectModel.KeyedCollection. - Returns: true if the System.Collections.ObjectModel.KeyedCollection contains an element with the specified key; otherwise, false. - """ - pass - - def GetKeyForItem(self, *args): #cannot find CLR method - # type: (self: KeyedCollection[TKey, TItem], item: TItem) -> TKey - """ - GetKeyForItem(self: KeyedCollection[TKey, TItem], item: TItem) -> TKey - - When implemented in a derived class, extracts the key from the specified element. - - item: The element from which to extract the key. - Returns: The key for the specified element. - """ - pass - - def InsertItem(self, *args): #cannot find CLR method - # type: (self: KeyedCollection[TKey, TItem], index: int, item: TItem) - """ - InsertItem(self: KeyedCollection[TKey, TItem], index: int, item: TItem) - Inserts an element into the System.Collections.ObjectModel.KeyedCollection at the specified index. - - index: The zero-based index at which item should be inserted. - item: The object to insert. - """ - pass - - def Remove(self, *__args): - # type: (self: KeyedCollection[TKey, TItem], key: TKey) -> bool - """ - Remove(self: KeyedCollection[TKey, TItem], key: TKey) -> bool - - Removes the element with the specified key from the System.Collections.ObjectModel.KeyedCollection. - - key: The key of the element to remove. - Returns: true if the element is successfully removed; otherwise, false. This method also returns false if key is not found in the System.Collections.ObjectModel.KeyedCollection. - """ - pass - - def RemoveItem(self, *args): #cannot find CLR method - # type: (self: KeyedCollection[TKey, TItem], index: int) - """ - RemoveItem(self: KeyedCollection[TKey, TItem], index: int) - Removes the element at the specified index of the System.Collections.ObjectModel.KeyedCollection. - - index: The index of the element to remove. - """ - pass - - def SetItem(self, *args): #cannot find CLR method - # type: (self: KeyedCollection[TKey, TItem], index: int, item: TItem) - """ - SetItem(self: KeyedCollection[TKey, TItem], index: int, item: TItem) - Replaces the item at the specified index with the specified item. - - index: The zero-based index of the item to be replaced. - item: The new item. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) - __new__(cls: type, comparer: IEqualityComparer[TKey]) - __new__(cls: type, comparer: IEqualityComparer[TKey], dictionaryCreationThreshold: int) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Comparer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the generic equality comparer that is used to determine equality of keys in the collection. - - Get: Comparer(self: KeyedCollection[TKey, TItem]) -> IEqualityComparer[TKey] - """ - - Dictionary = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the lookup dictionary of the System.Collections.ObjectModel.KeyedCollection. """ - - Items = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a System.Collections.Generic.IList wrapper around the System.Collections.ObjectModel.Collection. """ - - - -class ObservableCollection(Collection[T], IList[T], ICollection[T], IEnumerable[T], IEnumerable, IList, ICollection, IReadOnlyList[T], IReadOnlyCollection[T], INotifyCollectionChanged, INotifyPropertyChanged): - # type: () - """ - ObservableCollection[T]() - ObservableCollection[T](list: List[T]) - ObservableCollection[T](collection: IEnumerable[T]) - """ - def BlockReentrancy(self, *args): #cannot find CLR method - # type: (self: ObservableCollection[T]) -> IDisposable - """ - BlockReentrancy(self: ObservableCollection[T]) -> IDisposable - - Disallows reentrant attempts to change this collection. - Returns: An System.IDisposable object that can be used to dispose of the object. - """ - pass - - def CheckReentrancy(self, *args): #cannot find CLR method - # type: (self: ObservableCollection[T]) - """ - CheckReentrancy(self: ObservableCollection[T]) - Checks for reentrant attempts to change this collection. - """ - pass - - def ClearItems(self, *args): #cannot find CLR method - # type: (self: ObservableCollection[T]) - """ - ClearItems(self: ObservableCollection[T]) - Removes all items from the collection. - """ - pass - - def InsertItem(self, *args): #cannot find CLR method - # type: (self: ObservableCollection[T], index: int, item: T) - """ - InsertItem(self: ObservableCollection[T], index: int, item: T) - Inserts an item into the collection at the specified index. - - index: The zero-based index at which item should be inserted. - item: The object to insert. - """ - pass - - def Move(self, oldIndex, newIndex): - # type: (self: ObservableCollection[T], oldIndex: int, newIndex: int) - """ - Move(self: ObservableCollection[T], oldIndex: int, newIndex: int) - Moves the item at the specified index to a new location in the collection. - - oldIndex: The zero-based index specifying the location of the item to be moved. - newIndex: The zero-based index specifying the new location of the item. - """ - pass - - def MoveItem(self, *args): #cannot find CLR method - # type: (self: ObservableCollection[T], oldIndex: int, newIndex: int) - """ - MoveItem(self: ObservableCollection[T], oldIndex: int, newIndex: int) - Moves the item at the specified index to a new location in the collection. - - oldIndex: The zero-based index specifying the location of the item to be moved. - newIndex: The zero-based index specifying the new location of the item. - """ - pass - - def OnCollectionChanged(self, *args): #cannot find CLR method - # type: (self: ObservableCollection[T], e: NotifyCollectionChangedEventArgs) - """ - OnCollectionChanged(self: ObservableCollection[T], e: NotifyCollectionChangedEventArgs) - Raises the System.Collections.ObjectModel.ObservableCollection event with the provided arguments. - - e: Arguments of the event being raised. - """ - pass - - def OnPropertyChanged(self, *args): #cannot find CLR method - # type: (self: ObservableCollection[T], e: PropertyChangedEventArgs) - """ - OnPropertyChanged(self: ObservableCollection[T], e: PropertyChangedEventArgs) - Raises the System.Collections.ObjectModel.ObservableCollection event with the provided arguments. - - e: Arguments of the event being raised. - """ - pass - - def RemoveItem(self, *args): #cannot find CLR method - # type: (self: ObservableCollection[T], index: int) - """ - RemoveItem(self: ObservableCollection[T], index: int) - Removes the item at the specified index of the collection. - - index: The zero-based index of the element to remove. - """ - pass - - def SetItem(self, *args): #cannot find CLR method - # type: (self: ObservableCollection[T], index: int, item: T) - """ - SetItem(self: ObservableCollection[T], index: int, item: T) - Replaces the element at the specified index. - - index: The zero-based index of the element to replace. - item: The new value for the element at the specified index. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, list: List[T]) - __new__(cls: type, collection: IEnumerable[T]) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Items = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a System.Collections.Generic.IList wrapper around the System.Collections.ObjectModel.Collection. """ - - - CollectionChanged = None - PropertyChanged = None - - -class ReadOnlyCollection(object, IList[T], ICollection[T], IEnumerable[T], IEnumerable, IList, ICollection, IReadOnlyList[T], IReadOnlyCollection[T]): - # type: (list: IList[T]) - """ ReadOnlyCollection[T](list: IList[T]) """ - def Contains(self, value): - # type: (self: ReadOnlyCollection[T], value: T) -> bool - """ - Contains(self: ReadOnlyCollection[T], value: T) -> bool - - Determines whether an element is in the System.Collections.ObjectModel.ReadOnlyCollection. - - value: The object to locate in the System.Collections.ObjectModel.ReadOnlyCollection. The value can be null for reference types. - Returns: true if value is found in the System.Collections.ObjectModel.ReadOnlyCollection; otherwise, false. - """ - pass - - def CopyTo(self, array, index): - # type: (self: ReadOnlyCollection[T], array: Array[T], index: int) - """ CopyTo(self: ReadOnlyCollection[T], array: Array[T], index: int) """ - pass - - def GetEnumerator(self): - # type: (self: ReadOnlyCollection[T]) -> IEnumerator[T] - """ - GetEnumerator(self: ReadOnlyCollection[T]) -> IEnumerator[T] - - Returns an enumerator that iterates through the System.Collections.ObjectModel.ReadOnlyCollection. - Returns: An System.Collections.Generic.IEnumerator for the System.Collections.ObjectModel.ReadOnlyCollection. - """ - pass - - def IndexOf(self, value): - # type: (self: ReadOnlyCollection[T], value: T) -> int - """ - IndexOf(self: ReadOnlyCollection[T], value: T) -> int - - Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.ObjectModel.ReadOnlyCollection. - - value: The object to locate in the System.Collections.Generic.List. The value can be null for reference types. - Returns: The zero-based index of the first occurrence of item within the entire System.Collections.ObjectModel.ReadOnlyCollection, if found; otherwise, -1. - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: ICollection[T], item: T) -> bool - - Determines whether the System.Collections.Generic.ICollection contains a specific value. - - item: The object to locate in the System.Collections.Generic.ICollection. - Returns: true if item is found in the System.Collections.Generic.ICollection; otherwise, false. - __contains__(self: IList, value: object) -> bool - - Determines whether the System.Collections.IList contains a specific value. - - value: The object to locate in the System.Collections.IList. - Returns: true if the System.Object is found in the System.Collections.IList; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, list): - """ __new__(cls: type, list: IList[T]) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.ObjectModel.ReadOnlyCollection instance. - - Get: Count(self: ReadOnlyCollection[T]) -> int - """ - - Items = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Returns the System.Collections.Generic.IList that the System.Collections.ObjectModel.ReadOnlyCollection wraps. """ - - - -class ReadOnlyDictionary(object, IDictionary[TKey, TValue], ICollection[KeyValuePair[TKey, TValue]], IEnumerable[KeyValuePair[TKey, TValue]], IEnumerable, IDictionary, ICollection, IReadOnlyDictionary[TKey, TValue], IReadOnlyCollection[KeyValuePair[TKey, TValue]]): - # type: (dictionary: IDictionary[TKey, TValue]) - """ ReadOnlyDictionary[TKey, TValue](dictionary: IDictionary[TKey, TValue]) """ - def ContainsKey(self, key): - # type: (self: ReadOnlyDictionary[TKey, TValue], key: TKey) -> bool - """ ContainsKey(self: ReadOnlyDictionary[TKey, TValue], key: TKey) -> bool """ - pass - - def GetEnumerator(self): - # type: (self: ReadOnlyDictionary[TKey, TValue]) -> IEnumerator[KeyValuePair[TKey, TValue]] - """ GetEnumerator(self: ReadOnlyDictionary[TKey, TValue]) -> IEnumerator[KeyValuePair[TKey, TValue]] """ - pass - - def TryGetValue(self, key, value): - # type: (self: ReadOnlyDictionary[TKey, TValue], key: TKey) -> (bool, TValue) - """ TryGetValue(self: ReadOnlyDictionary[TKey, TValue], key: TKey) -> (bool, TValue) """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary[TKey, TValue], key: TKey) -> bool - - Determines whether the System.Collections.Generic.IDictionary contains an element with the specified key. - - key: The key to locate in the System.Collections.Generic.IDictionary. - Returns: true if the System.Collections.Generic.IDictionary contains an element with the key; otherwise, false. - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, dictionary): - """ __new__(cls: type, dictionary: IDictionary[TKey, TValue]) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ReadOnlyDictionary[TKey, TValue]) -> int - """ Get: Count(self: ReadOnlyDictionary[TKey, TValue]) -> int """ - - Dictionary = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ReadOnlyDictionary[TKey, TValue]) -> KeyCollection - """ Get: Keys(self: ReadOnlyDictionary[TKey, TValue]) -> KeyCollection """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ReadOnlyDictionary[TKey, TValue]) -> ValueCollection - """ Get: Values(self: ReadOnlyDictionary[TKey, TValue]) -> ValueCollection """ - - - KeyCollection = None - ValueCollection = None - - -class ReadOnlyObservableCollection(ReadOnlyCollection[T], IList[T], ICollection[T], IEnumerable[T], IEnumerable, IList, ICollection, IReadOnlyList[T], IReadOnlyCollection[T], INotifyCollectionChanged, INotifyPropertyChanged): - # type: (list: ObservableCollection[T]) - """ ReadOnlyObservableCollection[T](list: ObservableCollection[T]) """ - def OnCollectionChanged(self, *args): #cannot find CLR method - # type: (self: ReadOnlyObservableCollection[T], args: NotifyCollectionChangedEventArgs) - """ - OnCollectionChanged(self: ReadOnlyObservableCollection[T], args: NotifyCollectionChangedEventArgs) - Raises the System.Collections.ObjectModel.ReadOnlyObservableCollection event using the provided arguments. - - args: Arguments of the event being raised. - """ - pass - - def OnPropertyChanged(self, *args): #cannot find CLR method - # type: (self: ReadOnlyObservableCollection[T], args: PropertyChangedEventArgs) - """ - OnPropertyChanged(self: ReadOnlyObservableCollection[T], args: PropertyChangedEventArgs) - Raises the System.Collections.ObjectModel.ReadOnlyObservableCollection event using the provided arguments. - - args: Arguments of the event being raised. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - @staticmethod # known case of __new__ - def __new__(self, list): - """ __new__(cls: type, list: ObservableCollection[T]) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - Items = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Returns the System.Collections.Generic.IList that the System.Collections.ObjectModel.ReadOnlyCollection wraps. """ - - - CollectionChanged = None - PropertyChanged = None - - diff --git a/pyesapi/stubs/System/Collections/Specialized.py b/pyesapi/stubs/System/Collections/Specialized.py deleted file mode 100644 index 74e9e5c..0000000 --- a/pyesapi/stubs/System/Collections/Specialized.py +++ /dev/null @@ -1,1863 +0,0 @@ -# encoding: utf-8 -# module System.Collections.Specialized calls itself Specialized -# from System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class BitVector32(object): - """ - Provides a simple structure that stores Boolean values and small integers in 32 bits of memory. - - BitVector32(data: int) - BitVector32(value: BitVector32) - """ - @staticmethod - def CreateMask(previous=None): - # type: () -> int - """ - CreateMask() -> int - - Creates the first mask in a series of masks that can be used to retrieve individual bits in a System.Collections.Specialized.BitVector32 that is set up as bit flags. - Returns: A mask that isolates the first bit flag in the System.Collections.Specialized.BitVector32. - CreateMask(previous: int) -> int - - Creates an additional mask following the specified mask in a series of masks that can be used to retrieve individual bits in a System.Collections.Specialized.BitVector32 that is set up as bit flags. - - previous: The mask that indicates the previous bit flag. - Returns: A mask that isolates the bit flag following the one that previous points to in System.Collections.Specialized.BitVector32. - """ - pass - - @staticmethod - def CreateSection(maxValue, previous=None): - # type: (maxValue: Int16) -> Section - """ - CreateSection(maxValue: Int16) -> Section - - Creates the first System.Collections.Specialized.BitVector32.Section in a series of sections that contain small integers. - - maxValue: A 16-bit signed integer that specifies the maximum value for the new System.Collections.Specialized.BitVector32.Section. - Returns: A System.Collections.Specialized.BitVector32.Section that can hold a number from zero to maxValue. - CreateSection(maxValue: Int16, previous: Section) -> Section - """ - pass - - def Equals(self, o): - # type: (self: BitVector32, o: object) -> bool - """ - Equals(self: BitVector32, o: object) -> bool - - Determines whether the specified object is equal to the System.Collections.Specialized.BitVector32. - - o: The object to compare with the current System.Collections.Specialized.BitVector32. - Returns: true if the specified object is equal to the System.Collections.Specialized.BitVector32; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: BitVector32) -> int - """ - GetHashCode(self: BitVector32) -> int - - Serves as a hash function for the System.Collections.Specialized.BitVector32. - Returns: A hash code for the System.Collections.Specialized.BitVector32. - """ - pass - - @staticmethod - def ToString(value=None): - # type: (value: BitVector32) -> str - """ - ToString(value: BitVector32) -> str - - Returns a string that represents the specified System.Collections.Specialized.BitVector32. - - value: The System.Collections.Specialized.BitVector32 to represent. - Returns: A string that represents the specified System.Collections.Specialized.BitVector32. - ToString(self: BitVector32) -> str - - Returns a string that represents the current System.Collections.Specialized.BitVector32. - Returns: A string that represents the current System.Collections.Specialized.BitVector32. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y]x.__getitem__(y) <==> x[y] """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, data: int) - __new__(cls: type, value: BitVector32) - __new__[BitVector32]() -> BitVector32 - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]=x.__setitem__(i, y) <==> x[i]= """ - pass - - Data = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the System.Collections.Specialized.BitVector32 as an integer. - - Get: Data(self: BitVector32) -> int - """ - - - Section = None - - -class CollectionsUtil(object): - """ - Creates collections that ignore the case in strings. - - CollectionsUtil() - """ - @staticmethod - def CreateCaseInsensitiveHashtable(*__args): - # type: (capacity: int) -> Hashtable - """ - CreateCaseInsensitiveHashtable(capacity: int) -> Hashtable - - Creates a new case-insensitive instance of the System.Collections.Hashtable class with the specified initial capacity. - - capacity: The approximate number of entries that the System.Collections.Hashtable can initially contain. - Returns: A new case-insensitive instance of the System.Collections.Hashtable class with the specified initial capacity. - CreateCaseInsensitiveHashtable() -> Hashtable - - Creates a new case-insensitive instance of the System.Collections.Hashtable class with the default initial capacity. - Returns: A new case-insensitive instance of the System.Collections.Hashtable class with the default initial capacity. - CreateCaseInsensitiveHashtable(d: IDictionary) -> Hashtable - - Copies the entries from the specified dictionary to a new case-insensitive instance of the System.Collections.Hashtable class with the same initial capacity as the number of entries copied. - - d: The System.Collections.IDictionary to copy to a new case-insensitive System.Collections.Hashtable. - Returns: A new case-insensitive instance of the System.Collections.Hashtable class containing the entries from the specified System.Collections.IDictionary. - """ - pass - - @staticmethod - def CreateCaseInsensitiveSortedList(): - # type: () -> SortedList - """ - CreateCaseInsensitiveSortedList() -> SortedList - - Creates a new instance of the System.Collections.SortedList class that ignores the case of strings. - Returns: A new instance of the System.Collections.SortedList class that ignores the case of strings. - """ - pass - - -class HybridDictionary(object, IDictionary, ICollection, IEnumerable): - """ - Implements IDictionary by using a System.Collections.Specialized.ListDictionary while the collection is small, and then switching to a System.Collections.Hashtable when the collection gets large. - - HybridDictionary() - HybridDictionary(initialSize: int) - HybridDictionary(caseInsensitive: bool) - HybridDictionary(initialSize: int, caseInsensitive: bool) - """ - def Add(self, key, value): - # type: (self: HybridDictionary, key: object, value: object) - """ - Add(self: HybridDictionary, key: object, value: object) - Adds an entry with the specified key and value into the System.Collections.Specialized.HybridDictionary. - - key: The key of the entry to add. - value: The value of the entry to add. The value can be null. - """ - pass - - def Clear(self): - # type: (self: HybridDictionary) - """ - Clear(self: HybridDictionary) - Removes all entries from the System.Collections.Specialized.HybridDictionary. - """ - pass - - def Contains(self, key): - # type: (self: HybridDictionary, key: object) -> bool - """ - Contains(self: HybridDictionary, key: object) -> bool - - Determines whether the System.Collections.Specialized.HybridDictionary contains a specific key. - - key: The key to locate in the System.Collections.Specialized.HybridDictionary. - Returns: true if the System.Collections.Specialized.HybridDictionary contains an entry with the specified key; otherwise, false. - """ - pass - - def CopyTo(self, array, index): - # type: (self: HybridDictionary, array: Array, index: int) - """ - CopyTo(self: HybridDictionary, array: Array, index: int) - Copies the System.Collections.Specialized.HybridDictionary entries to a one-dimensional System.Array instance at the specified index. - - array: The one-dimensional System.Array that is the destination of the System.Collections.DictionaryEntry objects copied from System.Collections.Specialized.HybridDictionary. The System.Array must have zero-based indexing. - index: The zero-based index in array at which copying begins. - """ - pass - - def GetEnumerator(self): - # type: (self: HybridDictionary) -> IDictionaryEnumerator - """ - GetEnumerator(self: HybridDictionary) -> IDictionaryEnumerator - - Returns an System.Collections.IDictionaryEnumerator that iterates through the System.Collections.Specialized.HybridDictionary. - Returns: An System.Collections.IDictionaryEnumerator for the System.Collections.Specialized.HybridDictionary. - """ - pass - - def Remove(self, key): - # type: (self: HybridDictionary, key: object) - """ - Remove(self: HybridDictionary, key: object) - Removes the entry with the specified key from the System.Collections.Specialized.HybridDictionary. - - key: The key of the entry to remove. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, initialSize: int) - __new__(cls: type, caseInsensitive: bool) - __new__(cls: type, initialSize: int, caseInsensitive: bool) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of key/value pairs contained in the System.Collections.Specialized.HybridDictionary. - - Get: Count(self: HybridDictionary) -> int - """ - - IsFixedSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.Specialized.HybridDictionary has a fixed size. - - Get: IsFixedSize(self: HybridDictionary) -> bool - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.Specialized.HybridDictionary is read-only. - - Get: IsReadOnly(self: HybridDictionary) -> bool - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether the System.Collections.Specialized.HybridDictionary is synchronized (thread safe). - - Get: IsSynchronized(self: HybridDictionary) -> bool - """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.ICollection containing the keys in the System.Collections.Specialized.HybridDictionary. - - Get: Keys(self: HybridDictionary) -> ICollection - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to the System.Collections.Specialized.HybridDictionary. - - Get: SyncRoot(self: HybridDictionary) -> object - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.ICollection containing the values in the System.Collections.Specialized.HybridDictionary. - - Get: Values(self: HybridDictionary) -> ICollection - """ - - - -class INotifyCollectionChanged: - """ Notifies listeners of dynamic changes, such as when items get added and removed or the whole list is refreshed. """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - CollectionChanged = None - - -class IOrderedDictionary(IDictionary, ICollection, IEnumerable): - """ Represents an indexed collection of key/value pairs. """ - def GetEnumerator(self): - # type: (self: IOrderedDictionary) -> IDictionaryEnumerator - """ - GetEnumerator(self: IOrderedDictionary) -> IDictionaryEnumerator - - Returns an enumerator that iterates through the System.Collections.Specialized.IOrderedDictionary collection. - Returns: An System.Collections.IDictionaryEnumerator for the entire System.Collections.Specialized.IOrderedDictionary collection. - """ - pass - - def Insert(self, index, key, value): - # type: (self: IOrderedDictionary, index: int, key: object, value: object) - """ - Insert(self: IOrderedDictionary, index: int, key: object, value: object) - Inserts a key/value pair into the collection at the specified index. - - index: The zero-based index at which the key/value pair should be inserted. - key: The object to use as the key of the element to add. - value: The object to use as the value of the element to add. The value can be null. - """ - pass - - def RemoveAt(self, index): - # type: (self: IOrderedDictionary, index: int) - """ - RemoveAt(self: IOrderedDictionary, index: int) - Removes the element at the specified index. - - index: The zero-based index of the element to remove. - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - -class ListDictionary(object, IDictionary, ICollection, IEnumerable): - """ - Implements IDictionary using a singly linked list. Recommended for collections that typically contain 10 items or less. - - ListDictionary() - ListDictionary(comparer: IComparer) - """ - def Add(self, key, value): - # type: (self: ListDictionary, key: object, value: object) - """ - Add(self: ListDictionary, key: object, value: object) - Adds an entry with the specified key and value into the System.Collections.Specialized.ListDictionary. - - key: The key of the entry to add. - value: The value of the entry to add. The value can be null. - """ - pass - - def Clear(self): - # type: (self: ListDictionary) - """ - Clear(self: ListDictionary) - Removes all entries from the System.Collections.Specialized.ListDictionary. - """ - pass - - def Contains(self, key): - # type: (self: ListDictionary, key: object) -> bool - """ - Contains(self: ListDictionary, key: object) -> bool - - Determines whether the System.Collections.Specialized.ListDictionary contains a specific key. - - key: The key to locate in the System.Collections.Specialized.ListDictionary. - Returns: true if the System.Collections.Specialized.ListDictionary contains an entry with the specified key; otherwise, false. - """ - pass - - def CopyTo(self, array, index): - # type: (self: ListDictionary, array: Array, index: int) - """ - CopyTo(self: ListDictionary, array: Array, index: int) - Copies the System.Collections.Specialized.ListDictionary entries to a one-dimensional System.Array instance at the specified index. - - array: The one-dimensional System.Array that is the destination of the System.Collections.DictionaryEntry objects copied from System.Collections.Specialized.ListDictionary. The System.Array must have zero-based indexing. - index: The zero-based index in array at which copying begins. - """ - pass - - def GetEnumerator(self): - # type: (self: ListDictionary) -> IDictionaryEnumerator - """ - GetEnumerator(self: ListDictionary) -> IDictionaryEnumerator - - Returns an System.Collections.IDictionaryEnumerator that iterates through the System.Collections.Specialized.ListDictionary. - Returns: An System.Collections.IDictionaryEnumerator for the System.Collections.Specialized.ListDictionary. - """ - pass - - def Remove(self, key): - # type: (self: ListDictionary, key: object) - """ - Remove(self: ListDictionary, key: object) - Removes the entry with the specified key from the System.Collections.Specialized.ListDictionary. - - key: The key of the entry to remove. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, comparer=None): - """ - __new__(cls: type) - __new__(cls: type, comparer: IComparer) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of key/value pairs contained in the System.Collections.Specialized.ListDictionary. - - Get: Count(self: ListDictionary) -> int - """ - - IsFixedSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.Specialized.ListDictionary has a fixed size. - - Get: IsFixedSize(self: ListDictionary) -> bool - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.Specialized.ListDictionary is read-only. - - Get: IsReadOnly(self: ListDictionary) -> bool - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether the System.Collections.Specialized.ListDictionary is synchronized (thread safe). - - Get: IsSynchronized(self: ListDictionary) -> bool - """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.ICollection containing the keys in the System.Collections.Specialized.ListDictionary. - - Get: Keys(self: ListDictionary) -> ICollection - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to the System.Collections.Specialized.ListDictionary. - - Get: SyncRoot(self: ListDictionary) -> object - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.ICollection containing the values in the System.Collections.Specialized.ListDictionary. - - Get: Values(self: ListDictionary) -> ICollection - """ - - - -class NameObjectCollectionBase(object, ICollection, IEnumerable, ISerializable, IDeserializationCallback): - """ Provides the abstract base class for a collection of associated System.String keys and System.Object values that can be accessed either with the key or with the index. """ - def BaseAdd(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, name: str, value: object) - """ - BaseAdd(self: NameObjectCollectionBase, name: str, value: object) - Adds an entry with the specified key and value into the System.Collections.Specialized.NameObjectCollectionBase instance. - - name: The System.String key of the entry to add. The key can be null. - value: The System.Object value of the entry to add. The value can be null. - """ - pass - - def BaseClear(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase) - """ - BaseClear(self: NameObjectCollectionBase) - Removes all entries from the System.Collections.Specialized.NameObjectCollectionBase instance. - """ - pass - - def BaseGet(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, name: str) -> object - """ - BaseGet(self: NameObjectCollectionBase, name: str) -> object - - Gets the value of the first entry with the specified key from the System.Collections.Specialized.NameObjectCollectionBase instance. - - name: The System.String key of the entry to get. The key can be null. - Returns: An System.Object that represents the value of the first entry with the specified key, if found; otherwise, null. - BaseGet(self: NameObjectCollectionBase, index: int) -> object - - Gets the value of the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance. - - index: The zero-based index of the value to get. - Returns: An System.Object that represents the value of the entry at the specified index. - """ - pass - - def BaseGetAllKeys(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase) -> Array[str] - """ - BaseGetAllKeys(self: NameObjectCollectionBase) -> Array[str] - - Returns a System.String array that contains all the keys in the System.Collections.Specialized.NameObjectCollectionBase instance. - Returns: A System.String array that contains all the keys in the System.Collections.Specialized.NameObjectCollectionBase instance. - """ - pass - - def BaseGetAllValues(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase) -> Array[object] - """ - BaseGetAllValues(self: NameObjectCollectionBase) -> Array[object] - - Returns an System.Object array that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance. - Returns: An System.Object array that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance. - BaseGetAllValues(self: NameObjectCollectionBase, type: Type) -> Array[object] - - Returns an array of the specified type that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance. - - type: A System.Type that represents the type of array to return. - Returns: An array of the specified type that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance. - """ - pass - - def BaseGetKey(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, index: int) -> str - """ - BaseGetKey(self: NameObjectCollectionBase, index: int) -> str - - Gets the key of the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance. - - index: The zero-based index of the key to get. - Returns: A System.String that represents the key of the entry at the specified index. - """ - pass - - def BaseHasKeys(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase) -> bool - """ - BaseHasKeys(self: NameObjectCollectionBase) -> bool - - Gets a value indicating whether the System.Collections.Specialized.NameObjectCollectionBase instance contains entries whose keys are not null. - Returns: true if the System.Collections.Specialized.NameObjectCollectionBase instance contains entries whose keys are not null; otherwise, false. - """ - pass - - def BaseRemove(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, name: str) - """ - BaseRemove(self: NameObjectCollectionBase, name: str) - Removes the entries with the specified key from the System.Collections.Specialized.NameObjectCollectionBase instance. - - name: The System.String key of the entries to remove. The key can be null. - """ - pass - - def BaseRemoveAt(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, index: int) - """ - BaseRemoveAt(self: NameObjectCollectionBase, index: int) - Removes the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance. - - index: The zero-based index of the entry to remove. - """ - pass - - def BaseSet(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, name: str, value: object) - """ - BaseSet(self: NameObjectCollectionBase, name: str, value: object) - Sets the value of the first entry with the specified key in the System.Collections.Specialized.NameObjectCollectionBase instance, if found; otherwise, adds an entry with the specified key and value into the - System.Collections.Specialized.NameObjectCollectionBase instance. - - - name: The System.String key of the entry to set. The key can be null. - value: The System.Object that represents the new value of the entry to set. The value can be null. - BaseSet(self: NameObjectCollectionBase, index: int, value: object) - Sets the value of the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance. - - index: The zero-based index of the entry to set. - value: The System.Object that represents the new value of the entry to set. The value can be null. - """ - pass - - def GetEnumerator(self): - # type: (self: NameObjectCollectionBase) -> IEnumerator - """ - GetEnumerator(self: NameObjectCollectionBase) -> IEnumerator - - Returns an enumerator that iterates through the System.Collections.Specialized.NameObjectCollectionBase. - Returns: An System.Collections.IEnumerator for the System.Collections.Specialized.NameObjectCollectionBase instance. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: NameObjectCollectionBase, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: NameObjectCollectionBase, info: SerializationInfo, context: StreamingContext) - Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.Collections.Specialized.NameObjectCollectionBase instance. - - info: A System.Runtime.Serialization.SerializationInfo object that contains the information required to serialize the System.Collections.Specialized.NameObjectCollectionBase instance. - context: A System.Runtime.Serialization.StreamingContext object that contains the source and destination of the serialized stream associated with the System.Collections.Specialized.NameObjectCollectionBase instance. - """ - pass - - def OnDeserialization(self, sender): - # type: (self: NameObjectCollectionBase, sender: object) - """ - OnDeserialization(self: NameObjectCollectionBase, sender: object) - Implements the System.Runtime.Serialization.ISerializable interface and raises the deserialization event when the deserialization is complete. - - sender: The source of the deserialization event. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) - __new__(cls: type, equalityComparer: IEqualityComparer) - __new__(cls: type, capacity: int, equalityComparer: IEqualityComparer) - __new__(cls: type, hashProvider: IHashCodeProvider, comparer: IComparer) - __new__(cls: type, capacity: int, hashProvider: IHashCodeProvider, comparer: IComparer) - __new__(cls: type, capacity: int) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of key/value pairs contained in the System.Collections.Specialized.NameObjectCollectionBase instance. - - Get: Count(self: NameObjectCollectionBase) -> int - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets a value indicating whether the System.Collections.Specialized.NameObjectCollectionBase instance is read-only. """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.Collections.Specialized.NameObjectCollectionBase.KeysCollection instance that contains all the keys in the System.Collections.Specialized.NameObjectCollectionBase instance. - - Get: Keys(self: NameObjectCollectionBase) -> KeysCollection - """ - - - KeysCollection = None - - -class NameValueCollection(NameObjectCollectionBase, ICollection, IEnumerable, ISerializable, IDeserializationCallback): - """ - Represents a collection of associated System.String keys and System.String values that can be accessed either with the key or with the index. - - NameValueCollection() - NameValueCollection(col: NameValueCollection) - NameValueCollection(hashProvider: IHashCodeProvider, comparer: IComparer) - NameValueCollection(capacity: int) - NameValueCollection(equalityComparer: IEqualityComparer) - NameValueCollection(capacity: int, equalityComparer: IEqualityComparer) - NameValueCollection(capacity: int, col: NameValueCollection) - NameValueCollection(capacity: int, hashProvider: IHashCodeProvider, comparer: IComparer) - """ - def Add(self, *__args): - # type: (self: NameValueCollection, c: NameValueCollection) - """ - Add(self: NameValueCollection, c: NameValueCollection) - Copies the entries in the specified System.Collections.Specialized.NameValueCollection to the current System.Collections.Specialized.NameValueCollection. - - c: The System.Collections.Specialized.NameValueCollection to copy to the current System.Collections.Specialized.NameValueCollection. - Add(self: NameValueCollection, name: str, value: str) - Adds an entry with the specified name and value to the System.Collections.Specialized.NameValueCollection. - - name: The System.String key of the entry to add. The key can be null. - value: The System.String value of the entry to add. The value can be null. - """ - pass - - def BaseAdd(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, name: str, value: object) - """ - BaseAdd(self: NameObjectCollectionBase, name: str, value: object) - Adds an entry with the specified key and value into the System.Collections.Specialized.NameObjectCollectionBase instance. - - name: The System.String key of the entry to add. The key can be null. - value: The System.Object value of the entry to add. The value can be null. - """ - pass - - def BaseClear(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase) - """ - BaseClear(self: NameObjectCollectionBase) - Removes all entries from the System.Collections.Specialized.NameObjectCollectionBase instance. - """ - pass - - def BaseGet(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, name: str) -> object - """ - BaseGet(self: NameObjectCollectionBase, name: str) -> object - - Gets the value of the first entry with the specified key from the System.Collections.Specialized.NameObjectCollectionBase instance. - - name: The System.String key of the entry to get. The key can be null. - Returns: An System.Object that represents the value of the first entry with the specified key, if found; otherwise, null. - BaseGet(self: NameObjectCollectionBase, index: int) -> object - - Gets the value of the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance. - - index: The zero-based index of the value to get. - Returns: An System.Object that represents the value of the entry at the specified index. - """ - pass - - def BaseGetAllKeys(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase) -> Array[str] - """ - BaseGetAllKeys(self: NameObjectCollectionBase) -> Array[str] - - Returns a System.String array that contains all the keys in the System.Collections.Specialized.NameObjectCollectionBase instance. - Returns: A System.String array that contains all the keys in the System.Collections.Specialized.NameObjectCollectionBase instance. - """ - pass - - def BaseGetAllValues(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase) -> Array[object] - """ - BaseGetAllValues(self: NameObjectCollectionBase) -> Array[object] - - Returns an System.Object array that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance. - Returns: An System.Object array that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance. - BaseGetAllValues(self: NameObjectCollectionBase, type: Type) -> Array[object] - - Returns an array of the specified type that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance. - - type: A System.Type that represents the type of array to return. - Returns: An array of the specified type that contains all the values in the System.Collections.Specialized.NameObjectCollectionBase instance. - """ - pass - - def BaseGetKey(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, index: int) -> str - """ - BaseGetKey(self: NameObjectCollectionBase, index: int) -> str - - Gets the key of the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance. - - index: The zero-based index of the key to get. - Returns: A System.String that represents the key of the entry at the specified index. - """ - pass - - def BaseHasKeys(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase) -> bool - """ - BaseHasKeys(self: NameObjectCollectionBase) -> bool - - Gets a value indicating whether the System.Collections.Specialized.NameObjectCollectionBase instance contains entries whose keys are not null. - Returns: true if the System.Collections.Specialized.NameObjectCollectionBase instance contains entries whose keys are not null; otherwise, false. - """ - pass - - def BaseRemove(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, name: str) - """ - BaseRemove(self: NameObjectCollectionBase, name: str) - Removes the entries with the specified key from the System.Collections.Specialized.NameObjectCollectionBase instance. - - name: The System.String key of the entries to remove. The key can be null. - """ - pass - - def BaseRemoveAt(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, index: int) - """ - BaseRemoveAt(self: NameObjectCollectionBase, index: int) - Removes the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance. - - index: The zero-based index of the entry to remove. - """ - pass - - def BaseSet(self, *args): #cannot find CLR method - # type: (self: NameObjectCollectionBase, name: str, value: object) - """ - BaseSet(self: NameObjectCollectionBase, name: str, value: object) - Sets the value of the first entry with the specified key in the System.Collections.Specialized.NameObjectCollectionBase instance, if found; otherwise, adds an entry with the specified key and value into the - System.Collections.Specialized.NameObjectCollectionBase instance. - - - name: The System.String key of the entry to set. The key can be null. - value: The System.Object that represents the new value of the entry to set. The value can be null. - BaseSet(self: NameObjectCollectionBase, index: int, value: object) - Sets the value of the entry at the specified index of the System.Collections.Specialized.NameObjectCollectionBase instance. - - index: The zero-based index of the entry to set. - value: The System.Object that represents the new value of the entry to set. The value can be null. - """ - pass - - def Clear(self): - # type: (self: NameValueCollection) - """ - Clear(self: NameValueCollection) - Invalidates the cached arrays and removes all entries from the System.Collections.Specialized.NameValueCollection. - """ - pass - - def CopyTo(self, dest, index): - # type: (self: NameValueCollection, dest: Array, index: int) - """ - CopyTo(self: NameValueCollection, dest: Array, index: int) - Copies the entire System.Collections.Specialized.NameValueCollection to a compatible one-dimensional System.Array, starting at the specified index of the target array. - - dest: The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Specialized.NameValueCollection. The System.Array must have zero-based indexing. - index: The zero-based index in dest at which copying begins. - """ - pass - - def Get(self, *__args): - # type: (self: NameValueCollection, name: str) -> str - """ - Get(self: NameValueCollection, name: str) -> str - - Gets the values associated with the specified key from the System.Collections.Specialized.NameValueCollection combined into one comma-separated list. - - name: The System.String key of the entry that contains the values to get. The key can be null. - Returns: A System.String that contains a comma-separated list of the values associated with the specified key from the System.Collections.Specialized.NameValueCollection, if found; otherwise, null. - Get(self: NameValueCollection, index: int) -> str - - Gets the values at the specified index of the System.Collections.Specialized.NameValueCollection combined into one comma-separated list. - - index: The zero-based index of the entry that contains the values to get from the collection. - Returns: A System.String that contains a comma-separated list of the values at the specified index of the System.Collections.Specialized.NameValueCollection, if found; otherwise, null. - """ - pass - - def GetKey(self, index): - # type: (self: NameValueCollection, index: int) -> str - """ - GetKey(self: NameValueCollection, index: int) -> str - - Gets the key at the specified index of the System.Collections.Specialized.NameValueCollection. - - index: The zero-based index of the key to get from the collection. - Returns: A System.String that contains the key at the specified index of the System.Collections.Specialized.NameValueCollection, if found; otherwise, null. - """ - pass - - def GetValues(self, *__args): - # type: (self: NameValueCollection, name: str) -> Array[str] - """ - GetValues(self: NameValueCollection, name: str) -> Array[str] - - Gets the values associated with the specified key from the System.Collections.Specialized.NameValueCollection. - - name: The System.String key of the entry that contains the values to get. The key can be null. - Returns: A System.String array that contains the values associated with the specified key from the System.Collections.Specialized.NameValueCollection, if found; otherwise, null. - GetValues(self: NameValueCollection, index: int) -> Array[str] - - Gets the values at the specified index of the System.Collections.Specialized.NameValueCollection. - - index: The zero-based index of the entry that contains the values to get from the collection. - Returns: A System.String array that contains the values at the specified index of the System.Collections.Specialized.NameValueCollection, if found; otherwise, null. - """ - pass - - def HasKeys(self): - # type: (self: NameValueCollection) -> bool - """ - HasKeys(self: NameValueCollection) -> bool - - Gets a value indicating whether the System.Collections.Specialized.NameValueCollection contains keys that are not null. - Returns: true if the System.Collections.Specialized.NameValueCollection contains keys that are not null; otherwise, false. - """ - pass - - def InvalidateCachedArrays(self, *args): #cannot find CLR method - # type: (self: NameValueCollection) - """ - InvalidateCachedArrays(self: NameValueCollection) - Resets the cached arrays of the collection to null. - """ - pass - - def Remove(self, name): - # type: (self: NameValueCollection, name: str) - """ - Remove(self: NameValueCollection, name: str) - Removes the entries with the specified key from the System.Collections.Specialized.NameObjectCollectionBase instance. - - name: The System.String key of the entry to remove. The key can be null. - """ - pass - - def Set(self, name, value): - # type: (self: NameValueCollection, name: str, value: str) - """ - Set(self: NameValueCollection, name: str, value: str) - Sets the value of an entry in the System.Collections.Specialized.NameValueCollection. - - name: The System.String key of the entry to add the new value to. The key can be null. - value: The System.Object that represents the new value to add to the specified entry. The value can be null. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+yx.__add__(y) <==> x+y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y]x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, col: NameValueCollection) - __new__(cls: type, hashProvider: IHashCodeProvider, comparer: IComparer) - __new__(cls: type, capacity: int) - __new__(cls: type, equalityComparer: IEqualityComparer) - __new__(cls: type, capacity: int, equalityComparer: IEqualityComparer) - __new__(cls: type, capacity: int, col: NameValueCollection) - __new__(cls: type, capacity: int, hashProvider: IHashCodeProvider, comparer: IComparer) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - AllKeys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets all the keys in the System.Collections.Specialized.NameValueCollection. - - Get: AllKeys(self: NameValueCollection) -> Array[str] - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets a value indicating whether the System.Collections.Specialized.NameObjectCollectionBase instance is read-only. """ - - - -class NotifyCollectionChangedAction(Enum, IComparable, IFormattable, IConvertible): - """ - Describes the action that caused a System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged event. - - enum NotifyCollectionChangedAction, values: Add (0), Move (3), Remove (1), Replace (2), Reset (4) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Add = None - Move = None - Remove = None - Replace = None - Reset = None - value__ = None - - -class NotifyCollectionChangedEventArgs(EventArgs): - """ - Provides data for the System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged event. - - NotifyCollectionChangedEventArgs(action: NotifyCollectionChangedAction) - NotifyCollectionChangedEventArgs(action: NotifyCollectionChangedAction, changedItem: object) - NotifyCollectionChangedEventArgs(action: NotifyCollectionChangedAction, changedItem: object, index: int) - NotifyCollectionChangedEventArgs(action: NotifyCollectionChangedAction, changedItems: IList) - NotifyCollectionChangedEventArgs(action: NotifyCollectionChangedAction, changedItems: IList, startingIndex: int) - NotifyCollectionChangedEventArgs(action: NotifyCollectionChangedAction, newItem: object, oldItem: object) - NotifyCollectionChangedEventArgs(action: NotifyCollectionChangedAction, newItem: object, oldItem: object, index: int) - NotifyCollectionChangedEventArgs(action: NotifyCollectionChangedAction, newItems: IList, oldItems: IList) - NotifyCollectionChangedEventArgs(action: NotifyCollectionChangedAction, newItems: IList, oldItems: IList, startingIndex: int) - NotifyCollectionChangedEventArgs(action: NotifyCollectionChangedAction, changedItem: object, index: int, oldIndex: int) - NotifyCollectionChangedEventArgs(action: NotifyCollectionChangedAction, changedItems: IList, index: int, oldIndex: int) - """ - @staticmethod # known case of __new__ - def __new__(self, action, *__args): - """ - __new__(cls: type, action: NotifyCollectionChangedAction) - __new__(cls: type, action: NotifyCollectionChangedAction, changedItem: object) - __new__(cls: type, action: NotifyCollectionChangedAction, changedItem: object, index: int) - __new__(cls: type, action: NotifyCollectionChangedAction, changedItems: IList) - __new__(cls: type, action: NotifyCollectionChangedAction, changedItems: IList, startingIndex: int) - __new__(cls: type, action: NotifyCollectionChangedAction, newItem: object, oldItem: object) - __new__(cls: type, action: NotifyCollectionChangedAction, newItem: object, oldItem: object, index: int) - __new__(cls: type, action: NotifyCollectionChangedAction, newItems: IList, oldItems: IList) - __new__(cls: type, action: NotifyCollectionChangedAction, newItems: IList, oldItems: IList, startingIndex: int) - __new__(cls: type, action: NotifyCollectionChangedAction, changedItem: object, index: int, oldIndex: int) - __new__(cls: type, action: NotifyCollectionChangedAction, changedItems: IList, index: int, oldIndex: int) - """ - pass - - Action = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the action that caused the event. - - Get: Action(self: NotifyCollectionChangedEventArgs) -> NotifyCollectionChangedAction - """ - - NewItems = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the list of new items involved in the change. - - Get: NewItems(self: NotifyCollectionChangedEventArgs) -> IList - """ - - NewStartingIndex = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the index at which the change occurred. - - Get: NewStartingIndex(self: NotifyCollectionChangedEventArgs) -> int - """ - - OldItems = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the list of items affected by a System.Collections.Specialized.NotifyCollectionChangedAction.Replace, Remove, or Move action. - - Get: OldItems(self: NotifyCollectionChangedEventArgs) -> IList - """ - - OldStartingIndex = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the index at which a System.Collections.Specialized.NotifyCollectionChangedAction.Move, Remove, or Replace action occurred. - - Get: OldStartingIndex(self: NotifyCollectionChangedEventArgs) -> int - """ - - - -class NotifyCollectionChangedEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that handles the System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged event. - - NotifyCollectionChangedEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: NotifyCollectionChangedEventHandler, sender: object, e: NotifyCollectionChangedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: NotifyCollectionChangedEventHandler, sender: object, e: NotifyCollectionChangedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: NotifyCollectionChangedEventHandler, result: IAsyncResult) - """ EndInvoke(self: NotifyCollectionChangedEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: NotifyCollectionChangedEventHandler, sender: object, e: NotifyCollectionChangedEventArgs) - """ Invoke(self: NotifyCollectionChangedEventHandler, sender: object, e: NotifyCollectionChangedEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class OrderedDictionary(object, IOrderedDictionary, IDictionary, ICollection, IEnumerable, ISerializable, IDeserializationCallback): - """ - Represents a collection of key/value pairs that are accessible by the key or index. - - OrderedDictionary() - OrderedDictionary(capacity: int) - OrderedDictionary(comparer: IEqualityComparer) - OrderedDictionary(capacity: int, comparer: IEqualityComparer) - """ - def Add(self, key, value): - # type: (self: OrderedDictionary, key: object, value: object) - """ - Add(self: OrderedDictionary, key: object, value: object) - Adds an entry with the specified key and value into the System.Collections.Specialized.OrderedDictionary collection with the lowest available index. - - key: The key of the entry to add. - value: The value of the entry to add. This value can be null. - """ - pass - - def AsReadOnly(self): - # type: (self: OrderedDictionary) -> OrderedDictionary - """ - AsReadOnly(self: OrderedDictionary) -> OrderedDictionary - - Returns a read-only copy of the current System.Collections.Specialized.OrderedDictionary collection. - Returns: A read-only copy of the current System.Collections.Specialized.OrderedDictionary collection. - """ - pass - - def Clear(self): - # type: (self: OrderedDictionary) - """ - Clear(self: OrderedDictionary) - Removes all elements from the System.Collections.Specialized.OrderedDictionary collection. - """ - pass - - def Contains(self, key): - # type: (self: OrderedDictionary, key: object) -> bool - """ - Contains(self: OrderedDictionary, key: object) -> bool - - Determines whether the System.Collections.Specialized.OrderedDictionary collection contains a specific key. - - key: The key to locate in the System.Collections.Specialized.OrderedDictionary collection. - Returns: true if the System.Collections.Specialized.OrderedDictionary collection contains an element with the specified key; otherwise, false. - """ - pass - - def CopyTo(self, array, index): - # type: (self: OrderedDictionary, array: Array, index: int) - """ - CopyTo(self: OrderedDictionary, array: Array, index: int) - Copies the System.Collections.Specialized.OrderedDictionary elements to a one-dimensional System.Array object at the specified index. - - array: The one-dimensional System.Array object that is the destination of the System.Collections.DictionaryEntry objects copied from System.Collections.Specialized.OrderedDictionary collection. The System.Array must have zero-based indexing. - index: The zero-based index in array at which copying begins. - """ - pass - - def GetEnumerator(self): - # type: (self: OrderedDictionary) -> IDictionaryEnumerator - """ - GetEnumerator(self: OrderedDictionary) -> IDictionaryEnumerator - - Returns an System.Collections.IDictionaryEnumerator object that iterates through the System.Collections.Specialized.OrderedDictionary collection. - Returns: An System.Collections.IDictionaryEnumerator object for the System.Collections.Specialized.OrderedDictionary collection. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: OrderedDictionary, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: OrderedDictionary, info: SerializationInfo, context: StreamingContext) - Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.Collections.Specialized.OrderedDictionary collection. - - info: A System.Runtime.Serialization.SerializationInfo object containing the information required to serialize the System.Collections.Specialized.OrderedDictionary collection. - context: A System.Runtime.Serialization.StreamingContext object containing the source and destination of the serialized stream associated with the System.Collections.Specialized.OrderedDictionary. - """ - pass - - def Insert(self, index, key, value): - # type: (self: OrderedDictionary, index: int, key: object, value: object) - """ - Insert(self: OrderedDictionary, index: int, key: object, value: object) - Inserts a new entry into the System.Collections.Specialized.OrderedDictionary collection with the specified key and value at the specified index. - - index: The zero-based index at which the element should be inserted. - key: The key of the entry to add. - value: The value of the entry to add. The value can be null. - """ - pass - - def OnDeserialization(self, *args): #cannot find CLR method - # type: (self: OrderedDictionary, sender: object) - """ - OnDeserialization(self: OrderedDictionary, sender: object) - Implements the System.Runtime.Serialization.ISerializable interface and is called back by the deserialization event when deserialization is complete. - - sender: The source of the deserialization event. - """ - pass - - def Remove(self, key): - # type: (self: OrderedDictionary, key: object) - """ - Remove(self: OrderedDictionary, key: object) - Removes the entry with the specified key from the System.Collections.Specialized.OrderedDictionary collection. - - key: The key of the entry to remove. - """ - pass - - def RemoveAt(self, index): - # type: (self: OrderedDictionary, index: int) - """ - RemoveAt(self: OrderedDictionary, index: int) - Removes the entry at the specified index from the System.Collections.Specialized.OrderedDictionary collection. - - index: The zero-based index of the entry to remove. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y]x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, capacity: int) - __new__(cls: type, comparer: IEqualityComparer) - __new__(cls: type, capacity: int, comparer: IEqualityComparer) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]=x.__setitem__(i, y) <==> x[i]= """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of key/values pairs contained in the System.Collections.Specialized.OrderedDictionary collection. - - Get: Count(self: OrderedDictionary) -> int - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.Specialized.OrderedDictionary collection is read-only. - - Get: IsReadOnly(self: OrderedDictionary) -> bool - """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.ICollection object containing the keys in the System.Collections.Specialized.OrderedDictionary collection. - - Get: Keys(self: OrderedDictionary) -> ICollection - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.ICollection object containing the values in the System.Collections.Specialized.OrderedDictionary collection. - - Get: Values(self: OrderedDictionary) -> ICollection - """ - - - -class StringCollection(object, IList, ICollection, IEnumerable): - """ - Represents a collection of strings. - - StringCollection() - """ - def Add(self, value): - # type: (self: StringCollection, value: str) -> int - """ - Add(self: StringCollection, value: str) -> int - - Adds a string to the end of the System.Collections.Specialized.StringCollection. - - value: The string to add to the end of the System.Collections.Specialized.StringCollection. The value can be null. - Returns: The zero-based index at which the new element is inserted. - """ - pass - - def AddRange(self, value): - # type: (self: StringCollection, value: Array[str]) - """ - AddRange(self: StringCollection, value: Array[str]) - Copies the elements of a string array to the end of the System.Collections.Specialized.StringCollection. - - value: An array of strings to add to the end of the System.Collections.Specialized.StringCollection. The array itself can not be null but it can contain elements that are null. - """ - pass - - def Clear(self): - # type: (self: StringCollection) - """ - Clear(self: StringCollection) - Removes all the strings from the System.Collections.Specialized.StringCollection. - """ - pass - - def Contains(self, value): - # type: (self: StringCollection, value: str) -> bool - """ - Contains(self: StringCollection, value: str) -> bool - - Determines whether the specified string is in the System.Collections.Specialized.StringCollection. - - value: The string to locate in the System.Collections.Specialized.StringCollection. The value can be null. - Returns: true if value is found in the System.Collections.Specialized.StringCollection; otherwise, false. - """ - pass - - def CopyTo(self, array, index): - # type: (self: StringCollection, array: Array[str], index: int) - """ - CopyTo(self: StringCollection, array: Array[str], index: int) - Copies the entire System.Collections.Specialized.StringCollection values to a one-dimensional array of strings, starting at the specified index of the target array. - - array: The one-dimensional array of strings that is the destination of the elements copied from System.Collections.Specialized.StringCollection. The System.Array must have zero-based indexing. - index: The zero-based index in array at which copying begins. - """ - pass - - def GetEnumerator(self): - # type: (self: StringCollection) -> StringEnumerator - """ - GetEnumerator(self: StringCollection) -> StringEnumerator - - Returns a System.Collections.Specialized.StringEnumerator that iterates through the System.Collections.Specialized.StringCollection. - Returns: A System.Collections.Specialized.StringEnumerator for the System.Collections.Specialized.StringCollection. - """ - pass - - def IndexOf(self, value): - # type: (self: StringCollection, value: str) -> int - """ - IndexOf(self: StringCollection, value: str) -> int - - Searches for the specified string and returns the zero-based index of the first occurrence within the System.Collections.Specialized.StringCollection. - - value: The string to locate. The value can be null. - Returns: The zero-based index of the first occurrence of value in the System.Collections.Specialized.StringCollection, if found; otherwise, -1. - """ - pass - - def Insert(self, index, value): - # type: (self: StringCollection, index: int, value: str) - """ - Insert(self: StringCollection, index: int, value: str) - Inserts a string into the System.Collections.Specialized.StringCollection at the specified index. - - index: The zero-based index at which value is inserted. - value: The string to insert. The value can be null. - """ - pass - - def Remove(self, value): - # type: (self: StringCollection, value: str) - """ - Remove(self: StringCollection, value: str) - Removes the first occurrence of a specific string from the System.Collections.Specialized.StringCollection. - - value: The string to remove from the System.Collections.Specialized.StringCollection. The value can be null. - """ - pass - - def RemoveAt(self, index): - # type: (self: StringCollection, index: int) - """ - RemoveAt(self: StringCollection, index: int) - Removes the string at the specified index of the System.Collections.Specialized.StringCollection. - - index: The zero-based index of the string to remove. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IList, value: object) -> bool - - Determines whether the System.Collections.IList contains a specific value. - - value: The object to locate in the System.Collections.IList. - Returns: true if the System.Object is found in the System.Collections.IList; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of strings contained in the System.Collections.Specialized.StringCollection. - - Get: Count(self: StringCollection) -> int - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.Specialized.StringCollection is read-only. - - Get: IsReadOnly(self: StringCollection) -> bool - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether access to the System.Collections.Specialized.StringCollection is synchronized (thread safe). - - Get: IsSynchronized(self: StringCollection) -> bool - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to the System.Collections.Specialized.StringCollection. - - Get: SyncRoot(self: StringCollection) -> object - """ - - - -class StringDictionary(object, IEnumerable): - """ - Implements a hash table with the key and the value strongly typed to be strings rather than objects. - - StringDictionary() - """ - def Add(self, key, value): - # type: (self: StringDictionary, key: str, value: str) - """ - Add(self: StringDictionary, key: str, value: str) - Adds an entry with the specified key and value into the System.Collections.Specialized.StringDictionary. - - key: The key of the entry to add. - value: The value of the entry to add. The value can be null. - """ - pass - - def Clear(self): - # type: (self: StringDictionary) - """ - Clear(self: StringDictionary) - Removes all entries from the System.Collections.Specialized.StringDictionary. - """ - pass - - def ContainsKey(self, key): - # type: (self: StringDictionary, key: str) -> bool - """ - ContainsKey(self: StringDictionary, key: str) -> bool - - Determines if the System.Collections.Specialized.StringDictionary contains a specific key. - - key: The key to locate in the System.Collections.Specialized.StringDictionary. - Returns: true if the System.Collections.Specialized.StringDictionary contains an entry with the specified key; otherwise, false. - """ - pass - - def ContainsValue(self, value): - # type: (self: StringDictionary, value: str) -> bool - """ - ContainsValue(self: StringDictionary, value: str) -> bool - - Determines if the System.Collections.Specialized.StringDictionary contains a specific value. - - value: The value to locate in the System.Collections.Specialized.StringDictionary. The value can be null. - Returns: true if the System.Collections.Specialized.StringDictionary contains an element with the specified value; otherwise, false. - """ - pass - - def CopyTo(self, array, index): - # type: (self: StringDictionary, array: Array, index: int) - """ - CopyTo(self: StringDictionary, array: Array, index: int) - Copies the string dictionary values to a one-dimensional System.Array instance at the specified index. - - array: The one-dimensional System.Array that is the destination of the values copied from the System.Collections.Specialized.StringDictionary. - index: The index in the array where copying begins. - """ - pass - - def GetEnumerator(self): - # type: (self: StringDictionary) -> IEnumerator - """ - GetEnumerator(self: StringDictionary) -> IEnumerator - - Returns an enumerator that iterates through the string dictionary. - Returns: An System.Collections.IEnumerator that iterates through the string dictionary. - """ - pass - - def Remove(self, key): - # type: (self: StringDictionary, key: str) - """ - Remove(self: StringDictionary, key: str) - Removes the entry with the specified key from the string dictionary. - - key: The key of the entry to remove. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of key/value pairs in the System.Collections.Specialized.StringDictionary. - - Get: Count(self: StringDictionary) -> int - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether access to the System.Collections.Specialized.StringDictionary is synchronized (thread safe). - - Get: IsSynchronized(self: StringDictionary) -> bool - """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection of keys in the System.Collections.Specialized.StringDictionary. - - Get: Keys(self: StringDictionary) -> ICollection - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to the System.Collections.Specialized.StringDictionary. - - Get: SyncRoot(self: StringDictionary) -> object - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection of values in the System.Collections.Specialized.StringDictionary. - - Get: Values(self: StringDictionary) -> ICollection - """ - - - -class StringEnumerator(object): - """ Supports a simple iteration over a System.Collections.Specialized.StringCollection. """ - def MoveNext(self): - # type: (self: StringEnumerator) -> bool - """ - MoveNext(self: StringEnumerator) -> bool - - Advances the enumerator to the next element of the collection. - Returns: true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - """ - pass - - def Reset(self): - # type: (self: StringEnumerator) - """ - Reset(self: StringEnumerator) - Sets the enumerator to its initial position, which is before the first element in the collection. - """ - pass - - Current = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the current element in the collection. - - Get: Current(self: StringEnumerator) -> str - """ - - - diff --git a/pyesapi/stubs/System/Collections/__init__.py b/pyesapi/stubs/System/Collections/__init__.py deleted file mode 100644 index 0db1ab7..0000000 --- a/pyesapi/stubs/System/Collections/__init__.py +++ /dev/null @@ -1,2796 +0,0 @@ -# encoding: utf-8 -# module System.Collections calls itself Collections -# from mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class ArrayList(object, IList, ICollection, IEnumerable, ICloneable): - """ - Implements the System.Collections.IList interface using an array whose size is dynamically increased as required. - - ArrayList() - ArrayList(capacity: int) - ArrayList(c: ICollection) - """ - @staticmethod - def Adapter(list): - # type: (list: IList) -> ArrayList - """ - Adapter(list: IList) -> ArrayList - - Creates an System.Collections.ArrayList wrapper for a specific System.Collections.IList. - - list: The System.Collections.IList to wrap. - Returns: The System.Collections.ArrayList wrapper around the System.Collections.IList. - """ - pass - - def Add(self, value): - # type: (self: ArrayList, value: object) -> int - """ - Add(self: ArrayList, value: object) -> int - - Adds an object to the end of the System.Collections.ArrayList. - - value: The System.Object to be added to the end of the System.Collections.ArrayList. The value can be null. - Returns: The System.Collections.ArrayList index at which the value has been added. - """ - pass - - def AddRange(self, c): - # type: (self: ArrayList, c: ICollection) - """ - AddRange(self: ArrayList, c: ICollection) - Adds the elements of an System.Collections.ICollection to the end of the System.Collections.ArrayList. - - c: The System.Collections.ICollection whose elements should be added to the end of the System.Collections.ArrayList. The collection itself cannot be null, but it can contain elements that are null. - """ - pass - - def BinarySearch(self, *__args): - # type: (self: ArrayList, index: int, count: int, value: object, comparer: IComparer) -> int - """ - BinarySearch(self: ArrayList, index: int, count: int, value: object, comparer: IComparer) -> int - - Searches a range of elements in the sorted System.Collections.ArrayList for an element using the specified comparer and returns the zero-based index of the element. - - index: The zero-based starting index of the range to search. - count: The length of the range to search. - value: The System.Object to locate. The value can be null. - comparer: The System.Collections.IComparer implementation to use when comparing elements.-or- null to use the default comparer that is the System.IComparable implementation of each element. - Returns: The zero-based index of value in the sorted System.Collections.ArrayList, if value is found; otherwise, a negative number, which is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, - the bitwise complement of System.Collections.ArrayList.Count. - - BinarySearch(self: ArrayList, value: object) -> int - - Searches the entire sorted System.Collections.ArrayList for an element using the default comparer and returns the zero-based index of the element. - - value: The System.Object to locate. The value can be null. - Returns: The zero-based index of value in the sorted System.Collections.ArrayList, if value is found; otherwise, a negative number, which is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, - the bitwise complement of System.Collections.ArrayList.Count. - - BinarySearch(self: ArrayList, value: object, comparer: IComparer) -> int - - Searches the entire sorted System.Collections.ArrayList for an element using the specified comparer and returns the zero-based index of the element. - - value: The System.Object to locate. The value can be null. - comparer: The System.Collections.IComparer implementation to use when comparing elements.-or- null to use the default comparer that is the System.IComparable implementation of each element. - Returns: The zero-based index of value in the sorted System.Collections.ArrayList, if value is found; otherwise, a negative number, which is the bitwise complement of the index of the next element that is larger than value or, if there is no larger element, - the bitwise complement of System.Collections.ArrayList.Count. - """ - pass - - def Clear(self): - # type: (self: ArrayList) - """ - Clear(self: ArrayList) - Removes all elements from the System.Collections.ArrayList. - """ - pass - - def Clone(self): - # type: (self: ArrayList) -> object - """ - Clone(self: ArrayList) -> object - - Creates a shallow copy of the System.Collections.ArrayList. - Returns: A shallow copy of the System.Collections.ArrayList. - """ - pass - - def Contains(self, item): - # type: (self: ArrayList, item: object) -> bool - """ - Contains(self: ArrayList, item: object) -> bool - - Determines whether an element is in the System.Collections.ArrayList. - - item: The System.Object to locate in the System.Collections.ArrayList. The value can be null. - Returns: true if item is found in the System.Collections.ArrayList; otherwise, false. - """ - pass - - def CopyTo(self, *__args): - # type: (self: ArrayList, array: Array) - """ - CopyTo(self: ArrayList, array: Array) - Copies the entire System.Collections.ArrayList to a compatible one-dimensional System.Array, starting at the beginning of the target array. - - array: The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ArrayList. The System.Array must have zero-based indexing. - CopyTo(self: ArrayList, array: Array, arrayIndex: int) - Copies the entire System.Collections.ArrayList to a compatible one-dimensional System.Array, starting at the specified index of the target array. - - array: The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ArrayList. The System.Array must have zero-based indexing. - arrayIndex: The zero-based index in array at which copying begins. - CopyTo(self: ArrayList, index: int, array: Array, arrayIndex: int, count: int) - Copies a range of elements from the System.Collections.ArrayList to a compatible one-dimensional System.Array, starting at the specified index of the target array. - - index: The zero-based index in the source System.Collections.ArrayList at which copying begins. - array: The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ArrayList. The System.Array must have zero-based indexing. - arrayIndex: The zero-based index in array at which copying begins. - count: The number of elements to copy. - """ - pass - - @staticmethod - def FixedSize(list): - # type: (list: IList) -> IList - """ - FixedSize(list: IList) -> IList - - Returns an System.Collections.IList wrapper with a fixed size. - - list: The System.Collections.IList to wrap. - Returns: An System.Collections.IList wrapper with a fixed size. - FixedSize(list: ArrayList) -> ArrayList - - Returns an System.Collections.ArrayList wrapper with a fixed size. - - list: The System.Collections.ArrayList to wrap. - Returns: An System.Collections.ArrayList wrapper with a fixed size. - """ - pass - - def GetEnumerator(self, index=None, count=None): - # type: (self: ArrayList) -> IEnumerator - """ - GetEnumerator(self: ArrayList) -> IEnumerator - - Returns an enumerator for the entire System.Collections.ArrayList. - Returns: An System.Collections.IEnumerator for the entire System.Collections.ArrayList. - GetEnumerator(self: ArrayList, index: int, count: int) -> IEnumerator - - Returns an enumerator for a range of elements in the System.Collections.ArrayList. - - index: The zero-based starting index of the System.Collections.ArrayList section that the enumerator should refer to. - count: The number of elements in the System.Collections.ArrayList section that the enumerator should refer to. - Returns: An System.Collections.IEnumerator for the specified range of elements in the System.Collections.ArrayList. - """ - pass - - def GetRange(self, index, count): - # type: (self: ArrayList, index: int, count: int) -> ArrayList - """ - GetRange(self: ArrayList, index: int, count: int) -> ArrayList - - Returns an System.Collections.ArrayList which represents a subset of the elements in the source System.Collections.ArrayList. - - index: The zero-based System.Collections.ArrayList index at which the range starts. - count: The number of elements in the range. - Returns: An System.Collections.ArrayList which represents a subset of the elements in the source System.Collections.ArrayList. - """ - pass - - def IndexOf(self, value, startIndex=None, count=None): - # type: (self: ArrayList, value: object) -> int - """ - IndexOf(self: ArrayList, value: object) -> int - - Searches for the specified System.Object and returns the zero-based index of the first occurrence within the entire System.Collections.ArrayList. - - value: The System.Object to locate in the System.Collections.ArrayList. The value can be null. - Returns: The zero-based index of the first occurrence of value within the entire System.Collections.ArrayList, if found; otherwise, -1. - IndexOf(self: ArrayList, value: object, startIndex: int) -> int - - Searches for the specified System.Object and returns the zero-based index of the first occurrence within the range of elements in the System.Collections.ArrayList that extends from the specified index to the last element. - - value: The System.Object to locate in the System.Collections.ArrayList. The value can be null. - startIndex: The zero-based starting index of the search. 0 (zero) is valid in an empty list. - Returns: The zero-based index of the first occurrence of value within the range of elements in the System.Collections.ArrayList that extends from startIndex to the last element, if found; otherwise, -1. - IndexOf(self: ArrayList, value: object, startIndex: int, count: int) -> int - - Searches for the specified System.Object and returns the zero-based index of the first occurrence within the range of elements in the System.Collections.ArrayList that starts at the specified index and contains the specified number of elements. - - value: The System.Object to locate in the System.Collections.ArrayList. The value can be null. - startIndex: The zero-based starting index of the search. 0 (zero) is valid in an empty list. - count: The number of elements in the section to search. - Returns: The zero-based index of the first occurrence of value within the range of elements in the System.Collections.ArrayList that starts at startIndex and contains count number of elements, if found; otherwise, -1. - """ - pass - - def Insert(self, index, value): - # type: (self: ArrayList, index: int, value: object) - """ - Insert(self: ArrayList, index: int, value: object) - Inserts an element into the System.Collections.ArrayList at the specified index. - - index: The zero-based index at which value should be inserted. - value: The System.Object to insert. The value can be null. - """ - pass - - def InsertRange(self, index, c): - # type: (self: ArrayList, index: int, c: ICollection) - """ - InsertRange(self: ArrayList, index: int, c: ICollection) - Inserts the elements of a collection into the System.Collections.ArrayList at the specified index. - - index: The zero-based index at which the new elements should be inserted. - c: The System.Collections.ICollection whose elements should be inserted into the System.Collections.ArrayList. The collection itself cannot be null, but it can contain elements that are null. - """ - pass - - def LastIndexOf(self, value, startIndex=None, count=None): - # type: (self: ArrayList, value: object) -> int - """ - LastIndexOf(self: ArrayList, value: object) -> int - - Searches for the specified System.Object and returns the zero-based index of the last occurrence within the entire System.Collections.ArrayList. - - value: The System.Object to locate in the System.Collections.ArrayList. The value can be null. - Returns: The zero-based index of the last occurrence of value within the entire the System.Collections.ArrayList, if found; otherwise, -1. - LastIndexOf(self: ArrayList, value: object, startIndex: int) -> int - - Searches for the specified System.Object and returns the zero-based index of the last occurrence within the range of elements in the System.Collections.ArrayList that extends from the first element to the specified index. - - value: The System.Object to locate in the System.Collections.ArrayList. The value can be null. - startIndex: The zero-based starting index of the backward search. - Returns: The zero-based index of the last occurrence of value within the range of elements in the System.Collections.ArrayList that extends from the first element to startIndex, if found; otherwise, -1. - LastIndexOf(self: ArrayList, value: object, startIndex: int, count: int) -> int - - Searches for the specified System.Object and returns the zero-based index of the last occurrence within the range of elements in the System.Collections.ArrayList that contains the specified number of elements and ends at the specified index. - - value: The System.Object to locate in the System.Collections.ArrayList. The value can be null. - startIndex: The zero-based starting index of the backward search. - count: The number of elements in the section to search. - Returns: The zero-based index of the last occurrence of value within the range of elements in the System.Collections.ArrayList that contains count number of elements and ends at startIndex, if found; otherwise, -1. - """ - pass - - @staticmethod - def ReadOnly(list): - # type: (list: IList) -> IList - """ - ReadOnly(list: IList) -> IList - - Returns a read-only System.Collections.IList wrapper. - - list: The System.Collections.IList to wrap. - Returns: A read-only System.Collections.IList wrapper around list. - ReadOnly(list: ArrayList) -> ArrayList - - Returns a read-only System.Collections.ArrayList wrapper. - - list: The System.Collections.ArrayList to wrap. - Returns: A read-only System.Collections.ArrayList wrapper around list. - """ - pass - - def Remove(self, obj): - # type: (self: ArrayList, obj: object) - """ - Remove(self: ArrayList, obj: object) - Removes the first occurrence of a specific object from the System.Collections.ArrayList. - - obj: The System.Object to remove from the System.Collections.ArrayList. The value can be null. - """ - pass - - def RemoveAt(self, index): - # type: (self: ArrayList, index: int) - """ - RemoveAt(self: ArrayList, index: int) - Removes the element at the specified index of the System.Collections.ArrayList. - - index: The zero-based index of the element to remove. - """ - pass - - def RemoveRange(self, index, count): - # type: (self: ArrayList, index: int, count: int) - """ - RemoveRange(self: ArrayList, index: int, count: int) - Removes a range of elements from the System.Collections.ArrayList. - - index: The zero-based starting index of the range of elements to remove. - count: The number of elements to remove. - """ - pass - - @staticmethod - def Repeat(value, count): - # type: (value: object, count: int) -> ArrayList - """ - Repeat(value: object, count: int) -> ArrayList - - Returns an System.Collections.ArrayList whose elements are copies of the specified value. - - value: The System.Object to copy multiple times in the new System.Collections.ArrayList. The value can be null. - count: The number of times value should be copied. - Returns: An System.Collections.ArrayList with count number of elements, all of which are copies of value. - """ - pass - - def Reverse(self, index=None, count=None): - # type: (self: ArrayList) - """ - Reverse(self: ArrayList) - Reverses the order of the elements in the entire System.Collections.ArrayList. - Reverse(self: ArrayList, index: int, count: int) - Reverses the order of the elements in the specified range. - - index: The zero-based starting index of the range to reverse. - count: The number of elements in the range to reverse. - """ - pass - - def SetRange(self, index, c): - # type: (self: ArrayList, index: int, c: ICollection) - """ - SetRange(self: ArrayList, index: int, c: ICollection) - Copies the elements of a collection over a range of elements in the System.Collections.ArrayList. - - index: The zero-based System.Collections.ArrayList index at which to start copying the elements of c. - c: The System.Collections.ICollection whose elements to copy to the System.Collections.ArrayList. The collection itself cannot be null, but it can contain elements that are null. - """ - pass - - def Sort(self, *__args): - # type: (self: ArrayList) - """ - Sort(self: ArrayList) - Sorts the elements in the entire System.Collections.ArrayList. - Sort(self: ArrayList, comparer: IComparer) - Sorts the elements in the entire System.Collections.ArrayList using the specified comparer. - - comparer: The System.Collections.IComparer implementation to use when comparing elements.-or- A null reference (Nothing in Visual Basic) to use the System.IComparable implementation of each element. - Sort(self: ArrayList, index: int, count: int, comparer: IComparer) - Sorts the elements in a range of elements in System.Collections.ArrayList using the specified comparer. - - index: The zero-based starting index of the range to sort. - count: The length of the range to sort. - comparer: The System.Collections.IComparer implementation to use when comparing elements.-or- A null reference (Nothing in Visual Basic) to use the System.IComparable implementation of each element. - """ - pass - - @staticmethod - def Synchronized(list): - # type: (list: IList) -> IList - """ - Synchronized(list: IList) -> IList - - Returns an System.Collections.IList wrapper that is synchronized (thread safe). - - list: The System.Collections.IList to synchronize. - Returns: An System.Collections.IList wrapper that is synchronized (thread safe). - Synchronized(list: ArrayList) -> ArrayList - - Returns an System.Collections.ArrayList wrapper that is synchronized (thread safe). - - list: The System.Collections.ArrayList to synchronize. - Returns: An System.Collections.ArrayList wrapper that is synchronized (thread safe). - """ - pass - - def ToArray(self, type=None): - # type: (self: ArrayList) -> Array[object] - """ - ToArray(self: ArrayList) -> Array[object] - - Copies the elements of the System.Collections.ArrayList to a new System.Object array. - Returns: An System.Object array containing copies of the elements of the System.Collections.ArrayList. - ToArray(self: ArrayList, type: Type) -> Array - - Copies the elements of the System.Collections.ArrayList to a new array of the specified element type. - - type: The element System.Type of the destination array to create and copy elements to. - Returns: An array of the specified element type containing copies of the elements of the System.Collections.ArrayList. - """ - pass - - def TrimToSize(self): - # type: (self: ArrayList) - """ - TrimToSize(self: ArrayList) - Sets the capacity to the actual number of elements in the System.Collections.ArrayList. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IList, value: object) -> bool - - Determines whether the System.Collections.IList contains a specific value. - - value: The object to locate in the System.Collections.IList. - Returns: true if the System.Object is found in the System.Collections.IList; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, capacity: int) - __new__(cls: type, c: ICollection) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Capacity = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the number of elements that the System.Collections.ArrayList can contain. - - Get: Capacity(self: ArrayList) -> int - - Set: Capacity(self: ArrayList) = value - """ - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements actually contained in the System.Collections.ArrayList. - - Get: Count(self: ArrayList) -> int - """ - - IsFixedSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.ArrayList has a fixed size. - - Get: IsFixedSize(self: ArrayList) -> bool - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.ArrayList is read-only. - - Get: IsReadOnly(self: ArrayList) -> bool - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether access to the System.Collections.ArrayList is synchronized (thread safe). - - Get: IsSynchronized(self: ArrayList) -> bool - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to the System.Collections.ArrayList. - - Get: SyncRoot(self: ArrayList) -> object - """ - - - -class BitArray(object, ICollection, IEnumerable, ICloneable): - # type: (1) and false indicates the bit is off (0). - """ - Manages a compact array of bit values, which are represented as Booleans, where true indicates that the bit is on (1) and false indicates the bit is off (0). - - BitArray(length: int) - BitArray(length: int, defaultValue: bool) - BitArray(bytes: Array[Byte]) - BitArray(values: Array[bool]) - BitArray(values: Array[int]) - BitArray(bits: BitArray) - """ - def And(self, value): - # type: (self: BitArray, value: BitArray) -> BitArray - """ - And(self: BitArray, value: BitArray) -> BitArray - - Performs the bitwise AND operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray. - - value: The System.Collections.BitArray with which to perform the bitwise AND operation. - Returns: The current instance containing the result of the bitwise AND operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray. - """ - pass - - def Clone(self): - # type: (self: BitArray) -> object - """ - Clone(self: BitArray) -> object - - Creates a shallow copy of the System.Collections.BitArray. - Returns: A shallow copy of the System.Collections.BitArray. - """ - pass - - def CopyTo(self, array, index): - # type: (self: BitArray, array: Array, index: int) - """ - CopyTo(self: BitArray, array: Array, index: int) - Copies the entire System.Collections.BitArray to a compatible one-dimensional System.Array, starting at the specified index of the target array. - - array: The one-dimensional System.Array that is the destination of the elements copied from System.Collections.BitArray. The System.Array must have zero-based indexing. - index: The zero-based index in array at which copying begins. - """ - pass - - def Get(self, index): - # type: (self: BitArray, index: int) -> bool - """ - Get(self: BitArray, index: int) -> bool - - Gets the value of the bit at a specific position in the System.Collections.BitArray. - - index: The zero-based index of the value to get. - Returns: The value of the bit at position index. - """ - pass - - def GetEnumerator(self): - # type: (self: BitArray) -> IEnumerator - """ - GetEnumerator(self: BitArray) -> IEnumerator - - Returns an enumerator that iterates through the System.Collections.BitArray. - Returns: An System.Collections.IEnumerator for the entire System.Collections.BitArray. - """ - pass - - def Not(self): - # type: (self: BitArray) -> BitArray - """ - Not(self: BitArray) -> BitArray - - Inverts all the bit values in the current System.Collections.BitArray, so that elements set to true are changed to false, and elements set to false are changed to true. - Returns: The current instance with inverted bit values. - """ - pass - - def Or(self, value): - # type: (self: BitArray, value: BitArray) -> BitArray - """ - Or(self: BitArray, value: BitArray) -> BitArray - - Performs the bitwise OR operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray. - - value: The System.Collections.BitArray with which to perform the bitwise OR operation. - Returns: The current instance containing the result of the bitwise OR operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray. - """ - pass - - def Set(self, index, value): - # type: (self: BitArray, index: int, value: bool) - """ - Set(self: BitArray, index: int, value: bool) - Sets the bit at a specific position in the System.Collections.BitArray to the specified value. - - index: The zero-based index of the bit to set. - value: The Boolean value to assign to the bit. - """ - pass - - def SetAll(self, value): - # type: (self: BitArray, value: bool) - """ - SetAll(self: BitArray, value: bool) - Sets all bits in the System.Collections.BitArray to the specified value. - - value: The Boolean value to assign to all bits. - """ - pass - - def Xor(self, value): - # type: (self: BitArray, value: BitArray) -> BitArray - """ - Xor(self: BitArray, value: BitArray) -> BitArray - - Performs the bitwise exclusive OR operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray. - - value: The System.Collections.BitArray with which to perform the bitwise exclusive OR operation. - Returns: The current instance containing the result of the bitwise exclusive OR operation on the elements in the current System.Collections.BitArray against the corresponding elements in the specified System.Collections.BitArray. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, length: int) - __new__(cls: type, length: int, defaultValue: bool) - __new__(cls: type, bytes: Array[Byte]) - __new__(cls: type, values: Array[bool]) - __new__(cls: type, values: Array[int]) - __new__(cls: type, bits: BitArray) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.BitArray. - - Get: Count(self: BitArray) -> int - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.BitArray is read-only. - - Get: IsReadOnly(self: BitArray) -> bool - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether access to the System.Collections.BitArray is synchronized (thread safe). - - Get: IsSynchronized(self: BitArray) -> bool - """ - - Length = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the number of elements in the System.Collections.BitArray. - - Get: Length(self: BitArray) -> int - - Set: Length(self: BitArray) = value - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to the System.Collections.BitArray. - - Get: SyncRoot(self: BitArray) -> object - """ - - - -class CaseInsensitiveComparer(object, IComparer): - """ - Compares two objects for equivalence, ignoring the case of strings. - - CaseInsensitiveComparer() - CaseInsensitiveComparer(culture: CultureInfo) - """ - def Compare(self, a, b): - # type: (self: CaseInsensitiveComparer, a: object, b: object) -> int - """ - Compare(self: CaseInsensitiveComparer, a: object, b: object) -> int - - Performs a case-insensitive comparison of two objects of the same type and returns a value indicating whether one is less than, equal to, or greater than the other. - - a: The first object to compare. - b: The second object to compare. - Returns: A signed integer that indicates the relative values of a and b, as shown in the following table.Value Meaning Less than zero a is less than b, with casing ignored. Zero a equals b, with casing ignored. Greater than zero a is greater than b, with - casing ignored. - """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, culture=None): - """ - __new__(cls: type) - __new__(cls: type, culture: CultureInfo) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Default = None - DefaultInvariant = None - - -class CaseInsensitiveHashCodeProvider(object, IHashCodeProvider): - """ - Supplies a hash code for an object, using a hashing algorithm that ignores the case of strings. - - CaseInsensitiveHashCodeProvider() - CaseInsensitiveHashCodeProvider(culture: CultureInfo) - """ - def GetHashCode(self, obj=None): - # type: (self: CaseInsensitiveHashCodeProvider, obj: object) -> int - """ - GetHashCode(self: CaseInsensitiveHashCodeProvider, obj: object) -> int - - Returns a hash code for the given object, using a hashing algorithm that ignores the case of strings. - - obj: The System.Object for which a hash code is to be returned. - Returns: A hash code for the given object, using a hashing algorithm that ignores the case of strings. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, culture=None): - """ - __new__(cls: type) - __new__(cls: type, culture: CultureInfo) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Default = None - DefaultInvariant = None - - -class IEnumerable: - """ Exposes the enumerator, which supports a simple iteration over a non-generic collection. """ - def GetEnumerator(self): - # type: (self: IEnumerable) -> IEnumerator - """ - GetEnumerator(self: IEnumerable) -> IEnumerator - - Returns an enumerator that iterates through a collection. - Returns: An System.Collections.IEnumerator object that can be used to iterate through the collection. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - -class ICollection(IEnumerable): - """ Defines size, enumerators, and synchronization methods for all nongeneric collections. """ - def CopyTo(self, array, index): - # type: (self: ICollection, array: Array, index: int) - """ - CopyTo(self: ICollection, array: Array, index: int) - Copies the elements of the System.Collections.ICollection to an System.Array, starting at a particular System.Array index. - - array: The one-dimensional System.Array that is the destination of the elements copied from System.Collections.ICollection. The System.Array must have zero-based indexing. - index: The zero-based index in array at which copying begins. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.ICollection. - - Get: Count(self: ICollection) -> int - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether access to the System.Collections.ICollection is synchronized (thread safe). - - Get: IsSynchronized(self: ICollection) -> bool - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to the System.Collections.ICollection. - - Get: SyncRoot(self: ICollection) -> object - """ - - - -class IList(ICollection, IEnumerable): - """ Represents a non-generic collection of objects that can be individually accessed by index. """ - def Add(self, value): - # type: (self: IList, value: object) -> int - """ - Add(self: IList, value: object) -> int - - Adds an item to the System.Collections.IList. - - value: The object to add to the System.Collections.IList. - Returns: The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection, - """ - pass - - def Clear(self): - # type: (self: IList) - """ - Clear(self: IList) - Removes all items from the System.Collections.IList. - """ - pass - - def Contains(self, value): - """ - __contains__(self: IList, value: object) -> bool - - Determines whether the System.Collections.IList contains a specific value. - - value: The object to locate in the System.Collections.IList. - Returns: true if the System.Object is found in the System.Collections.IList; otherwise, false. - """ - pass - - def IndexOf(self, value): - # type: (self: IList, value: object) -> int - """ - IndexOf(self: IList, value: object) -> int - - Determines the index of a specific item in the System.Collections.IList. - - value: The object to locate in the System.Collections.IList. - Returns: The index of value if found in the list; otherwise, -1. - """ - pass - - def Insert(self, index, value): - # type: (self: IList, index: int, value: object) - """ - Insert(self: IList, index: int, value: object) - Inserts an item to the System.Collections.IList at the specified index. - - index: The zero-based index at which value should be inserted. - value: The object to insert into the System.Collections.IList. - """ - pass - - def Remove(self, value): - # type: (self: IList, value: object) - """ - Remove(self: IList, value: object) - Removes the first occurrence of a specific object from the System.Collections.IList. - - value: The object to remove from the System.Collections.IList. - """ - pass - - def RemoveAt(self, index): - # type: (self: IList, index: int) - """ - RemoveAt(self: IList, index: int) - Removes the System.Collections.IList item at the specified index. - - index: The zero-based index of the item to remove. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - IsFixedSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.IList has a fixed size. - - Get: IsFixedSize(self: IList) -> bool - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.IList is read-only. - - Get: IsReadOnly(self: IList) -> bool - """ - - - -class CollectionBase(object, IList, ICollection, IEnumerable): - """ Provides the abstract base class for a strongly typed collection. """ - def Clear(self): - # type: (self: CollectionBase) - """ - Clear(self: CollectionBase) - Removes all objects from the System.Collections.CollectionBase instance. This method cannot be overridden. - """ - pass - - def GetEnumerator(self): - # type: (self: CollectionBase) -> IEnumerator - """ - GetEnumerator(self: CollectionBase) -> IEnumerator - - Returns an enumerator that iterates through the System.Collections.CollectionBase instance. - Returns: An System.Collections.IEnumerator for the System.Collections.CollectionBase instance. - """ - pass - - def OnClear(self, *args): #cannot find CLR method - # type: (self: CollectionBase) - """ - OnClear(self: CollectionBase) - Performs additional custom processes when clearing the contents of the System.Collections.CollectionBase instance. - """ - pass - - def OnClearComplete(self, *args): #cannot find CLR method - # type: (self: CollectionBase) - """ - OnClearComplete(self: CollectionBase) - Performs additional custom processes after clearing the contents of the System.Collections.CollectionBase instance. - """ - pass - - def OnInsert(self, *args): #cannot find CLR method - # type: (self: CollectionBase, index: int, value: object) - """ - OnInsert(self: CollectionBase, index: int, value: object) - Performs additional custom processes before inserting a new element into the System.Collections.CollectionBase instance. - - index: The zero-based index at which to insert value. - value: The new value of the element at index. - """ - pass - - def OnInsertComplete(self, *args): #cannot find CLR method - # type: (self: CollectionBase, index: int, value: object) - """ - OnInsertComplete(self: CollectionBase, index: int, value: object) - Performs additional custom processes after inserting a new element into the System.Collections.CollectionBase instance. - - index: The zero-based index at which to insert value. - value: The new value of the element at index. - """ - pass - - def OnRemove(self, *args): #cannot find CLR method - # type: (self: CollectionBase, index: int, value: object) - """ - OnRemove(self: CollectionBase, index: int, value: object) - Performs additional custom processes when removing an element from the System.Collections.CollectionBase instance. - - index: The zero-based index at which value can be found. - value: The value of the element to remove from index. - """ - pass - - def OnRemoveComplete(self, *args): #cannot find CLR method - # type: (self: CollectionBase, index: int, value: object) - """ - OnRemoveComplete(self: CollectionBase, index: int, value: object) - Performs additional custom processes after removing an element from the System.Collections.CollectionBase instance. - - index: The zero-based index at which value can be found. - value: The value of the element to remove from index. - """ - pass - - def OnSet(self, *args): #cannot find CLR method - # type: (self: CollectionBase, index: int, oldValue: object, newValue: object) - """ - OnSet(self: CollectionBase, index: int, oldValue: object, newValue: object) - Performs additional custom processes before setting a value in the System.Collections.CollectionBase instance. - - index: The zero-based index at which oldValue can be found. - oldValue: The value to replace with newValue. - newValue: The new value of the element at index. - """ - pass - - def OnSetComplete(self, *args): #cannot find CLR method - # type: (self: CollectionBase, index: int, oldValue: object, newValue: object) - """ - OnSetComplete(self: CollectionBase, index: int, oldValue: object, newValue: object) - Performs additional custom processes after setting a value in the System.Collections.CollectionBase instance. - - index: The zero-based index at which oldValue can be found. - oldValue: The value to replace with newValue. - newValue: The new value of the element at index. - """ - pass - - def OnValidate(self, *args): #cannot find CLR method - # type: (self: CollectionBase, value: object) - """ - OnValidate(self: CollectionBase, value: object) - Performs additional custom processes when validating a value. - - value: The object to validate. - """ - pass - - def RemoveAt(self, index): - # type: (self: CollectionBase, index: int) - """ - RemoveAt(self: CollectionBase, index: int) - Removes the element at the specified index of the System.Collections.CollectionBase instance. This method is not overridable. - - index: The zero-based index of the element to remove. - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IList, value: object) -> bool - - Determines whether the System.Collections.IList contains a specific value. - - value: The object to locate in the System.Collections.IList. - Returns: true if the System.Object is found in the System.Collections.IList; otherwise, false. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) - __new__(cls: type, capacity: int) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Capacity = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the number of elements that the System.Collections.CollectionBase can contain. - - Get: Capacity(self: CollectionBase) -> int - - Set: Capacity(self: CollectionBase) = value - """ - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.CollectionBase instance. This property cannot be overridden. - - Get: Count(self: CollectionBase) -> int - """ - - InnerList = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets an System.Collections.ArrayList containing the list of elements in the System.Collections.CollectionBase instance. """ - - List = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets an System.Collections.IList containing the list of elements in the System.Collections.CollectionBase instance. """ - - - -class Comparer(object, IComparer, ISerializable): - """ - Compares two objects for equivalence, where string comparisons are case-sensitive. - - Comparer(culture: CultureInfo) - """ - def Compare(self, a, b): - # type: (self: Comparer, a: object, b: object) -> int - """ - Compare(self: Comparer, a: object, b: object) -> int - - Performs a case-sensitive comparison of two objects of the same type and returns a value indicating whether one is less than, equal to, or greater than the other. - - a: The first object to compare. - b: The second object to compare. - Returns: A signed integer that indicates the relative values of a and b, as shown in the following table.Value Meaning Less than zero a is less than b. Zero a equals b. Greater than zero a is greater than b. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: Comparer, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: Comparer, info: SerializationInfo, context: StreamingContext) - Populates a System.Runtime.Serialization.SerializationInfo object with the data required for serialization. - - info: The object to populate with data. - context: The context information about the source or destination of the serialization. - """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, culture): - """ __new__(cls: type, culture: CultureInfo) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Default = None - DefaultInvariant = None - - -class IDictionary(ICollection, IEnumerable): - """ Represents a nongeneric collection of key/value pairs. """ - def Add(self, key, value): - # type: (self: IDictionary, key: object, value: object) - """ - Add(self: IDictionary, key: object, value: object) - Adds an element with the provided key and value to the System.Collections.IDictionary object. - - key: The System.Object to use as the key of the element to add. - value: The System.Object to use as the value of the element to add. - """ - pass - - def Clear(self): - # type: (self: IDictionary) - """ - Clear(self: IDictionary) - Removes all elements from the System.Collections.IDictionary object. - """ - pass - - def Contains(self, key): - """ - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def GetEnumerator(self): - # type: (self: IDictionary) -> IDictionaryEnumerator - """ - GetEnumerator(self: IDictionary) -> IDictionaryEnumerator - - Returns an System.Collections.IDictionaryEnumerator object for the System.Collections.IDictionary object. - Returns: An System.Collections.IDictionaryEnumerator object for the System.Collections.IDictionary object. - """ - pass - - def Remove(self, key): - # type: (self: IDictionary, key: object) - """ - Remove(self: IDictionary, key: object) - Removes the element with the specified key from the System.Collections.IDictionary object. - - key: The key of the element to remove. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - IsFixedSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.IDictionary object has a fixed size. - - Get: IsFixedSize(self: IDictionary) -> bool - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.IDictionary object is read-only. - - Get: IsReadOnly(self: IDictionary) -> bool - """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.ICollection object containing the keys of the System.Collections.IDictionary object. - - Get: Keys(self: IDictionary) -> ICollection - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.ICollection object containing the values in the System.Collections.IDictionary object. - - Get: Values(self: IDictionary) -> ICollection - """ - - - -class DictionaryBase(object, IDictionary, ICollection, IEnumerable): - """ Provides the abstract base class for a strongly typed collection of key/value pairs. """ - def Clear(self): - # type: (self: DictionaryBase) - """ - Clear(self: DictionaryBase) - Clears the contents of the System.Collections.DictionaryBase instance. - """ - pass - - def CopyTo(self, array, index): - # type: (self: DictionaryBase, array: Array, index: int) - """ - CopyTo(self: DictionaryBase, array: Array, index: int) - Copies the System.Collections.DictionaryBase elements to a one-dimensional System.Array at the specified index. - - array: The one-dimensional System.Array that is the destination of the System.Collections.DictionaryEntry objects copied from the System.Collections.DictionaryBase instance. The System.Array must have zero-based indexing. - index: The zero-based index in array at which copying begins. - """ - pass - - def GetEnumerator(self): - # type: (self: DictionaryBase) -> IDictionaryEnumerator - """ - GetEnumerator(self: DictionaryBase) -> IDictionaryEnumerator - - Returns an System.Collections.IDictionaryEnumerator that iterates through the System.Collections.DictionaryBase instance. - Returns: An System.Collections.IDictionaryEnumerator for the System.Collections.DictionaryBase instance. - """ - pass - - def OnClear(self, *args): #cannot find CLR method - # type: (self: DictionaryBase) - """ - OnClear(self: DictionaryBase) - Performs additional custom processes before clearing the contents of the System.Collections.DictionaryBase instance. - """ - pass - - def OnClearComplete(self, *args): #cannot find CLR method - # type: (self: DictionaryBase) - """ - OnClearComplete(self: DictionaryBase) - Performs additional custom processes after clearing the contents of the System.Collections.DictionaryBase instance. - """ - pass - - def OnGet(self, *args): #cannot find CLR method - # type: (self: DictionaryBase, key: object, currentValue: object) -> object - """ - OnGet(self: DictionaryBase, key: object, currentValue: object) -> object - - Gets the element with the specified key and value in the System.Collections.DictionaryBase instance. - - key: The key of the element to get. - currentValue: The current value of the element associated with key. - Returns: An System.Object containing the element with the specified key and value. - """ - pass - - def OnInsert(self, *args): #cannot find CLR method - # type: (self: DictionaryBase, key: object, value: object) - """ - OnInsert(self: DictionaryBase, key: object, value: object) - Performs additional custom processes before inserting a new element into the System.Collections.DictionaryBase instance. - - key: The key of the element to insert. - value: The value of the element to insert. - """ - pass - - def OnInsertComplete(self, *args): #cannot find CLR method - # type: (self: DictionaryBase, key: object, value: object) - """ - OnInsertComplete(self: DictionaryBase, key: object, value: object) - Performs additional custom processes after inserting a new element into the System.Collections.DictionaryBase instance. - - key: The key of the element to insert. - value: The value of the element to insert. - """ - pass - - def OnRemove(self, *args): #cannot find CLR method - # type: (self: DictionaryBase, key: object, value: object) - """ - OnRemove(self: DictionaryBase, key: object, value: object) - Performs additional custom processes before removing an element from the System.Collections.DictionaryBase instance. - - key: The key of the element to remove. - value: The value of the element to remove. - """ - pass - - def OnRemoveComplete(self, *args): #cannot find CLR method - # type: (self: DictionaryBase, key: object, value: object) - """ - OnRemoveComplete(self: DictionaryBase, key: object, value: object) - Performs additional custom processes after removing an element from the System.Collections.DictionaryBase instance. - - key: The key of the element to remove. - value: The value of the element to remove. - """ - pass - - def OnSet(self, *args): #cannot find CLR method - # type: (self: DictionaryBase, key: object, oldValue: object, newValue: object) - """ - OnSet(self: DictionaryBase, key: object, oldValue: object, newValue: object) - Performs additional custom processes before setting a value in the System.Collections.DictionaryBase instance. - - key: The key of the element to locate. - oldValue: The old value of the element associated with key. - newValue: The new value of the element associated with key. - """ - pass - - def OnSetComplete(self, *args): #cannot find CLR method - # type: (self: DictionaryBase, key: object, oldValue: object, newValue: object) - """ - OnSetComplete(self: DictionaryBase, key: object, oldValue: object, newValue: object) - Performs additional custom processes after setting a value in the System.Collections.DictionaryBase instance. - - key: The key of the element to locate. - oldValue: The old value of the element associated with key. - newValue: The new value of the element associated with key. - """ - pass - - def OnValidate(self, *args): #cannot find CLR method - # type: (self: DictionaryBase, key: object, value: object) - """ - OnValidate(self: DictionaryBase, key: object, value: object) - Performs additional custom processes when validating the element with the specified key and value. - - key: The key of the element to validate. - value: The value of the element to validate. - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.DictionaryBase instance. - - Get: Count(self: DictionaryBase) -> int - """ - - Dictionary = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the list of elements contained in the System.Collections.DictionaryBase instance. """ - - InnerHashtable = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the list of elements contained in the System.Collections.DictionaryBase instance. """ - - - -class DictionaryEntry(object): - """ - Defines a dictionary key/value pair that can be set or retrieved. - - DictionaryEntry(key: object, value: object) - """ - @staticmethod # known case of __new__ - def __new__(self, key, value): - """ - __new__[DictionaryEntry]() -> DictionaryEntry - - __new__(cls: type, key: object, value: object) - """ - pass - - Key = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the key in the key/value pair. - - Get: Key(self: DictionaryEntry) -> object - - Set: Key(self: DictionaryEntry) = value - """ - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the value in the key/value pair. - - Get: Value(self: DictionaryEntry) -> object - - Set: Value(self: DictionaryEntry) = value - """ - - - -class Hashtable(object, IDictionary, ICollection, IEnumerable, ISerializable, IDeserializationCallback, ICloneable): - """ - Represents a collection of key/value pairs that are organized based on the hash code of the key. - - Hashtable() - Hashtable(capacity: int) - Hashtable(capacity: int, loadFactor: Single) - Hashtable(capacity: int, loadFactor: Single, hcp: IHashCodeProvider, comparer: IComparer) - Hashtable(capacity: int, loadFactor: Single, equalityComparer: IEqualityComparer) - Hashtable(hcp: IHashCodeProvider, comparer: IComparer) - Hashtable(equalityComparer: IEqualityComparer) - Hashtable(capacity: int, hcp: IHashCodeProvider, comparer: IComparer) - Hashtable(capacity: int, equalityComparer: IEqualityComparer) - Hashtable(d: IDictionary) - Hashtable(d: IDictionary, loadFactor: Single) - Hashtable(d: IDictionary, hcp: IHashCodeProvider, comparer: IComparer) - Hashtable(d: IDictionary, equalityComparer: IEqualityComparer) - Hashtable(d: IDictionary, loadFactor: Single, hcp: IHashCodeProvider, comparer: IComparer) - Hashtable(d: IDictionary, loadFactor: Single, equalityComparer: IEqualityComparer) - """ - def Add(self, key, value): - # type: (self: Hashtable, key: object, value: object) - """ - Add(self: Hashtable, key: object, value: object) - Adds an element with the specified key and value into the System.Collections.Hashtable. - - key: The key of the element to add. - value: The value of the element to add. The value can be null. - """ - pass - - def Clear(self): - # type: (self: Hashtable) - """ - Clear(self: Hashtable) - Removes all elements from the System.Collections.Hashtable. - """ - pass - - def Clone(self): - # type: (self: Hashtable) -> object - """ - Clone(self: Hashtable) -> object - - Creates a shallow copy of the System.Collections.Hashtable. - Returns: A shallow copy of the System.Collections.Hashtable. - """ - pass - - def Contains(self, key): - # type: (self: Hashtable, key: object) -> bool - """ - Contains(self: Hashtable, key: object) -> bool - - Determines whether the System.Collections.Hashtable contains a specific key. - - key: The key to locate in the System.Collections.Hashtable. - Returns: true if the System.Collections.Hashtable contains an element with the specified key; otherwise, false. - """ - pass - - def ContainsKey(self, key): - # type: (self: Hashtable, key: object) -> bool - """ - ContainsKey(self: Hashtable, key: object) -> bool - - Determines whether the System.Collections.Hashtable contains a specific key. - - key: The key to locate in the System.Collections.Hashtable. - Returns: true if the System.Collections.Hashtable contains an element with the specified key; otherwise, false. - """ - pass - - def ContainsValue(self, value): - # type: (self: Hashtable, value: object) -> bool - """ - ContainsValue(self: Hashtable, value: object) -> bool - - Determines whether the System.Collections.Hashtable contains a specific value. - - value: The value to locate in the System.Collections.Hashtable. The value can be null. - Returns: true if the System.Collections.Hashtable contains an element with the specified value; otherwise, false. - """ - pass - - def CopyTo(self, array, arrayIndex): - # type: (self: Hashtable, array: Array, arrayIndex: int) - """ - CopyTo(self: Hashtable, array: Array, arrayIndex: int) - Copies the System.Collections.Hashtable elements to a one-dimensional System.Array instance at the specified index. - - array: The one-dimensional System.Array that is the destination of the System.Collections.DictionaryEntry objects copied from System.Collections.Hashtable. The System.Array must have zero-based indexing. - arrayIndex: The zero-based index in array at which copying begins. - """ - pass - - def GetEnumerator(self): - # type: (self: Hashtable) -> IDictionaryEnumerator - """ - GetEnumerator(self: Hashtable) -> IDictionaryEnumerator - - Returns an System.Collections.IDictionaryEnumerator that iterates through the System.Collections.Hashtable. - Returns: An System.Collections.IDictionaryEnumerator for the System.Collections.Hashtable. - """ - pass - - def GetHash(self, *args): #cannot find CLR method - # type: (self: Hashtable, key: object) -> int - """ - GetHash(self: Hashtable, key: object) -> int - - Returns the hash code for the specified key. - - key: The System.Object for which a hash code is to be returned. - Returns: The hash code for key. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: Hashtable, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: Hashtable, info: SerializationInfo, context: StreamingContext) - Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.Collections.Hashtable. - - info: A System.Runtime.Serialization.SerializationInfo object containing the information required to serialize the System.Collections.Hashtable. - context: A System.Runtime.Serialization.StreamingContext object containing the source and destination of the serialized stream associated with the System.Collections.Hashtable. - """ - pass - - def KeyEquals(self, *args): #cannot find CLR method - # type: (self: Hashtable, item: object, key: object) -> bool - """ - KeyEquals(self: Hashtable, item: object, key: object) -> bool - - Compares a specific System.Object with a specific key in the System.Collections.Hashtable. - - item: The System.Object to compare with key. - key: The key in the System.Collections.Hashtable to compare with item. - Returns: true if item and key are equal; otherwise, false. - """ - pass - - def OnDeserialization(self, sender): - # type: (self: Hashtable, sender: object) - """ - OnDeserialization(self: Hashtable, sender: object) - Implements the System.Runtime.Serialization.ISerializable interface and raises the deserialization event when the deserialization is complete. - - sender: The source of the deserialization event. - """ - pass - - def Remove(self, key): - # type: (self: Hashtable, key: object) - """ - Remove(self: Hashtable, key: object) - Removes the element with the specified key from the System.Collections.Hashtable. - - key: The key of the element to remove. - """ - pass - - @staticmethod - def Synchronized(table): - # type: (table: Hashtable) -> Hashtable - """ - Synchronized(table: Hashtable) -> Hashtable - - Returns a synchronized (thread-safe) wrapper for the System.Collections.Hashtable. - - table: The System.Collections.Hashtable to synchronize. - Returns: A synchronized (thread-safe) wrapper for the System.Collections.Hashtable. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, capacity: int) - __new__(cls: type, capacity: int, loadFactor: Single) - __new__(cls: type, capacity: int, loadFactor: Single, hcp: IHashCodeProvider, comparer: IComparer) - __new__(cls: type, capacity: int, loadFactor: Single, equalityComparer: IEqualityComparer) - __new__(cls: type, hcp: IHashCodeProvider, comparer: IComparer) - __new__(cls: type, equalityComparer: IEqualityComparer) - __new__(cls: type, capacity: int, hcp: IHashCodeProvider, comparer: IComparer) - __new__(cls: type, capacity: int, equalityComparer: IEqualityComparer) - __new__(cls: type, d: IDictionary) - __new__(cls: type, d: IDictionary, loadFactor: Single) - __new__(cls: type, d: IDictionary, hcp: IHashCodeProvider, comparer: IComparer) - __new__(cls: type, d: IDictionary, equalityComparer: IEqualityComparer) - __new__(cls: type, d: IDictionary, loadFactor: Single, hcp: IHashCodeProvider, comparer: IComparer) - __new__(cls: type, d: IDictionary, loadFactor: Single, equalityComparer: IEqualityComparer) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - comparer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the System.Collections.IComparer to use for the System.Collections.Hashtable. """ - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of key/value pairs contained in the System.Collections.Hashtable. - - Get: Count(self: Hashtable) -> int - """ - - EqualityComparer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Collections.IEqualityComparer to use for the System.Collections.Hashtable. """ - - hcp = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the object that can dispense hash codes. """ - - IsFixedSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.Hashtable has a fixed size. - - Get: IsFixedSize(self: Hashtable) -> bool - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Collections.Hashtable is read-only. - - Get: IsReadOnly(self: Hashtable) -> bool - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether access to the System.Collections.Hashtable is synchronized (thread safe). - - Get: IsSynchronized(self: Hashtable) -> bool - """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.ICollection containing the keys in the System.Collections.Hashtable. - - Get: Keys(self: Hashtable) -> ICollection - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to the System.Collections.Hashtable. - - Get: SyncRoot(self: Hashtable) -> object - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Collections.ICollection containing the values in the System.Collections.Hashtable. - - Get: Values(self: Hashtable) -> ICollection - """ - - - -class IComparer: - """ Exposes a method that compares two objects. """ - def Compare(self, x, y): - # type: (self: IComparer, x: object, y: object) -> int - """ - Compare(self: IComparer, x: object, y: object) -> int - - Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. - - x: The first object to compare. - y: The second object to compare. - Returns: A signed integer that indicates the relative values of x and y, as shown in the following table.Value Meaning Less than zero x is less than y. Zero x equals y. Greater than zero x is greater than y. - """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IEnumerator: - """ Supports a simple iteration over a nongeneric collection. """ - def MoveNext(self): - # type: (self: IEnumerator) -> bool - """ - MoveNext(self: IEnumerator) -> bool - - Advances the enumerator to the next element of the collection. - Returns: true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - """ - pass - - def next(self, *args): #cannot find CLR method - # type: (self: object) -> object - """ next(self: object) -> object """ - pass - - def Reset(self): - # type: (self: IEnumerator) - """ - Reset(self: IEnumerator) - Sets the enumerator to its initial position, which is before the first element in the collection. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerator) -> object """ - pass - - Current = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the current element in the collection. - - Get: Current(self: IEnumerator) -> object - """ - - - -class IDictionaryEnumerator(IEnumerator): - """ Enumerates the elements of a nongeneric dictionary. """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Entry = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets both the key and the value of the current dictionary entry. - - Get: Entry(self: IDictionaryEnumerator) -> DictionaryEntry - """ - - Key = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the key of the current dictionary entry. - - Get: Key(self: IDictionaryEnumerator) -> object - """ - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the current dictionary entry. - - Get: Value(self: IDictionaryEnumerator) -> object - """ - - - -class IEqualityComparer: - """ Defines methods to support the comparison of objects for equality. """ - def Equals(self, x, y): - # type: (self: IEqualityComparer, x: object, y: object) -> bool - """ - Equals(self: IEqualityComparer, x: object, y: object) -> bool - - Determines whether the specified objects are equal. - - x: The first object to compare. - y: The second object to compare. - Returns: true if the specified objects are equal; otherwise, false. - """ - pass - - def GetHashCode(self, obj): - # type: (self: IEqualityComparer, obj: object) -> int - """ - GetHashCode(self: IEqualityComparer, obj: object) -> int - - Returns a hash code for the specified object. - - obj: The System.Object for which a hash code is to be returned. - Returns: A hash code for the specified object. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IHashCodeProvider: - """ Supplies a hash code for an object, using a custom hash function. """ - def GetHashCode(self, obj): - # type: (self: IHashCodeProvider, obj: object) -> int - """ - GetHashCode(self: IHashCodeProvider, obj: object) -> int - - Returns a hash code for the specified object. - - obj: The System.Object for which a hash code is to be returned. - Returns: A hash code for the specified object. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IStructuralComparable: - """ Supports the structural comparison of collection objects. """ - def CompareTo(self, other, comparer): - # type: (self: IStructuralComparable, other: object, comparer: IComparer) -> int - """ - CompareTo(self: IStructuralComparable, other: object, comparer: IComparer) -> int - - Determines whether the current collection object precedes, occurs in the same position as, or follows another object in the sort order. - - other: The object to compare with the current instance. - comparer: An object that compares members of the current collection object with the corresponding members of other. - Returns: An integer that indicates the relationship of the current collection object to other, as shown in the following table.Return valueDescription-1The current instance precedes other.0The current instance and other are equal.1The current instance follows - other. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - -class IStructuralEquatable: - """ Defines methods to support the comparison of objects for structural equality. """ - def Equals(self, other, comparer): - # type: (self: IStructuralEquatable, other: object, comparer: IEqualityComparer) -> bool - """ - Equals(self: IStructuralEquatable, other: object, comparer: IEqualityComparer) -> bool - - Determines whether an object is structurally equal to the current instance. - - other: The object to compare with the current instance. - comparer: An object that determines whether the current instance and other are equal. - Returns: true if the two objects are equal; otherwise, false. - """ - pass - - def GetHashCode(self, comparer): - # type: (self: IStructuralEquatable, comparer: IEqualityComparer) -> int - """ - GetHashCode(self: IStructuralEquatable, comparer: IEqualityComparer) -> int - - Returns a hash code for the current instance. - - comparer: An object that computes the hash code of the current object. - Returns: The hash code for the current instance. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - -class Queue(object, ICollection, IEnumerable, ICloneable): - """ - Represents a first-in, first-out collection of objects. - - Queue() - Queue(capacity: int) - Queue(capacity: int, growFactor: Single) - Queue(col: ICollection) - """ - def Clear(self): - # type: (self: Queue) - """ - Clear(self: Queue) - Removes all objects from the System.Collections.Queue. - """ - pass - - def Clone(self): - # type: (self: Queue) -> object - """ - Clone(self: Queue) -> object - - Creates a shallow copy of the System.Collections.Queue. - Returns: A shallow copy of the System.Collections.Queue. - """ - pass - - def Contains(self, obj): - # type: (self: Queue, obj: object) -> bool - """ - Contains(self: Queue, obj: object) -> bool - - Determines whether an element is in the System.Collections.Queue. - - obj: The System.Object to locate in the System.Collections.Queue. The value can be null. - Returns: true if obj is found in the System.Collections.Queue; otherwise, false. - """ - pass - - def CopyTo(self, array, index): - # type: (self: Queue, array: Array, index: int) - """ - CopyTo(self: Queue, array: Array, index: int) - Copies the System.Collections.Queue elements to an existing one-dimensional System.Array, starting at the specified array index. - - array: The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Queue. The System.Array must have zero-based indexing. - index: The zero-based index in array at which copying begins. - """ - pass - - def Dequeue(self): - # type: (self: Queue) -> object - """ - Dequeue(self: Queue) -> object - - Removes and returns the object at the beginning of the System.Collections.Queue. - Returns: The object that is removed from the beginning of the System.Collections.Queue. - """ - pass - - def Enqueue(self, obj): - # type: (self: Queue, obj: object) - """ - Enqueue(self: Queue, obj: object) - Adds an object to the end of the System.Collections.Queue. - - obj: The object to add to the System.Collections.Queue. The value can be null. - """ - pass - - def GetEnumerator(self): - # type: (self: Queue) -> IEnumerator - """ - GetEnumerator(self: Queue) -> IEnumerator - - Returns an enumerator that iterates through the System.Collections.Queue. - Returns: An System.Collections.IEnumerator for the System.Collections.Queue. - """ - pass - - def Peek(self): - # type: (self: Queue) -> object - """ - Peek(self: Queue) -> object - - Returns the object at the beginning of the System.Collections.Queue without removing it. - Returns: The object at the beginning of the System.Collections.Queue. - """ - pass - - @staticmethod - def Synchronized(queue): - # type: (queue: Queue) -> Queue - """ - Synchronized(queue: Queue) -> Queue - - Returns a System.Collections.Queue wrapper that is synchronized (thread safe). - - queue: The System.Collections.Queue to synchronize. - Returns: A System.Collections.Queue wrapper that is synchronized (thread safe). - """ - pass - - def ToArray(self): - # type: (self: Queue) -> Array[object] - """ - ToArray(self: Queue) -> Array[object] - - Copies the System.Collections.Queue elements to a new array. - Returns: A new array containing elements copied from the System.Collections.Queue. - """ - pass - - def TrimToSize(self): - # type: (self: Queue) - """ - TrimToSize(self: Queue) - Sets the capacity to the actual number of elements in the System.Collections.Queue. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, capacity: int) - __new__(cls: type, capacity: int, growFactor: Single) - __new__(cls: type, col: ICollection) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.Queue. - - Get: Count(self: Queue) -> int - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether access to the System.Collections.Queue is synchronized (thread safe). - - Get: IsSynchronized(self: Queue) -> bool - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to the System.Collections.Queue. - - Get: SyncRoot(self: Queue) -> object - """ - - - -class ReadOnlyCollectionBase(object, ICollection, IEnumerable): - """ Provides the abstract base class for a strongly typed non-generic read-only collection. """ - def GetEnumerator(self): - # type: (self: ReadOnlyCollectionBase) -> IEnumerator - """ - GetEnumerator(self: ReadOnlyCollectionBase) -> IEnumerator - - Returns an enumerator that iterates through the System.Collections.ReadOnlyCollectionBase instance. - Returns: An System.Collections.IEnumerator for the System.Collections.ReadOnlyCollectionBase instance. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.ReadOnlyCollectionBase instance. - - Get: Count(self: ReadOnlyCollectionBase) -> int - """ - - InnerList = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the list of elements contained in the System.Collections.ReadOnlyCollectionBase instance. """ - - - -class SortedList(object, IDictionary, ICollection, IEnumerable, ICloneable): - """ - Represents a collection of key/value pairs that are sorted by the keys and are accessible by key and by index. - - SortedList() - SortedList(initialCapacity: int) - SortedList(comparer: IComparer) - SortedList(comparer: IComparer, capacity: int) - SortedList(d: IDictionary) - SortedList(d: IDictionary, comparer: IComparer) - """ - def Add(self, key, value): - # type: (self: SortedList, key: object, value: object) - """ - Add(self: SortedList, key: object, value: object) - Adds an element with the specified key and value to a System.Collections.SortedList object. - - key: The key of the element to add. - value: The value of the element to add. The value can be null. - """ - pass - - def Clear(self): - # type: (self: SortedList) - """ - Clear(self: SortedList) - Removes all elements from a System.Collections.SortedList object. - """ - pass - - def Clone(self): - # type: (self: SortedList) -> object - """ - Clone(self: SortedList) -> object - - Creates a shallow copy of a System.Collections.SortedList object. - Returns: A shallow copy of the System.Collections.SortedList object. - """ - pass - - def Contains(self, key): - # type: (self: SortedList, key: object) -> bool - """ - Contains(self: SortedList, key: object) -> bool - - Determines whether a System.Collections.SortedList object contains a specific key. - - key: The key to locate in the System.Collections.SortedList object. - Returns: true if the System.Collections.SortedList object contains an element with the specified key; otherwise, false. - """ - pass - - def ContainsKey(self, key): - # type: (self: SortedList, key: object) -> bool - """ - ContainsKey(self: SortedList, key: object) -> bool - - Determines whether a System.Collections.SortedList object contains a specific key. - - key: The key to locate in the System.Collections.SortedList object. - Returns: true if the System.Collections.SortedList object contains an element with the specified key; otherwise, false. - """ - pass - - def ContainsValue(self, value): - # type: (self: SortedList, value: object) -> bool - """ - ContainsValue(self: SortedList, value: object) -> bool - - Determines whether a System.Collections.SortedList object contains a specific value. - - value: The value to locate in the System.Collections.SortedList object. The value can be null. - Returns: true if the System.Collections.SortedList object contains an element with the specified value; otherwise, false. - """ - pass - - def CopyTo(self, array, arrayIndex): - # type: (self: SortedList, array: Array, arrayIndex: int) - """ - CopyTo(self: SortedList, array: Array, arrayIndex: int) - Copies System.Collections.SortedList elements to a one-dimensional System.Array object, starting at the specified index in the array. - - array: The one-dimensional System.Array object that is the destination of the System.Collections.DictionaryEntry objects copied from System.Collections.SortedList. The System.Array must have zero-based indexing. - arrayIndex: The zero-based index in array at which copying begins. - """ - pass - - def GetByIndex(self, index): - # type: (self: SortedList, index: int) -> object - """ - GetByIndex(self: SortedList, index: int) -> object - - Gets the value at the specified index of a System.Collections.SortedList object. - - index: The zero-based index of the value to get. - Returns: The value at the specified index of the System.Collections.SortedList object. - """ - pass - - def GetEnumerator(self): - # type: (self: SortedList) -> IDictionaryEnumerator - """ - GetEnumerator(self: SortedList) -> IDictionaryEnumerator - - Returns an System.Collections.IDictionaryEnumerator object that iterates through a System.Collections.SortedList object. - Returns: An System.Collections.IDictionaryEnumerator object for the System.Collections.SortedList object. - """ - pass - - def GetKey(self, index): - # type: (self: SortedList, index: int) -> object - """ - GetKey(self: SortedList, index: int) -> object - - Gets the key at the specified index of a System.Collections.SortedList object. - - index: The zero-based index of the key to get. - Returns: The key at the specified index of the System.Collections.SortedList object. - """ - pass - - def GetKeyList(self): - # type: (self: SortedList) -> IList - """ - GetKeyList(self: SortedList) -> IList - - Gets the keys in a System.Collections.SortedList object. - Returns: An System.Collections.IList object containing the keys in the System.Collections.SortedList object. - """ - pass - - def GetValueList(self): - # type: (self: SortedList) -> IList - """ - GetValueList(self: SortedList) -> IList - - Gets the values in a System.Collections.SortedList object. - Returns: An System.Collections.IList object containing the values in the System.Collections.SortedList object. - """ - pass - - def IndexOfKey(self, key): - # type: (self: SortedList, key: object) -> int - """ - IndexOfKey(self: SortedList, key: object) -> int - - Returns the zero-based index of the specified key in a System.Collections.SortedList object. - - key: The key to locate in the System.Collections.SortedList object. - Returns: The zero-based index of the key parameter, if key is found in the System.Collections.SortedList object; otherwise, -1. - """ - pass - - def IndexOfValue(self, value): - # type: (self: SortedList, value: object) -> int - """ - IndexOfValue(self: SortedList, value: object) -> int - - Returns the zero-based index of the first occurrence of the specified value in a System.Collections.SortedList object. - - value: The value to locate in the System.Collections.SortedList object. The value can be null. - Returns: The zero-based index of the first occurrence of the value parameter, if value is found in the System.Collections.SortedList object; otherwise, -1. - """ - pass - - def Remove(self, key): - # type: (self: SortedList, key: object) - """ - Remove(self: SortedList, key: object) - Removes the element with the specified key from a System.Collections.SortedList object. - - key: The key of the element to remove. - """ - pass - - def RemoveAt(self, index): - # type: (self: SortedList, index: int) - """ - RemoveAt(self: SortedList, index: int) - Removes the element at the specified index of a System.Collections.SortedList object. - - index: The zero-based index of the element to remove. - """ - pass - - def SetByIndex(self, index, value): - # type: (self: SortedList, index: int, value: object) - """ - SetByIndex(self: SortedList, index: int, value: object) - Replaces the value at a specific index in a System.Collections.SortedList object. - - index: The zero-based index at which to save value. - value: The System.Object to save into the System.Collections.SortedList object. The value can be null. - """ - pass - - @staticmethod - def Synchronized(list): - # type: (list: SortedList) -> SortedList - """ - Synchronized(list: SortedList) -> SortedList - - Returns a synchronized (thread-safe) wrapper for a System.Collections.SortedList object. - - list: The System.Collections.SortedList object to synchronize. - Returns: A synchronized (thread-safe) wrapper for the System.Collections.SortedList object. - """ - pass - - def TrimToSize(self): - # type: (self: SortedList) - """ - TrimToSize(self: SortedList) - Sets the capacity to the actual number of elements in a System.Collections.SortedList object. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IDictionary, key: object) -> bool - - Determines whether the System.Collections.IDictionary object contains an element with the specified key. - - key: The key to locate in the System.Collections.IDictionary object. - Returns: true if the System.Collections.IDictionary contains an element with the key; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, initialCapacity: int) - __new__(cls: type, comparer: IComparer) - __new__(cls: type, comparer: IComparer, capacity: int) - __new__(cls: type, d: IDictionary) - __new__(cls: type, d: IDictionary, comparer: IComparer) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Capacity = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the capacity of a System.Collections.SortedList object. - - Get: Capacity(self: SortedList) -> int - - Set: Capacity(self: SortedList) = value - """ - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in a System.Collections.SortedList object. - - Get: Count(self: SortedList) -> int - """ - - IsFixedSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether a System.Collections.SortedList object has a fixed size. - - Get: IsFixedSize(self: SortedList) -> bool - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether a System.Collections.SortedList object is read-only. - - Get: IsReadOnly(self: SortedList) -> bool - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether access to a System.Collections.SortedList object is synchronized (thread safe). - - Get: IsSynchronized(self: SortedList) -> bool - """ - - Keys = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the keys in a System.Collections.SortedList object. - - Get: Keys(self: SortedList) -> ICollection - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to a System.Collections.SortedList object. - - Get: SyncRoot(self: SortedList) -> object - """ - - Values = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the values in a System.Collections.SortedList object. - - Get: Values(self: SortedList) -> ICollection - """ - - - -class Stack(object, ICollection, IEnumerable, ICloneable): - # type: (LIFO) non-generic collection of objects. - """ - Represents a simple last-in-first-out (LIFO) non-generic collection of objects. - - Stack() - Stack(initialCapacity: int) - Stack(col: ICollection) - """ - def Clear(self): - # type: (self: Stack) - """ - Clear(self: Stack) - Removes all objects from the System.Collections.Stack. - """ - pass - - def Clone(self): - # type: (self: Stack) -> object - """ - Clone(self: Stack) -> object - - Creates a shallow copy of the System.Collections.Stack. - Returns: A shallow copy of the System.Collections.Stack. - """ - pass - - def Contains(self, obj): - # type: (self: Stack, obj: object) -> bool - """ - Contains(self: Stack, obj: object) -> bool - - Determines whether an element is in the System.Collections.Stack. - - obj: The System.Object to locate in the System.Collections.Stack. The value can be null. - Returns: true, if obj is found in the System.Collections.Stack; otherwise, false. - """ - pass - - def CopyTo(self, array, index): - # type: (self: Stack, array: Array, index: int) - """ - CopyTo(self: Stack, array: Array, index: int) - Copies the System.Collections.Stack to an existing one-dimensional System.Array, starting at the specified array index. - - array: The one-dimensional System.Array that is the destination of the elements copied from System.Collections.Stack. The System.Array must have zero-based indexing. - index: The zero-based index in array at which copying begins. - """ - pass - - def GetEnumerator(self): - # type: (self: Stack) -> IEnumerator - """ - GetEnumerator(self: Stack) -> IEnumerator - - Returns an System.Collections.IEnumerator for the System.Collections.Stack. - Returns: An System.Collections.IEnumerator for the System.Collections.Stack. - """ - pass - - def Peek(self): - # type: (self: Stack) -> object - """ - Peek(self: Stack) -> object - - Returns the object at the top of the System.Collections.Stack without removing it. - Returns: The System.Object at the top of the System.Collections.Stack. - """ - pass - - def Pop(self): - # type: (self: Stack) -> object - """ - Pop(self: Stack) -> object - - Removes and returns the object at the top of the System.Collections.Stack. - Returns: The System.Object removed from the top of the System.Collections.Stack. - """ - pass - - def Push(self, obj): - # type: (self: Stack, obj: object) - """ - Push(self: Stack, obj: object) - Inserts an object at the top of the System.Collections.Stack. - - obj: The System.Object to push onto the System.Collections.Stack. The value can be null. - """ - pass - - @staticmethod - def Synchronized(stack): - # type: (stack: Stack) -> Stack - """ - Synchronized(stack: Stack) -> Stack - - Returns a synchronized (thread safe) wrapper for the System.Collections.Stack. - - stack: The System.Collections.Stack to synchronize. - Returns: A synchronized wrapper around the System.Collections.Stack. - """ - pass - - def ToArray(self): - # type: (self: Stack) -> Array[object] - """ - ToArray(self: Stack) -> Array[object] - - Copies the System.Collections.Stack to a new array. - Returns: A new array containing copies of the elements of the System.Collections.Stack. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, initialCapacity: int) - __new__(cls: type, col: ICollection) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements contained in the System.Collections.Stack. - - Get: Count(self: Stack) -> int - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether access to the System.Collections.Stack is synchronized (thread safe). - - Get: IsSynchronized(self: Stack) -> bool - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to the System.Collections.Stack. - - Get: SyncRoot(self: Stack) -> object - """ - - - -class StructuralComparisons(object): - """ Provides objects for performing a structural comparison of two collection objects. """ - StructuralComparer = None - StructuralEqualityComparer = None - __all__ = [] - - -# variables with complex values - diff --git a/pyesapi/stubs/System/Configuration.py b/pyesapi/stubs/System/Configuration.py deleted file mode 100644 index 02766ee..0000000 --- a/pyesapi/stubs/System/Configuration.py +++ /dev/null @@ -1,3565 +0,0 @@ -# encoding: utf-8 -# module System.Configuration calls itself Configuration -# from mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class SettingAttribute(Attribute, _Attribute): - """ - Represents a custom settings attribute used to associate settings information with a settings property. - - SettingAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class ApplicationScopedSettingAttribute(SettingAttribute, _Attribute): - """ - Specifies that an application settings property has a common value for all users of an application. This class cannot be inherited. - - ApplicationScopedSettingAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class SettingsBase(object): - """ Provides the base class used to support user property settings. """ - def Initialize(self, context, properties, providers): - # type: (self: SettingsBase, context: SettingsContext, properties: SettingsPropertyCollection, providers: SettingsProviderCollection) - """ - Initialize(self: SettingsBase, context: SettingsContext, properties: SettingsPropertyCollection, providers: SettingsProviderCollection) - Initializes internal properties used by System.Configuration.SettingsBase object. - - context: The settings context related to the settings properties. - properties: The settings properties that will be accessible from the System.Configuration.SettingsBase instance. - providers: The initialized providers that should be used when loading and saving property values. - """ - pass - - def Save(self): - # type: (self: SettingsBase) - """ - Save(self: SettingsBase) - Stores the current values of the settings properties. - """ - pass - - @staticmethod - def Synchronized(settingsBase): - # type: (settingsBase: SettingsBase) -> SettingsBase - """ - Synchronized(settingsBase: SettingsBase) -> SettingsBase - - Provides a System.Configuration.SettingsBase class that is synchronized (thread safe). - - settingsBase: The class used to support user property settings. - Returns: A System.Configuration.SettingsBase class that is synchronized. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Context = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the associated settings context. - - Get: Context(self: SettingsBase) -> SettingsContext - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether access to the object is synchronized (thread safe). - - Get: IsSynchronized(self: SettingsBase) -> bool - """ - - Properties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the collection of settings properties. - - Get: Properties(self: SettingsBase) -> SettingsPropertyCollection - """ - - PropertyValues = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection of settings property values. - - Get: PropertyValues(self: SettingsBase) -> SettingsPropertyValueCollection - """ - - Providers = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection of settings providers. - - Get: Providers(self: SettingsBase) -> SettingsProviderCollection - """ - - - -class ApplicationSettingsBase(SettingsBase, INotifyPropertyChanged): - """ Acts as a base class for deriving concrete wrapper classes to implement the application settings feature in Window Forms applications. """ - def GetPreviousVersion(self, propertyName): - # type: (self: ApplicationSettingsBase, propertyName: str) -> object - """ - GetPreviousVersion(self: ApplicationSettingsBase, propertyName: str) -> object - - Returns the value of the named settings property for the previous version of the same application. - - propertyName: A System.String containing the name of the settings property whose value is to be returned. - Returns: An System.Object containing the value of the specified System.Configuration.SettingsProperty if found; otherwise, null. - """ - pass - - def OnPropertyChanged(self, *args): #cannot find CLR method - # type: (self: ApplicationSettingsBase, sender: object, e: PropertyChangedEventArgs) - """ - OnPropertyChanged(self: ApplicationSettingsBase, sender: object, e: PropertyChangedEventArgs) - Raises the System.Configuration.ApplicationSettingsBase.PropertyChanged event. - - sender: The source of the event. - e: A System.ComponentModel.PropertyChangedEventArgs that contains the event data. - """ - pass - - def OnSettingChanging(self, *args): #cannot find CLR method - # type: (self: ApplicationSettingsBase, sender: object, e: SettingChangingEventArgs) - """ - OnSettingChanging(self: ApplicationSettingsBase, sender: object, e: SettingChangingEventArgs) - Raises the System.Configuration.ApplicationSettingsBase.SettingChanging event. - - sender: The source of the event. - e: A System.Configuration.SettingChangingEventArgs that contains the event data. - """ - pass - - def OnSettingsLoaded(self, *args): #cannot find CLR method - # type: (self: ApplicationSettingsBase, sender: object, e: SettingsLoadedEventArgs) - """ - OnSettingsLoaded(self: ApplicationSettingsBase, sender: object, e: SettingsLoadedEventArgs) - Raises the System.Configuration.ApplicationSettingsBase.SettingsLoaded event. - - sender: The source of the event. - e: A System.Configuration.SettingsLoadedEventArgs that contains the event data. - """ - pass - - def OnSettingsSaving(self, *args): #cannot find CLR method - # type: (self: ApplicationSettingsBase, sender: object, e: CancelEventArgs) - """ - OnSettingsSaving(self: ApplicationSettingsBase, sender: object, e: CancelEventArgs) - Raises the System.Configuration.ApplicationSettingsBase.SettingsSaving event. - - sender: The source of the event. - e: A System.ComponentModel.CancelEventArgs that contains the event data. - """ - pass - - def Reload(self): - # type: (self: ApplicationSettingsBase) - """ - Reload(self: ApplicationSettingsBase) - Refreshes the application settings property values from persistent storage. - """ - pass - - def Reset(self): - # type: (self: ApplicationSettingsBase) - """ - Reset(self: ApplicationSettingsBase) - Restores the persisted application settings values to their corresponding default properties. - """ - pass - - def Save(self): - # type: (self: ApplicationSettingsBase) - """ - Save(self: ApplicationSettingsBase) - Stores the current values of the application settings properties. - """ - pass - - def Upgrade(self): - # type: (self: ApplicationSettingsBase) - """ - Upgrade(self: ApplicationSettingsBase) - Updates application settings to reflect a more recent installation of the application. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) - __new__(cls: type, owner: IComponent) - __new__(cls: type, settingsKey: str) - __new__(cls: type, owner: IComponent, settingsKey: str) - """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - Context = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the application settings context associated with the settings group. - - Get: Context(self: ApplicationSettingsBase) -> SettingsContext - """ - - Properties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the collection of settings properties in the wrapper. - - Get: Properties(self: ApplicationSettingsBase) -> SettingsPropertyCollection - """ - - PropertyValues = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection of property values. - - Get: PropertyValues(self: ApplicationSettingsBase) -> SettingsPropertyValueCollection - """ - - Providers = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the collection of application settings providers used by the wrapper. - - Get: Providers(self: ApplicationSettingsBase) -> SettingsProviderCollection - """ - - SettingsKey = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the settings key for the application settings group. - - Get: SettingsKey(self: ApplicationSettingsBase) -> str - - Set: SettingsKey(self: ApplicationSettingsBase) = value - """ - - - PropertyChanged = None - SettingChanging = None - SettingsLoaded = None - SettingsSaving = None - - -class ApplicationSettingsGroup(ConfigurationSectionGroup): - """ - Represents a grouping of related application settings sections within a configuration file. This class cannot be inherited. - - ApplicationSettingsGroup() - """ - -class AppSettingsReader(object): - """ - Provides a method for reading values of a particular type from the configuration. - - AppSettingsReader() - """ - def GetValue(self, key, type): - # type: (self: AppSettingsReader, key: str, type: Type) -> object - """ - GetValue(self: AppSettingsReader, key: str, type: Type) -> object - - Gets the value for a specified key from the System.Configuration.ConfigurationSettings.AppSettings property and returns an object of the specified type containing the value from the configuration. - - key: The key for which to get the value. - type: The type of the object to return. - Returns: The value of the specified key. - """ - pass - - -class ClientSettingsSection(ConfigurationSection): - """ - Represents a group of user-scoped application settings in a configuration file. - - ClientSettingsSection() - """ - ElementProperty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ConfigurationElementProperty object that represents the System.Configuration.ConfigurationElement object itself. """ - - EvaluationContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ContextInformation object for the System.Configuration.ConfigurationElement object. """ - - HasContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - Properties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - Settings = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the collection of client settings for the section. - - Get: Settings(self: ClientSettingsSection) -> SettingElementCollection - """ - - - -class ConfigurationException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when a configuration system error has occurred. - - ConfigurationException() - ConfigurationException(message: str) - ConfigurationException(message: str, inner: Exception) - ConfigurationException(message: str, node: XmlNode) - ConfigurationException(message: str, inner: Exception, node: XmlNode) - ConfigurationException(message: str, filename: str, line: int) - ConfigurationException(message: str, inner: Exception, filename: str, line: int) - """ - def GetObjectData(self, info, context): - # type: (self: ConfigurationException, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: ConfigurationException, info: SerializationInfo, context: StreamingContext) - Sets the System.Runtime.Serialization.SerializationInfo object with the file name and line number at which this configuration exception occurred. - - info: The object that holds the information to be serialized. - context: The contextual information about the source or destination. - """ - pass - - @staticmethod - def GetXmlNodeFilename(node): - # type: (node: XmlNode) -> str - """ - GetXmlNodeFilename(node: XmlNode) -> str - - Gets the path to the configuration file from which the internal System.Xml.XmlNode object was loaded when this configuration exception was thrown. - - node: The System.Xml.XmlNode that caused this System.Configuration.ConfigurationException exception to be thrown. - Returns: A string representing the node file name. - """ - pass - - @staticmethod - def GetXmlNodeLineNumber(node): - # type: (node: XmlNode) -> int - """ - GetXmlNodeLineNumber(node: XmlNode) -> int - - Gets the line number within the configuration file that the internal System.Xml.XmlNode object represented when this configuration exception was thrown. - - node: The System.Xml.XmlNode that caused this System.Configuration.ConfigurationException exception to be thrown. - Returns: An int representing the node line number. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, *__args): - """ - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, message: str, node: XmlNode) - __new__(cls: type, message: str, inner: Exception, node: XmlNode) - __new__(cls: type, message: str, filename: str, line: int) - __new__(cls: type, message: str, inner: Exception, filename: str, line: int) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - BareMessage = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a description of why this configuration exception was thrown. - - Get: BareMessage(self: ConfigurationException) -> str - """ - - Filename = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the path to the configuration file that caused this configuration exception to be thrown. - - Get: Filename(self: ConfigurationException) -> str - """ - - Line = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the line number within the configuration file at which this configuration exception was thrown. - - Get: Line(self: ConfigurationException) -> int - """ - - Message = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an extended description of why this configuration exception was thrown. - - Get: Message(self: ConfigurationException) -> str - """ - - - SerializeObjectState = None - - -class ConfigurationSettings(object): - """ Provides runtime versions 1.0 and 1.1 support for reading configuration sections and common configuration settings. """ - @staticmethod - def GetConfig(sectionName): - # type: (sectionName: str) -> object - """ - GetConfig(sectionName: str) -> object - - Returns the System.Configuration.ConfigurationSection object for the passed configuration section name and path. - - sectionName: A configuration name and path, such as "system.net/settings". - Returns: The System.Configuration.ConfigurationSection object for the passed configuration section name and path.NoteThe System.Configuration.ConfigurationSettings class provides backward compatibility only. You should use the - System.Configuration.ConfigurationManager class or System.Web.Configuration.WebConfigurationManager class instead. - """ - pass - - AppSettings = None - - -class ConfigXmlDocument(XmlDocument, ICloneable, IEnumerable, IXPathNavigable, IConfigErrorInfo): - """ - Wraps the corresponding System.Xml.XmlDocument type and also carries the necessary information for reporting file-name and line numbers. - - ConfigXmlDocument() - """ - def CreateAttribute(self, *__args): - # type: (self: ConfigXmlDocument, prefix: str, localName: str, namespaceUri: str) -> XmlAttribute - """ - CreateAttribute(self: ConfigXmlDocument, prefix: str, localName: str, namespaceUri: str) -> XmlAttribute - - Creates a configuration element attribute. - - prefix: The prefix definition. - localName: The name that is used locally. - namespaceUri: The URL that is assigned to the namespace. - Returns: The System.Xml.Serialization.XmlAttributes.XmlAttribute attribute. - """ - pass - - def CreateCDataSection(self, data): - # type: (self: ConfigXmlDocument, data: str) -> XmlCDataSection - """ - CreateCDataSection(self: ConfigXmlDocument, data: str) -> XmlCDataSection - - Creates an XML CData section. - - data: The data to use. - Returns: The System.Xml.XmlCDataSection value. - """ - pass - - def CreateComment(self, data): - # type: (self: ConfigXmlDocument, data: str) -> XmlComment - """ - CreateComment(self: ConfigXmlDocument, data: str) -> XmlComment - - Create an XML comment. - - data: The comment data. - Returns: The System.Xml.XmlComment value. - """ - pass - - def CreateDefaultAttribute(self, *args): #cannot find CLR method - # type: (self: XmlDocument, prefix: str, localName: str, namespaceURI: str) -> XmlAttribute - """ - CreateDefaultAttribute(self: XmlDocument, prefix: str, localName: str, namespaceURI: str) -> XmlAttribute - - Creates a default attribute with the specified prefix, local name and namespace URI. - - prefix: The prefix of the attribute (if any). - localName: The local name of the attribute. - namespaceURI: The namespace URI of the attribute (if any). - Returns: The new System.Xml.XmlAttribute. - """ - pass - - def CreateElement(self, *__args): - # type: (self: ConfigXmlDocument, prefix: str, localName: str, namespaceUri: str) -> XmlElement - """ - CreateElement(self: ConfigXmlDocument, prefix: str, localName: str, namespaceUri: str) -> XmlElement - - Creates a configuration element. - - prefix: The prefix definition. - localName: The name used locally. - namespaceUri: The namespace for the URL. - Returns: The System.Xml.XmlElement value. - """ - pass - - def CreateNavigator(self): - # type: (self: XmlDocument, node: XmlNode) -> XPathNavigator - """ - CreateNavigator(self: XmlDocument, node: XmlNode) -> XPathNavigator - - Creates an System.Xml.XPath.XPathNavigator object for navigating this document positioned on the System.Xml.XmlNode specified. - - node: The System.Xml.XmlNode you want the navigator initially positioned on. - Returns: An System.Xml.XPath.XPathNavigator object. - """ - pass - - def CreateSignificantWhitespace(self, data): - # type: (self: ConfigXmlDocument, data: str) -> XmlSignificantWhitespace - """ - CreateSignificantWhitespace(self: ConfigXmlDocument, data: str) -> XmlSignificantWhitespace - - Creates white spaces. - - data: The data to use. - Returns: The System.Xml.XmlSignificantWhitespace value. - """ - pass - - def CreateTextNode(self, text): - # type: (self: ConfigXmlDocument, text: str) -> XmlText - """ - CreateTextNode(self: ConfigXmlDocument, text: str) -> XmlText - - Create a text node. - - text: The text to use. - Returns: The System.Xml.XmlText value. - """ - pass - - def CreateWhitespace(self, data): - # type: (self: ConfigXmlDocument, data: str) -> XmlWhitespace - """ - CreateWhitespace(self: ConfigXmlDocument, data: str) -> XmlWhitespace - - Creates white space. - - data: The data to use. - Returns: The System.Xml.XmlWhitespace value. - """ - pass - - def Load(self, *__args): - # type: (self: ConfigXmlDocument, filename: str) - """ - Load(self: ConfigXmlDocument, filename: str) - Loads the configuration file. - - filename: The name of the file. - """ - pass - - def LoadSingleElement(self, filename, sourceReader): - # type: (self: ConfigXmlDocument, filename: str, sourceReader: XmlTextReader) - """ - LoadSingleElement(self: ConfigXmlDocument, filename: str, sourceReader: XmlTextReader) - Loads a single configuration element. - - filename: The name of the file. - sourceReader: The source for the reader. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y]x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - Filename = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the configuration file name. - - Get: Filename(self: ConfigXmlDocument) -> str - """ - - LineNumber = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the current node line number. - - Get: LineNumber(self: ConfigXmlDocument) -> int - """ - - - -class DefaultSettingValueAttribute(Attribute, _Attribute): - """ - Specifies the default value for an application settings property. - - DefaultSettingValueAttribute(value: str) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, value): - """ __new__(cls: type, value: str) """ - pass - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the default value for the application settings property. - - Get: Value(self: DefaultSettingValueAttribute) -> str - """ - - - -class DictionarySectionHandler(object, IConfigurationSectionHandler): - """ - Provides key/value pair configuration information from a configuration section. - - DictionarySectionHandler() - """ - def Create(self, parent, context, section): - # type: (self: DictionarySectionHandler, parent: object, context: object, section: XmlNode) -> object - """ - Create(self: DictionarySectionHandler, parent: object, context: object, section: XmlNode) -> object - - Creates a new configuration handler and adds it to the section-handler collection based on the specified parameters. - - parent: Parent object. - context: Configuration context object. - section: Section XML node. - Returns: A configuration object. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - KeyAttributeName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the XML attribute name to use as the key in a key/value pair. """ - - ValueAttributeName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the XML attribute name to use as the value in a key/value pair. """ - - - -class IApplicationSettingsProvider: - """ Defines extended capabilities for client-based application settings providers. """ - def GetPreviousVersion(self, context, property): - # type: (self: IApplicationSettingsProvider, context: SettingsContext, property: SettingsProperty) -> SettingsPropertyValue - """ - GetPreviousVersion(self: IApplicationSettingsProvider, context: SettingsContext, property: SettingsProperty) -> SettingsPropertyValue - - Returns the value of the specified settings property for the previous version of the same application. - - context: A System.Configuration.SettingsContext describing the current application usage. - property: The System.Configuration.SettingsProperty whose value is to be returned. - Returns: A System.Configuration.SettingsPropertyValue containing the value of the specified property setting as it was last set in the previous version of the application; or null if the setting cannot be found. - """ - pass - - def Reset(self, context): - # type: (self: IApplicationSettingsProvider, context: SettingsContext) - """ - Reset(self: IApplicationSettingsProvider, context: SettingsContext) - Resets the application settings associated with the specified application to their default values. - - context: A System.Configuration.SettingsContext describing the current application usage. - """ - pass - - def Upgrade(self, context, properties): - # type: (self: IApplicationSettingsProvider, context: SettingsContext, properties: SettingsPropertyCollection) - """ - Upgrade(self: IApplicationSettingsProvider, context: SettingsContext, properties: SettingsPropertyCollection) - Indicates to the provider that the application has been upgraded. This offers the provider an opportunity to upgrade its stored settings as appropriate. - - context: A System.Configuration.SettingsContext describing the current application usage. - properties: A System.Configuration.SettingsPropertyCollection containing the settings property group whose values are to be retrieved. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IConfigurationSectionHandler: - """ Handles the access to certain configuration sections. """ - def Create(self, parent, configContext, section): - # type: (self: IConfigurationSectionHandler, parent: object, configContext: object, section: XmlNode) -> object - """ - Create(self: IConfigurationSectionHandler, parent: object, configContext: object, section: XmlNode) -> object - - Creates a configuration section handler. - - parent: Parent object. - configContext: Configuration context object. - section: Section XML node. - Returns: The created section handler object. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IConfigurationSystem: - """ Provides standard configuration methods. """ - def GetConfig(self, configKey): - # type: (self: IConfigurationSystem, configKey: str) -> object - """ - GetConfig(self: IConfigurationSystem, configKey: str) -> object - - Gets the specified configuration. - - configKey: The configuration key. - Returns: The object representing the configuration. - """ - pass - - def Init(self): - # type: (self: IConfigurationSystem) - """ - Init(self: IConfigurationSystem) - Used for initialization. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IdnElement(ConfigurationElement): - # type: (IDN) processing in the System.Uri class. - """ - Provides the configuration setting for International Domain Name (IDN) processing in the System.Uri class. - - IdnElement() - """ - ElementProperty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ConfigurationElementProperty object that represents the System.Configuration.ConfigurationElement object itself. """ - - Enabled = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the value of the System.Configuration.IdnElement configuration setting. - - Get: Enabled(self: IdnElement) -> UriIdnScope - - Set: Enabled(self: IdnElement) = value - """ - - EvaluationContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ContextInformation object for the System.Configuration.ConfigurationElement object. """ - - HasContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - Properties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - - -class IgnoreSectionHandler(object, IConfigurationSectionHandler): - """ - Provides a legacy section-handler definition for configuration sections that are not handled by the System.Configuration types. - - IgnoreSectionHandler() - """ - def Create(self, parent, configContext, section): - # type: (self: IgnoreSectionHandler, parent: object, configContext: object, section: XmlNode) -> object - """ - Create(self: IgnoreSectionHandler, parent: object, configContext: object, section: XmlNode) -> object - - Creates a new configuration handler and adds the specified configuration object to the section-handler collection. - - parent: The configuration settings in a corresponding parent configuration section. - configContext: The virtual path for which the configuration section handler computes configuration values. Normally this parameter is reserved and is null. - section: An System.Xml.XmlNode that contains the configuration information to be handled. Provides direct access to the XML contents of the configuration section. - Returns: The created configuration handler object. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - -class IPersistComponentSettings: - """ Defines standard functionality for controls or libraries that store and retrieve application settings. """ - def LoadComponentSettings(self): - # type: (self: IPersistComponentSettings) - """ - LoadComponentSettings(self: IPersistComponentSettings) - Reads the control's application settings into their corresponding properties and updates the control's state. - """ - pass - - def ResetComponentSettings(self): - # type: (self: IPersistComponentSettings) - """ - ResetComponentSettings(self: IPersistComponentSettings) - Resets the control's application settings properties to their default values. - """ - pass - - def SaveComponentSettings(self): - # type: (self: IPersistComponentSettings) - """ - SaveComponentSettings(self: IPersistComponentSettings) - Persists the control's application settings properties. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - SaveSettings = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a value indicating whether the control should automatically persist its application settings properties. - - Get: SaveSettings(self: IPersistComponentSettings) -> bool - - Set: SaveSettings(self: IPersistComponentSettings) = value - """ - - SettingsKey = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the value of the application settings key for the current instance of the control. - - Get: SettingsKey(self: IPersistComponentSettings) -> str - - Set: SettingsKey(self: IPersistComponentSettings) = value - """ - - - -class IriParsingElement(ConfigurationElement): - # type: (IRI) processing in the System.Uri class. - """ - Provides the configuration setting for International Resource Identifier (IRI) processing in the System.Uri class. - - IriParsingElement() - """ - ElementProperty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ConfigurationElementProperty object that represents the System.Configuration.ConfigurationElement object itself. """ - - Enabled = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the value of the System.Configuration.IriParsingElement configuration setting. - - Get: Enabled(self: IriParsingElement) -> bool - - Set: Enabled(self: IriParsingElement) = value - """ - - EvaluationContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ContextInformation object for the System.Configuration.ConfigurationElement object. """ - - HasContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - Properties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - - -class ISettingsProviderService: - """ Provides an interface for defining an alternate application settings provider. """ - def GetSettingsProvider(self, property): - # type: (self: ISettingsProviderService, property: SettingsProperty) -> SettingsProvider - """ - GetSettingsProvider(self: ISettingsProviderService, property: SettingsProperty) -> SettingsProvider - - Returns the settings provider compatible with the specified settings property. - - property: The System.Configuration.SettingsProperty that requires serialization. - Returns: If found, the System.Configuration.SettingsProvider that can persist the specified settings property; otherwise, null. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class SettingsProvider(ProviderBase): - """ Acts as a base class for deriving custom settings providers in the application settings architecture. """ - def GetPropertyValues(self, context, collection): - # type: (self: SettingsProvider, context: SettingsContext, collection: SettingsPropertyCollection) -> SettingsPropertyValueCollection - """ - GetPropertyValues(self: SettingsProvider, context: SettingsContext, collection: SettingsPropertyCollection) -> SettingsPropertyValueCollection - - Returns the collection of settings property values for the specified application instance and settings property group. - - context: A System.Configuration.SettingsContext describing the current application use. - collection: A System.Configuration.SettingsPropertyCollection containing the settings property group whose values are to be retrieved. - Returns: A System.Configuration.SettingsPropertyValueCollection containing the values for the specified settings property group. - """ - pass - - def SetPropertyValues(self, context, collection): - # type: (self: SettingsProvider, context: SettingsContext, collection: SettingsPropertyValueCollection) - """ - SetPropertyValues(self: SettingsProvider, context: SettingsContext, collection: SettingsPropertyValueCollection) - Sets the values of the specified group of property settings. - - context: A System.Configuration.SettingsContext describing the current application usage. - collection: A System.Configuration.SettingsPropertyValueCollection representing the group of property settings to set. - """ - pass - - ApplicationName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the name of the currently running application. - - Get: ApplicationName(self: SettingsProvider) -> str - - Set: ApplicationName(self: SettingsProvider) = value - """ - - - -class LocalFileSettingsProvider(SettingsProvider, IApplicationSettingsProvider): - """ - Provides persistence for application settings classes. - - LocalFileSettingsProvider() - """ - def GetPreviousVersion(self, context, property): - # type: (self: LocalFileSettingsProvider, context: SettingsContext, property: SettingsProperty) -> SettingsPropertyValue - """ - GetPreviousVersion(self: LocalFileSettingsProvider, context: SettingsContext, property: SettingsProperty) -> SettingsPropertyValue - - Returns the value of the named settings property for the previous version of the same application. - - context: A System.Configuration.SettingsContext that describes where the application settings property is used. - property: The System.Configuration.SettingsProperty whose value is to be returned. - Returns: A System.Configuration.SettingsPropertyValue representing the application setting if found; otherwise, null. - """ - pass - - def GetPropertyValues(self, context, properties): - # type: (self: LocalFileSettingsProvider, context: SettingsContext, properties: SettingsPropertyCollection) -> SettingsPropertyValueCollection - """ - GetPropertyValues(self: LocalFileSettingsProvider, context: SettingsContext, properties: SettingsPropertyCollection) -> SettingsPropertyValueCollection - - Returns the collection of setting property values for the specified application instance and settings property group. - - context: A System.Configuration.SettingsContext describing the current application usage. - properties: A System.Configuration.SettingsPropertyCollection containing the settings property group whose values are to be retrieved. - Returns: A System.Configuration.SettingsPropertyValueCollection containing the values for the specified settings property group. - """ - pass - - def Initialize(self, name, values): - # type: (self: LocalFileSettingsProvider, name: str, values: NameValueCollection) - """ - Initialize(self: LocalFileSettingsProvider, name: str, values: NameValueCollection) - name: The name of the provider. - values: The values for initialization. - """ - pass - - def Reset(self, context): - # type: (self: LocalFileSettingsProvider, context: SettingsContext) - """ - Reset(self: LocalFileSettingsProvider, context: SettingsContext) - Resets all application settings properties associated with the specified application to their default values. - - context: A System.Configuration.SettingsContext describing the current application usage. - """ - pass - - def SetPropertyValues(self, context, values): - # type: (self: LocalFileSettingsProvider, context: SettingsContext, values: SettingsPropertyValueCollection) - """ - SetPropertyValues(self: LocalFileSettingsProvider, context: SettingsContext, values: SettingsPropertyValueCollection) - Sets the values of the specified group of property settings. - - context: A System.Configuration.SettingsContext describing the current application usage. - values: A System.Configuration.SettingsPropertyValueCollection representing the group of property settings to set. - """ - pass - - def Upgrade(self, context, properties): - # type: (self: LocalFileSettingsProvider, context: SettingsContext, properties: SettingsPropertyCollection) - """ - Upgrade(self: LocalFileSettingsProvider, context: SettingsContext, properties: SettingsPropertyCollection) - Attempts to migrate previous user-scoped settings from a previous version of the same application. - - context: A System.Configuration.SettingsContext describing the current application usage. - properties: A System.Configuration.SettingsPropertyCollection containing the settings property group whose values are to be retrieved. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - ApplicationName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the name of the currently running application. - - Get: ApplicationName(self: LocalFileSettingsProvider) -> str - - Set: ApplicationName(self: LocalFileSettingsProvider) = value - """ - - - -class NameValueFileSectionHandler(object, IConfigurationSectionHandler): - """ - Provides access to a configuration file. This type supports the .NET Framework configuration infrastructure and is not intended to be used directly from your code. - - NameValueFileSectionHandler() - """ - def Create(self, parent, configContext, section): - # type: (self: NameValueFileSectionHandler, parent: object, configContext: object, section: XmlNode) -> object - """ - Create(self: NameValueFileSectionHandler, parent: object, configContext: object, section: XmlNode) -> object - - Creates a new configuration handler and adds it to the section-handler collection based on the specified parameters. - - parent: The parent object. - configContext: The configuration context object. - section: The section XML node. - Returns: A configuration object. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - -class NameValueSectionHandler(object, IConfigurationSectionHandler): - """ - Provides name/value-pair configuration information from a configuration section. - - NameValueSectionHandler() - """ - def Create(self, parent, context, section): - # type: (self: NameValueSectionHandler, parent: object, context: object, section: XmlNode) -> object - """ - Create(self: NameValueSectionHandler, parent: object, context: object, section: XmlNode) -> object - - Creates a new configuration handler and adds it to the section-handler collection based on the specified parameters. - - parent: Parent object. - context: Configuration context object. - section: Section XML node. - Returns: A configuration object. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - KeyAttributeName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the XML attribute name to use as the key in a key/value pair. """ - - ValueAttributeName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the XML attribute name to use as the value in a key/value pair. """ - - - -class NoSettingsVersionUpgradeAttribute(Attribute, _Attribute): - """ - Specifies that a settings provider should disable any logic that gets invoked when an application upgrade is detected. This class cannot be inherited. - - NoSettingsVersionUpgradeAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class SchemeSettingElement(ConfigurationElement): - """ - Represents an element in a System.Configuration.SchemeSettingElementCollection class. - - SchemeSettingElement() - """ - ElementProperty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ConfigurationElementProperty object that represents the System.Configuration.ConfigurationElement object itself. """ - - EvaluationContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ContextInformation object for the System.Configuration.ConfigurationElement object. """ - - GenericUriParserOptions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the GenericUriParserOptions entry from a System.Configuration.SchemeSettingElement instance. - - Get: GenericUriParserOptions(self: SchemeSettingElement) -> GenericUriParserOptions - """ - - HasContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - Name = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the Name entry from a System.Configuration.SchemeSettingElement instance. - - Get: Name(self: SchemeSettingElement) -> str - """ - - Properties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - - -class SchemeSettingElementCollection(ConfigurationElementCollection, ICollection, IEnumerable): - """ - Represents a collection of System.Configuration.SchemeSettingElement objects. - - SchemeSettingElementCollection() - """ - def BaseAdd(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, element: ConfigurationElement) - """ - BaseAdd(self: ConfigurationElementCollection, element: ConfigurationElement) - Adds a configuration element to the System.Configuration.ConfigurationElementCollection. - - element: The System.Configuration.ConfigurationElement to add. - BaseAdd(self: ConfigurationElementCollection, element: ConfigurationElement, throwIfExists: bool) - Adds a configuration element to the configuration element collection. - - element: The System.Configuration.ConfigurationElement to add. - throwIfExists: true to throw an exception if the System.Configuration.ConfigurationElement specified is already contained in the System.Configuration.ConfigurationElementCollection; otherwise, false. - BaseAdd(self: ConfigurationElementCollection, index: int, element: ConfigurationElement) - Adds a configuration element to the configuration element collection. - - index: The index location at which to add the specified System.Configuration.ConfigurationElement. - element: The System.Configuration.ConfigurationElement to add. - """ - pass - - def BaseClear(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection) - """ - BaseClear(self: ConfigurationElementCollection) - Removes all configuration element objects from the collection. - """ - pass - - def BaseGet(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, key: object) -> ConfigurationElement - """ - BaseGet(self: ConfigurationElementCollection, key: object) -> ConfigurationElement - - Returns the configuration element with the specified key. - - key: The key of the element to return. - Returns: The System.Configuration.ConfigurationElement with the specified key; otherwise, null. - BaseGet(self: ConfigurationElementCollection, index: int) -> ConfigurationElement - - Gets the configuration element at the specified index location. - - index: The index location of the System.Configuration.ConfigurationElement to return. - Returns: The System.Configuration.ConfigurationElement at the specified index. - """ - pass - - def BaseGetAllKeys(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection) -> Array[object] - """ - BaseGetAllKeys(self: ConfigurationElementCollection) -> Array[object] - - Returns an array of the keys for all of the configuration elements contained in the System.Configuration.ConfigurationElementCollection. - Returns: An array that contains the keys for all of the System.Configuration.ConfigurationElement objects contained in the System.Configuration.ConfigurationElementCollection. - """ - pass - - def BaseGetKey(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, index: int) -> object - """ - BaseGetKey(self: ConfigurationElementCollection, index: int) -> object - - Gets the key for the System.Configuration.ConfigurationElement at the specified index location. - - index: The index location for the System.Configuration.ConfigurationElement. - Returns: The key for the specified System.Configuration.ConfigurationElement. - """ - pass - - def BaseIndexOf(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, element: ConfigurationElement) -> int - """ - BaseIndexOf(self: ConfigurationElementCollection, element: ConfigurationElement) -> int - - The index of the specified System.Configuration.ConfigurationElement. - - element: The System.Configuration.ConfigurationElement for the specified index location. - Returns: The index of the specified System.Configuration.ConfigurationElement; otherwise, -1. - """ - pass - - def BaseIsRemoved(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, key: object) -> bool - """ - BaseIsRemoved(self: ConfigurationElementCollection, key: object) -> bool - - Gets a value indicating whether the System.Configuration.ConfigurationElement with the specified key has been removed from the System.Configuration.ConfigurationElementCollection. - - key: The key of the element to check. - Returns: true if the System.Configuration.ConfigurationElement with the specified key has been removed; otherwise, false. The default is false. - """ - pass - - def BaseRemove(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, key: object) - """ - BaseRemove(self: ConfigurationElementCollection, key: object) - Removes a System.Configuration.ConfigurationElement from the collection. - - key: The key of the System.Configuration.ConfigurationElement to remove. - """ - pass - - def BaseRemoveAt(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, index: int) - """ - BaseRemoveAt(self: ConfigurationElementCollection, index: int) - Removes the System.Configuration.ConfigurationElement at the specified index location. - - index: The index location of the System.Configuration.ConfigurationElement to remove. - """ - pass - - def CreateNewElement(self, *args): #cannot find CLR method - # type: (self: SchemeSettingElementCollection) -> ConfigurationElement - """ - CreateNewElement(self: SchemeSettingElementCollection) -> ConfigurationElement - CreateNewElement(self: ConfigurationElementCollection, elementName: str) -> ConfigurationElement - - Creates a new System.Configuration.ConfigurationElement when overridden in a derived class. - - elementName: The name of the System.Configuration.ConfigurationElement to create. - Returns: A new System.Configuration.ConfigurationElement. - """ - pass - - def DeserializeElement(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, reader: XmlReader, serializeCollectionKey: bool) - """ - DeserializeElement(self: ConfigurationElement, reader: XmlReader, serializeCollectionKey: bool) - Reads XML from the configuration file. - - reader: The System.Xml.XmlReader that reads from the configuration file. - serializeCollectionKey: true to serialize only the collection key properties; otherwise, false. - """ - pass - - def GetElementKey(self, *args): #cannot find CLR method - # type: (self: SchemeSettingElementCollection, element: ConfigurationElement) -> object - """ GetElementKey(self: SchemeSettingElementCollection, element: ConfigurationElement) -> object """ - pass - - def GetTransformedAssemblyString(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, assemblyName: str) -> str - """ - GetTransformedAssemblyString(self: ConfigurationElement, assemblyName: str) -> str - - Returns the transformed version of the specified assembly name. - - assemblyName: The name of the assembly. - Returns: The transformed version of the assembly name. If no transformer is available, the assemblyName parameter value is returned unchanged. The System.Configuration.Configuration.TypeStringTransformer property is null if no transformer is available. - """ - pass - - def GetTransformedTypeString(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, typeName: str) -> str - """ - GetTransformedTypeString(self: ConfigurationElement, typeName: str) -> str - - Returns the transformed version of the specified type name. - - typeName: The name of the type. - Returns: The transformed version of the specified type name. If no transformer is available, the typeName parameter value is returned unchanged. The System.Configuration.Configuration.TypeStringTransformer property is null if no transformer is available. - """ - pass - - def IndexOf(self, element): - # type: (self: SchemeSettingElementCollection, element: SchemeSettingElement) -> int - """ - IndexOf(self: SchemeSettingElementCollection, element: SchemeSettingElement) -> int - - The index of the specified System.Configuration.SchemeSettingElement. - - element: The System.Configuration.SchemeSettingElement for the specified index location. - Returns: The index of the specified System.Configuration.SchemeSettingElement; otherwise, -1. - """ - pass - - def Init(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement) - """ - Init(self: ConfigurationElement) - Sets the System.Configuration.ConfigurationElement object to its initial state. - """ - pass - - def InitializeDefault(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement) - """ - InitializeDefault(self: ConfigurationElement) - Used to initialize a default set of values for the System.Configuration.ConfigurationElement object. - """ - pass - - def IsElementName(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, elementName: str) -> bool - """ - IsElementName(self: ConfigurationElementCollection, elementName: str) -> bool - - Indicates whether the specified System.Configuration.ConfigurationElement exists in the System.Configuration.ConfigurationElementCollection. - - elementName: The name of the element to verify. - Returns: true if the element exists in the collection; otherwise, false. The default is false. - """ - pass - - def IsElementRemovable(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, element: ConfigurationElement) -> bool - """ - IsElementRemovable(self: ConfigurationElementCollection, element: ConfigurationElement) -> bool - - Gets a value indicating whether the specified System.Configuration.ConfigurationElement can be removed from the System.Configuration.ConfigurationElementCollection. - - element: The element to check. - Returns: true if the specified System.Configuration.ConfigurationElement can be removed from this System.Configuration.ConfigurationElementCollection; otherwise, false. The default is true. - """ - pass - - def IsModified(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection) -> bool - """ - IsModified(self: ConfigurationElementCollection) -> bool - - Indicates whether this System.Configuration.ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. - Returns: true if any contained element has been modified; otherwise, false - """ - pass - - def ListErrors(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, errorList: IList) - """ - ListErrors(self: ConfigurationElement, errorList: IList) - Adds the invalid-property errors in this System.Configuration.ConfigurationElement object, and in all subelements, to the passed list. - - errorList: An object that implements the System.Collections.IList interface. - """ - pass - - def OnDeserializeUnrecognizedAttribute(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, name: str, value: str) -> bool - """ - OnDeserializeUnrecognizedAttribute(self: ConfigurationElement, name: str, value: str) -> bool - - Gets a value indicating whether an unknown attribute is encountered during deserialization. - - name: The name of the unrecognized attribute. - value: The value of the unrecognized attribute. - Returns: true when an unknown attribute is encountered while deserializing; otherwise, false. - """ - pass - - def OnDeserializeUnrecognizedElement(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, elementName: str, reader: XmlReader) -> bool - """ - OnDeserializeUnrecognizedElement(self: ConfigurationElementCollection, elementName: str, reader: XmlReader) -> bool - - Causes the configuration system to throw an exception. - - elementName: The name of the unrecognized element. - reader: An input stream that reads XML from the configuration file. - Returns: true if the unrecognized element was deserialized successfully; otherwise, false. The default is false. - """ - pass - - def OnRequiredPropertyNotFound(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, name: str) -> object - """ - OnRequiredPropertyNotFound(self: ConfigurationElement, name: str) -> object - - Throws an exception when a required property is not found. - - name: The name of the required attribute that was not found. - Returns: None. - """ - pass - - def PostDeserialize(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement) - """ - PostDeserialize(self: ConfigurationElement) - Called after deserialization. - """ - pass - - def PreSerialize(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, writer: XmlWriter) - """ - PreSerialize(self: ConfigurationElement, writer: XmlWriter) - Called before serialization. - - writer: The System.Xml.XmlWriter that will be used to serialize the System.Configuration.ConfigurationElement. - """ - pass - - def Reset(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, parentElement: ConfigurationElement) - """ - Reset(self: ConfigurationElementCollection, parentElement: ConfigurationElement) - Resets the System.Configuration.ConfigurationElementCollection to its unmodified state when overridden in a derived class. - - parentElement: The System.Configuration.ConfigurationElement representing the collection parent element, if any; otherwise, null. - """ - pass - - def ResetModified(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection) - """ - ResetModified(self: ConfigurationElementCollection) - Resets the value of the System.Configuration.ConfigurationElementCollection.IsModified property to false when overridden in a derived class. - """ - pass - - def SerializeElement(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, writer: XmlWriter, serializeCollectionKey: bool) -> bool - """ - SerializeElement(self: ConfigurationElementCollection, writer: XmlWriter, serializeCollectionKey: bool) -> bool - - Writes the configuration data to an XML element in the configuration file when overridden in a derived class. - - writer: Output stream that writes XML to the configuration file. - serializeCollectionKey: true to serialize the collection key; otherwise, false. - Returns: true if the System.Configuration.ConfigurationElementCollection was written to the configuration file successfully. - """ - pass - - def SerializeToXmlElement(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, writer: XmlWriter, elementName: str) -> bool - """ - SerializeToXmlElement(self: ConfigurationElement, writer: XmlWriter, elementName: str) -> bool - - Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. - - writer: The System.Xml.XmlWriter that writes to the configuration file. - elementName: The name of the System.Configuration.ConfigurationElement to be written. - Returns: true if writing was successful; otherwise, false. - """ - pass - - def SetPropertyValue(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, prop: ConfigurationProperty, value: object, ignoreLocks: bool) - """ - SetPropertyValue(self: ConfigurationElement, prop: ConfigurationProperty, value: object, ignoreLocks: bool) - Sets a property to the specified value. - - prop: The element property to set. - value: The value to assign to the property. - ignoreLocks: true if the locks on the property should be ignored; otherwise, false. - """ - pass - - def SetReadOnly(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection) - """ - SetReadOnly(self: ConfigurationElementCollection) - Sets the System.Configuration.ConfigurationElementCollection.IsReadOnly property for the System.Configuration.ConfigurationElementCollection object and for all sub-elements. - """ - pass - - def Unmerge(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, sourceElement: ConfigurationElement, parentElement: ConfigurationElement, saveMode: ConfigurationSaveMode) - """ - Unmerge(self: ConfigurationElementCollection, sourceElement: ConfigurationElement, parentElement: ConfigurationElement, saveMode: ConfigurationSaveMode) - Reverses the effect of merging configuration information from different levels of the configuration hierarchy - - sourceElement: A System.Configuration.ConfigurationElement object at the current level containing a merged view of the properties. - parentElement: The parent System.Configuration.ConfigurationElement object of the current element, or null if this is the top level. - saveMode: A System.Configuration.ConfigurationSaveMode enumerated value that determines which property values to include. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y]x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - AddElementName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the name of the System.Configuration.ConfigurationElement to associate with the add operation in the System.Configuration.ConfigurationElementCollection when overridden in a derived class. """ - - ClearElementName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the name for the System.Configuration.ConfigurationElement to associate with the clear operation in the System.Configuration.ConfigurationElementCollection when overridden in a derived class. """ - - CollectionType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the default collection type of System.Configuration.SchemeSettingElementCollection. - - Get: CollectionType(self: SchemeSettingElementCollection) -> ConfigurationElementCollectionType - """ - - ElementName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the name used to identify this collection of elements in the configuration file when overridden in a derived class. """ - - ElementProperty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ConfigurationElementProperty object that represents the System.Configuration.ConfigurationElement object itself. """ - - EvaluationContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ContextInformation object for the System.Configuration.ConfigurationElement object. """ - - HasContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - Properties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the collection of properties. """ - - RemoveElementName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the name of the System.Configuration.ConfigurationElement to associate with the remove operation in the System.Configuration.ConfigurationElementCollection when overridden in a derived class. """ - - ThrowOnDuplicate = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a value indicating whether an attempt to add a duplicate System.Configuration.ConfigurationElement to the System.Configuration.ConfigurationElementCollection will cause an exception to be thrown. """ - - - -class SettingChangingEventArgs(CancelEventArgs): - """ - Provides data for the System.Configuration.ApplicationSettingsBase.SettingChanging event. - - SettingChangingEventArgs(settingName: str, settingClass: str, settingKey: str, newValue: object, cancel: bool) - """ - @staticmethod # known case of __new__ - def __new__(self, settingName, settingClass, settingKey, newValue, cancel): - """ __new__(cls: type, settingName: str, settingClass: str, settingKey: str, newValue: object, cancel: bool) """ - pass - - NewValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the new value being assigned to the application settings property. - - Get: NewValue(self: SettingChangingEventArgs) -> object - """ - - SettingClass = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the application settings property category. - - Get: SettingClass(self: SettingChangingEventArgs) -> str - """ - - SettingKey = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the application settings key associated with the property. - - Get: SettingKey(self: SettingChangingEventArgs) -> str - """ - - SettingName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the name of the application setting associated with the application settings property. - - Get: SettingName(self: SettingChangingEventArgs) -> str - """ - - - -class SettingChangingEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the System.Configuration.ApplicationSettingsBase.SettingChanging event. - - SettingChangingEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: SettingChangingEventHandler, sender: object, e: SettingChangingEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: SettingChangingEventHandler, sender: object, e: SettingChangingEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: SettingChangingEventHandler, result: IAsyncResult) - """ EndInvoke(self: SettingChangingEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: SettingChangingEventHandler, sender: object, e: SettingChangingEventArgs) - """ Invoke(self: SettingChangingEventHandler, sender: object, e: SettingChangingEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class SettingElement(ConfigurationElement): - """ - Represents a simplified configuration element used for updating elements in the configuration. This class cannot be inherited. - - SettingElement() - SettingElement(name: str, serializeAs: SettingsSerializeAs) - """ - def Equals(self, settings): - # type: (self: SettingElement, settings: object) -> bool - """ - Equals(self: SettingElement, settings: object) -> bool - - Compares the current System.Configuration.SettingElement instance to the specified object. - - settings: The object to compare with. - Returns: true if the System.Configuration.SettingElement instance is equal to the specified object; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: SettingElement) -> int - """ - GetHashCode(self: SettingElement) -> int - - Gets a unique value representing the System.Configuration.SettingElement current instance. - Returns: A unique value representing the System.Configuration.SettingElement current instance. - """ - pass - - @staticmethod # known case of __new__ - def __new__(self, name=None, serializeAs=None): - """ - __new__(cls: type) - __new__(cls: type, name: str, serializeAs: SettingsSerializeAs) - """ - pass - - ElementProperty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ConfigurationElementProperty object that represents the System.Configuration.ConfigurationElement object itself. """ - - EvaluationContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ContextInformation object for the System.Configuration.ConfigurationElement object. """ - - HasContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - Name = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the name of the System.Configuration.SettingElement object. - - Get: Name(self: SettingElement) -> str - - Set: Name(self: SettingElement) = value - """ - - Properties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - SerializeAs = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the serialization mechanism used to persist the values of the System.Configuration.SettingElement object. - - Get: SerializeAs(self: SettingElement) -> SettingsSerializeAs - - Set: SerializeAs(self: SettingElement) = value - """ - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the value of a System.Configuration.SettingElement object by using a System.Configuration.SettingValueElement object. - - Get: Value(self: SettingElement) -> SettingValueElement - - Set: Value(self: SettingElement) = value - """ - - - -class SettingElementCollection(ConfigurationElementCollection, ICollection, IEnumerable): - """ - Contains a collection of System.Configuration.SettingElement objects. This class cannot be inherited. - - SettingElementCollection() - """ - def Add(self, element): - # type: (self: SettingElementCollection, element: SettingElement) - """ - Add(self: SettingElementCollection, element: SettingElement) - Adds a System.Configuration.SettingElement object to the collection. - - element: The System.Configuration.SettingElement object to add to the collection. - """ - pass - - def BaseAdd(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, element: ConfigurationElement) - """ - BaseAdd(self: ConfigurationElementCollection, element: ConfigurationElement) - Adds a configuration element to the System.Configuration.ConfigurationElementCollection. - - element: The System.Configuration.ConfigurationElement to add. - BaseAdd(self: ConfigurationElementCollection, element: ConfigurationElement, throwIfExists: bool) - Adds a configuration element to the configuration element collection. - - element: The System.Configuration.ConfigurationElement to add. - throwIfExists: true to throw an exception if the System.Configuration.ConfigurationElement specified is already contained in the System.Configuration.ConfigurationElementCollection; otherwise, false. - BaseAdd(self: ConfigurationElementCollection, index: int, element: ConfigurationElement) - Adds a configuration element to the configuration element collection. - - index: The index location at which to add the specified System.Configuration.ConfigurationElement. - element: The System.Configuration.ConfigurationElement to add. - """ - pass - - def BaseClear(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection) - """ - BaseClear(self: ConfigurationElementCollection) - Removes all configuration element objects from the collection. - """ - pass - - def BaseGet(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, key: object) -> ConfigurationElement - """ - BaseGet(self: ConfigurationElementCollection, key: object) -> ConfigurationElement - - Returns the configuration element with the specified key. - - key: The key of the element to return. - Returns: The System.Configuration.ConfigurationElement with the specified key; otherwise, null. - BaseGet(self: ConfigurationElementCollection, index: int) -> ConfigurationElement - - Gets the configuration element at the specified index location. - - index: The index location of the System.Configuration.ConfigurationElement to return. - Returns: The System.Configuration.ConfigurationElement at the specified index. - """ - pass - - def BaseGetAllKeys(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection) -> Array[object] - """ - BaseGetAllKeys(self: ConfigurationElementCollection) -> Array[object] - - Returns an array of the keys for all of the configuration elements contained in the System.Configuration.ConfigurationElementCollection. - Returns: An array that contains the keys for all of the System.Configuration.ConfigurationElement objects contained in the System.Configuration.ConfigurationElementCollection. - """ - pass - - def BaseGetKey(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, index: int) -> object - """ - BaseGetKey(self: ConfigurationElementCollection, index: int) -> object - - Gets the key for the System.Configuration.ConfigurationElement at the specified index location. - - index: The index location for the System.Configuration.ConfigurationElement. - Returns: The key for the specified System.Configuration.ConfigurationElement. - """ - pass - - def BaseIndexOf(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, element: ConfigurationElement) -> int - """ - BaseIndexOf(self: ConfigurationElementCollection, element: ConfigurationElement) -> int - - The index of the specified System.Configuration.ConfigurationElement. - - element: The System.Configuration.ConfigurationElement for the specified index location. - Returns: The index of the specified System.Configuration.ConfigurationElement; otherwise, -1. - """ - pass - - def BaseIsRemoved(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, key: object) -> bool - """ - BaseIsRemoved(self: ConfigurationElementCollection, key: object) -> bool - - Gets a value indicating whether the System.Configuration.ConfigurationElement with the specified key has been removed from the System.Configuration.ConfigurationElementCollection. - - key: The key of the element to check. - Returns: true if the System.Configuration.ConfigurationElement with the specified key has been removed; otherwise, false. The default is false. - """ - pass - - def BaseRemove(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, key: object) - """ - BaseRemove(self: ConfigurationElementCollection, key: object) - Removes a System.Configuration.ConfigurationElement from the collection. - - key: The key of the System.Configuration.ConfigurationElement to remove. - """ - pass - - def BaseRemoveAt(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, index: int) - """ - BaseRemoveAt(self: ConfigurationElementCollection, index: int) - Removes the System.Configuration.ConfigurationElement at the specified index location. - - index: The index location of the System.Configuration.ConfigurationElement to remove. - """ - pass - - def Clear(self): - # type: (self: SettingElementCollection) - """ - Clear(self: SettingElementCollection) - Removes all System.Configuration.SettingElement objects from the collection. - """ - pass - - def CreateNewElement(self, *args): #cannot find CLR method - # type: (self: SettingElementCollection) -> ConfigurationElement - """ - CreateNewElement(self: SettingElementCollection) -> ConfigurationElement - CreateNewElement(self: ConfigurationElementCollection, elementName: str) -> ConfigurationElement - - Creates a new System.Configuration.ConfigurationElement when overridden in a derived class. - - elementName: The name of the System.Configuration.ConfigurationElement to create. - Returns: A new System.Configuration.ConfigurationElement. - """ - pass - - def DeserializeElement(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, reader: XmlReader, serializeCollectionKey: bool) - """ - DeserializeElement(self: ConfigurationElement, reader: XmlReader, serializeCollectionKey: bool) - Reads XML from the configuration file. - - reader: The System.Xml.XmlReader that reads from the configuration file. - serializeCollectionKey: true to serialize only the collection key properties; otherwise, false. - """ - pass - - def Get(self, elementKey): - # type: (self: SettingElementCollection, elementKey: str) -> SettingElement - """ - Get(self: SettingElementCollection, elementKey: str) -> SettingElement - - Gets a System.Configuration.SettingElement object from the collection. - - elementKey: A string value representing the System.Configuration.SettingElement object in the collection. - Returns: A System.Configuration.SettingElement object. - """ - pass - - def GetElementKey(self, *args): #cannot find CLR method - # type: (self: SettingElementCollection, element: ConfigurationElement) -> object - """ GetElementKey(self: SettingElementCollection, element: ConfigurationElement) -> object """ - pass - - def GetTransformedAssemblyString(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, assemblyName: str) -> str - """ - GetTransformedAssemblyString(self: ConfigurationElement, assemblyName: str) -> str - - Returns the transformed version of the specified assembly name. - - assemblyName: The name of the assembly. - Returns: The transformed version of the assembly name. If no transformer is available, the assemblyName parameter value is returned unchanged. The System.Configuration.Configuration.TypeStringTransformer property is null if no transformer is available. - """ - pass - - def GetTransformedTypeString(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, typeName: str) -> str - """ - GetTransformedTypeString(self: ConfigurationElement, typeName: str) -> str - - Returns the transformed version of the specified type name. - - typeName: The name of the type. - Returns: The transformed version of the specified type name. If no transformer is available, the typeName parameter value is returned unchanged. The System.Configuration.Configuration.TypeStringTransformer property is null if no transformer is available. - """ - pass - - def Init(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement) - """ - Init(self: ConfigurationElement) - Sets the System.Configuration.ConfigurationElement object to its initial state. - """ - pass - - def InitializeDefault(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement) - """ - InitializeDefault(self: ConfigurationElement) - Used to initialize a default set of values for the System.Configuration.ConfigurationElement object. - """ - pass - - def IsElementName(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, elementName: str) -> bool - """ - IsElementName(self: ConfigurationElementCollection, elementName: str) -> bool - - Indicates whether the specified System.Configuration.ConfigurationElement exists in the System.Configuration.ConfigurationElementCollection. - - elementName: The name of the element to verify. - Returns: true if the element exists in the collection; otherwise, false. The default is false. - """ - pass - - def IsElementRemovable(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, element: ConfigurationElement) -> bool - """ - IsElementRemovable(self: ConfigurationElementCollection, element: ConfigurationElement) -> bool - - Gets a value indicating whether the specified System.Configuration.ConfigurationElement can be removed from the System.Configuration.ConfigurationElementCollection. - - element: The element to check. - Returns: true if the specified System.Configuration.ConfigurationElement can be removed from this System.Configuration.ConfigurationElementCollection; otherwise, false. The default is true. - """ - pass - - def IsModified(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection) -> bool - """ - IsModified(self: ConfigurationElementCollection) -> bool - - Indicates whether this System.Configuration.ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. - Returns: true if any contained element has been modified; otherwise, false - """ - pass - - def ListErrors(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, errorList: IList) - """ - ListErrors(self: ConfigurationElement, errorList: IList) - Adds the invalid-property errors in this System.Configuration.ConfigurationElement object, and in all subelements, to the passed list. - - errorList: An object that implements the System.Collections.IList interface. - """ - pass - - def OnDeserializeUnrecognizedAttribute(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, name: str, value: str) -> bool - """ - OnDeserializeUnrecognizedAttribute(self: ConfigurationElement, name: str, value: str) -> bool - - Gets a value indicating whether an unknown attribute is encountered during deserialization. - - name: The name of the unrecognized attribute. - value: The value of the unrecognized attribute. - Returns: true when an unknown attribute is encountered while deserializing; otherwise, false. - """ - pass - - def OnDeserializeUnrecognizedElement(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, elementName: str, reader: XmlReader) -> bool - """ - OnDeserializeUnrecognizedElement(self: ConfigurationElementCollection, elementName: str, reader: XmlReader) -> bool - - Causes the configuration system to throw an exception. - - elementName: The name of the unrecognized element. - reader: An input stream that reads XML from the configuration file. - Returns: true if the unrecognized element was deserialized successfully; otherwise, false. The default is false. - """ - pass - - def OnRequiredPropertyNotFound(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, name: str) -> object - """ - OnRequiredPropertyNotFound(self: ConfigurationElement, name: str) -> object - - Throws an exception when a required property is not found. - - name: The name of the required attribute that was not found. - Returns: None. - """ - pass - - def PostDeserialize(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement) - """ - PostDeserialize(self: ConfigurationElement) - Called after deserialization. - """ - pass - - def PreSerialize(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, writer: XmlWriter) - """ - PreSerialize(self: ConfigurationElement, writer: XmlWriter) - Called before serialization. - - writer: The System.Xml.XmlWriter that will be used to serialize the System.Configuration.ConfigurationElement. - """ - pass - - def Remove(self, element): - # type: (self: SettingElementCollection, element: SettingElement) - """ - Remove(self: SettingElementCollection, element: SettingElement) - Removes a System.Configuration.SettingElement object from the collection. - - element: A System.Configuration.SettingElement object. - """ - pass - - def Reset(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, parentElement: ConfigurationElement) - """ - Reset(self: ConfigurationElementCollection, parentElement: ConfigurationElement) - Resets the System.Configuration.ConfigurationElementCollection to its unmodified state when overridden in a derived class. - - parentElement: The System.Configuration.ConfigurationElement representing the collection parent element, if any; otherwise, null. - """ - pass - - def ResetModified(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection) - """ - ResetModified(self: ConfigurationElementCollection) - Resets the value of the System.Configuration.ConfigurationElementCollection.IsModified property to false when overridden in a derived class. - """ - pass - - def SerializeElement(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, writer: XmlWriter, serializeCollectionKey: bool) -> bool - """ - SerializeElement(self: ConfigurationElementCollection, writer: XmlWriter, serializeCollectionKey: bool) -> bool - - Writes the configuration data to an XML element in the configuration file when overridden in a derived class. - - writer: Output stream that writes XML to the configuration file. - serializeCollectionKey: true to serialize the collection key; otherwise, false. - Returns: true if the System.Configuration.ConfigurationElementCollection was written to the configuration file successfully. - """ - pass - - def SerializeToXmlElement(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, writer: XmlWriter, elementName: str) -> bool - """ - SerializeToXmlElement(self: ConfigurationElement, writer: XmlWriter, elementName: str) -> bool - - Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. - - writer: The System.Xml.XmlWriter that writes to the configuration file. - elementName: The name of the System.Configuration.ConfigurationElement to be written. - Returns: true if writing was successful; otherwise, false. - """ - pass - - def SetPropertyValue(self, *args): #cannot find CLR method - # type: (self: ConfigurationElement, prop: ConfigurationProperty, value: object, ignoreLocks: bool) - """ - SetPropertyValue(self: ConfigurationElement, prop: ConfigurationProperty, value: object, ignoreLocks: bool) - Sets a property to the specified value. - - prop: The element property to set. - value: The value to assign to the property. - ignoreLocks: true if the locks on the property should be ignored; otherwise, false. - """ - pass - - def SetReadOnly(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection) - """ - SetReadOnly(self: ConfigurationElementCollection) - Sets the System.Configuration.ConfigurationElementCollection.IsReadOnly property for the System.Configuration.ConfigurationElementCollection object and for all sub-elements. - """ - pass - - def Unmerge(self, *args): #cannot find CLR method - # type: (self: ConfigurationElementCollection, sourceElement: ConfigurationElement, parentElement: ConfigurationElement, saveMode: ConfigurationSaveMode) - """ - Unmerge(self: ConfigurationElementCollection, sourceElement: ConfigurationElement, parentElement: ConfigurationElement, saveMode: ConfigurationSaveMode) - Reverses the effect of merging configuration information from different levels of the configuration hierarchy - - sourceElement: A System.Configuration.ConfigurationElement object at the current level containing a merged view of the properties. - parentElement: The parent System.Configuration.ConfigurationElement object of the current element, or null if this is the top level. - saveMode: A System.Configuration.ConfigurationSaveMode enumerated value that determines which property values to include. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - AddElementName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the name of the System.Configuration.ConfigurationElement to associate with the add operation in the System.Configuration.ConfigurationElementCollection when overridden in a derived class. """ - - ClearElementName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the name for the System.Configuration.ConfigurationElement to associate with the clear operation in the System.Configuration.ConfigurationElementCollection when overridden in a derived class. """ - - CollectionType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the type of the configuration collection. - - Get: CollectionType(self: SettingElementCollection) -> ConfigurationElementCollectionType - """ - - ElementName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - ElementProperty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ConfigurationElementProperty object that represents the System.Configuration.ConfigurationElement object itself. """ - - EvaluationContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ContextInformation object for the System.Configuration.ConfigurationElement object. """ - - HasContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - Properties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the collection of properties. """ - - RemoveElementName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the name of the System.Configuration.ConfigurationElement to associate with the remove operation in the System.Configuration.ConfigurationElementCollection when overridden in a derived class. """ - - ThrowOnDuplicate = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a value indicating whether an attempt to add a duplicate System.Configuration.ConfigurationElement to the System.Configuration.ConfigurationElementCollection will cause an exception to be thrown. """ - - - -class SettingsAttributeDictionary(Hashtable, IDictionary, ICollection, IEnumerable, ISerializable, IDeserializationCallback, ICloneable): - """ - Represents a collection of key/value pairs used to describe a configuration object as well as a System.Configuration.SettingsProperty object. - - SettingsAttributeDictionary() - SettingsAttributeDictionary(attributes: SettingsAttributeDictionary) - """ - def GetHash(self, *args): #cannot find CLR method - # type: (self: Hashtable, key: object) -> int - """ - GetHash(self: Hashtable, key: object) -> int - - Returns the hash code for the specified key. - - key: The System.Object for which a hash code is to be returned. - Returns: The hash code for key. - """ - pass - - def KeyEquals(self, *args): #cannot find CLR method - # type: (self: Hashtable, item: object, key: object) -> bool - """ - KeyEquals(self: Hashtable, item: object, key: object) -> bool - - Compares a specific System.Object with a specific key in the System.Collections.Hashtable. - - item: The System.Object to compare with key. - key: The key in the System.Collections.Hashtable to compare with item. - Returns: true if item and key are equal; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - @staticmethod # known case of __new__ - def __new__(self, attributes=None): - """ - __new__(cls: type) - __new__(cls: type, attributes: SettingsAttributeDictionary) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - comparer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the System.Collections.IComparer to use for the System.Collections.Hashtable. """ - - EqualityComparer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Collections.IEqualityComparer to use for the System.Collections.Hashtable. """ - - hcp = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the object that can dispense hash codes. """ - - - -class SettingsContext(Hashtable, IDictionary, ICollection, IEnumerable, ISerializable, IDeserializationCallback, ICloneable): - """ - Provides contextual information that the provider can use when persisting settings. - - SettingsContext() - """ - def GetHash(self, *args): #cannot find CLR method - # type: (self: Hashtable, key: object) -> int - """ - GetHash(self: Hashtable, key: object) -> int - - Returns the hash code for the specified key. - - key: The System.Object for which a hash code is to be returned. - Returns: The hash code for key. - """ - pass - - def KeyEquals(self, *args): #cannot find CLR method - # type: (self: Hashtable, item: object, key: object) -> bool - """ - KeyEquals(self: Hashtable, item: object, key: object) -> bool - - Compares a specific System.Object with a specific key in the System.Collections.Hashtable. - - item: The System.Object to compare with key. - key: The key in the System.Collections.Hashtable to compare with item. - Returns: true if item and key are equal; otherwise, false. - """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - comparer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the System.Collections.IComparer to use for the System.Collections.Hashtable. """ - - EqualityComparer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Collections.IEqualityComparer to use for the System.Collections.Hashtable. """ - - hcp = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the object that can dispense hash codes. """ - - - -class SettingsDescriptionAttribute(Attribute, _Attribute): - """ - Provides a string that describes an individual configuration property. This class cannot be inherited. - - SettingsDescriptionAttribute(description: str) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, description): - """ __new__(cls: type, description: str) """ - pass - - Description = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the descriptive text for the associated configuration property. - - Get: Description(self: SettingsDescriptionAttribute) -> str - """ - - - -class SettingsGroupDescriptionAttribute(Attribute, _Attribute): - """ - Provides a string that describes an application settings property group. This class cannot be inherited. - - SettingsGroupDescriptionAttribute(description: str) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, description): - """ __new__(cls: type, description: str) """ - pass - - Description = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - The descriptive text for the application settings properties group. - - Get: Description(self: SettingsGroupDescriptionAttribute) -> str - """ - - - -class SettingsGroupNameAttribute(Attribute, _Attribute): - """ - Specifies a name for application settings property group. This class cannot be inherited. - - SettingsGroupNameAttribute(groupName: str) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, groupName): - """ __new__(cls: type, groupName: str) """ - pass - - GroupName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the name of the application settings property group. - - Get: GroupName(self: SettingsGroupNameAttribute) -> str - """ - - - -class SettingsLoadedEventArgs(EventArgs): - """ - Provides data for the System.Configuration.ApplicationSettingsBase.SettingsLoaded event. - - SettingsLoadedEventArgs(provider: SettingsProvider) - """ - @staticmethod # known case of __new__ - def __new__(self, provider): - """ __new__(cls: type, provider: SettingsProvider) """ - pass - - Provider = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the settings provider used to store configuration settings. - - Get: Provider(self: SettingsLoadedEventArgs) -> SettingsProvider - """ - - - -class SettingsLoadedEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the System.Configuration.ApplicationSettingsBase.SettingsLoaded event. - - SettingsLoadedEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: SettingsLoadedEventHandler, sender: object, e: SettingsLoadedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: SettingsLoadedEventHandler, sender: object, e: SettingsLoadedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: SettingsLoadedEventHandler, result: IAsyncResult) - """ EndInvoke(self: SettingsLoadedEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: SettingsLoadedEventHandler, sender: object, e: SettingsLoadedEventArgs) - """ Invoke(self: SettingsLoadedEventHandler, sender: object, e: SettingsLoadedEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class SettingsManageability(Enum, IComparable, IFormattable, IConvertible): - """ - Provides values to indicate which services should be made available to application settings. - - enum SettingsManageability, values: Roaming (0) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Roaming = None - value__ = None - - -class SettingsManageabilityAttribute(Attribute, _Attribute): - """ - Specifies special services for application settings properties. This class cannot be inherited. - - SettingsManageabilityAttribute(manageability: SettingsManageability) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, manageability): - """ __new__(cls: type, manageability: SettingsManageability) """ - pass - - Manageability = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the set of special services that have been requested. - - Get: Manageability(self: SettingsManageabilityAttribute) -> SettingsManageability - """ - - - -class SettingsProperty(object): - """ - Used internally as the class that represents metadata about an individual configuration property. - - SettingsProperty(name: str) - SettingsProperty(name: str, propertyType: Type, provider: SettingsProvider, isReadOnly: bool, defaultValue: object, serializeAs: SettingsSerializeAs, attributes: SettingsAttributeDictionary, throwOnErrorDeserializing: bool, throwOnErrorSerializing: bool) - SettingsProperty(propertyToCopy: SettingsProperty) - """ - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, name: str) - __new__(cls: type, name: str, propertyType: Type, provider: SettingsProvider, isReadOnly: bool, defaultValue: object, serializeAs: SettingsSerializeAs, attributes: SettingsAttributeDictionary, throwOnErrorDeserializing: bool, throwOnErrorSerializing: bool) - __new__(cls: type, propertyToCopy: SettingsProperty) - """ - pass - - Attributes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.Configuration.SettingsAttributeDictionary object containing the attributes of the System.Configuration.SettingsProperty object. - - Get: Attributes(self: SettingsProperty) -> SettingsAttributeDictionary - """ - - DefaultValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the default value of the System.Configuration.SettingsProperty object. - - Get: DefaultValue(self: SettingsProperty) -> object - - Set: DefaultValue(self: SettingsProperty) = value - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a value specifying whether a System.Configuration.SettingsProperty object is read-only. - - Get: IsReadOnly(self: SettingsProperty) -> bool - - Set: IsReadOnly(self: SettingsProperty) = value - """ - - Name = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the name of the System.Configuration.SettingsProperty. - - Get: Name(self: SettingsProperty) -> str - - Set: Name(self: SettingsProperty) = value - """ - - PropertyType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the type for the System.Configuration.SettingsProperty. - - Get: PropertyType(self: SettingsProperty) -> Type - - Set: PropertyType(self: SettingsProperty) = value - """ - - Provider = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the provider for the System.Configuration.SettingsProperty. - - Get: Provider(self: SettingsProperty) -> SettingsProvider - - Set: Provider(self: SettingsProperty) = value - """ - - SerializeAs = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a System.Configuration.SettingsSerializeAs object for the System.Configuration.SettingsProperty. - - Get: SerializeAs(self: SettingsProperty) -> SettingsSerializeAs - - Set: SerializeAs(self: SettingsProperty) = value - """ - - ThrowOnErrorDeserializing = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully deserialized. - - Get: ThrowOnErrorDeserializing(self: SettingsProperty) -> bool - - Set: ThrowOnErrorDeserializing(self: SettingsProperty) = value - """ - - ThrowOnErrorSerializing = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a value specifying whether an error will be thrown when the property is unsuccessfully serialized. - - Get: ThrowOnErrorSerializing(self: SettingsProperty) -> bool - - Set: ThrowOnErrorSerializing(self: SettingsProperty) = value - """ - - - -class SettingsPropertyCollection(object, IEnumerable, ICloneable, ICollection): - """ - Contains a collection of System.Configuration.SettingsProperty objects. - - SettingsPropertyCollection() - """ - def Add(self, property): - # type: (self: SettingsPropertyCollection, property: SettingsProperty) - """ - Add(self: SettingsPropertyCollection, property: SettingsProperty) - Adds a System.Configuration.SettingsProperty object to the collection. - - property: A System.Configuration.SettingsProperty object. - """ - pass - - def Clear(self): - # type: (self: SettingsPropertyCollection) - """ - Clear(self: SettingsPropertyCollection) - Removes all System.Configuration.SettingsProperty objects from the collection. - """ - pass - - def Clone(self): - # type: (self: SettingsPropertyCollection) -> object - """ - Clone(self: SettingsPropertyCollection) -> object - - Creates a copy of the existing collection. - Returns: A System.Configuration.SettingsPropertyCollection class. - """ - pass - - def CopyTo(self, array, index): - # type: (self: SettingsPropertyCollection, array: Array, index: int) - """ - CopyTo(self: SettingsPropertyCollection, array: Array, index: int) - Copies this System.Configuration.SettingsPropertyCollection object to an array. - - array: The array to copy the object to. - index: The index at which to begin copying. - """ - pass - - def GetEnumerator(self): - # type: (self: SettingsPropertyCollection) -> IEnumerator - """ - GetEnumerator(self: SettingsPropertyCollection) -> IEnumerator - - Gets the System.Collections.IEnumerator object as it applies to the collection. - Returns: The System.Collections.IEnumerator object as it applies to the collection. - """ - pass - - def OnAdd(self, *args): #cannot find CLR method - # type: (self: SettingsPropertyCollection, property: SettingsProperty) - """ - OnAdd(self: SettingsPropertyCollection, property: SettingsProperty) - Performs additional, custom processing when adding to the contents of the System.Configuration.SettingsPropertyCollection instance. - - property: A System.Configuration.SettingsProperty object. - """ - pass - - def OnAddComplete(self, *args): #cannot find CLR method - # type: (self: SettingsPropertyCollection, property: SettingsProperty) - """ - OnAddComplete(self: SettingsPropertyCollection, property: SettingsProperty) - Performs additional, custom processing after adding to the contents of the System.Configuration.SettingsPropertyCollection instance. - - property: A System.Configuration.SettingsProperty object. - """ - pass - - def OnClear(self, *args): #cannot find CLR method - # type: (self: SettingsPropertyCollection) - """ - OnClear(self: SettingsPropertyCollection) - Performs additional, custom processing when clearing the contents of the System.Configuration.SettingsPropertyCollection instance. - """ - pass - - def OnClearComplete(self, *args): #cannot find CLR method - # type: (self: SettingsPropertyCollection) - """ - OnClearComplete(self: SettingsPropertyCollection) - Performs additional, custom processing after clearing the contents of the System.Configuration.SettingsPropertyCollection instance. - """ - pass - - def OnRemove(self, *args): #cannot find CLR method - # type: (self: SettingsPropertyCollection, property: SettingsProperty) - """ - OnRemove(self: SettingsPropertyCollection, property: SettingsProperty) - Performs additional, custom processing when removing the contents of the System.Configuration.SettingsPropertyCollection instance. - - property: A System.Configuration.SettingsProperty object. - """ - pass - - def OnRemoveComplete(self, *args): #cannot find CLR method - # type: (self: SettingsPropertyCollection, property: SettingsProperty) - """ - OnRemoveComplete(self: SettingsPropertyCollection, property: SettingsProperty) - Performs additional, custom processing after removing the contents of the System.Configuration.SettingsPropertyCollection instance. - - property: A System.Configuration.SettingsProperty object. - """ - pass - - def Remove(self, name): - # type: (self: SettingsPropertyCollection, name: str) - """ - Remove(self: SettingsPropertyCollection, name: str) - Removes a System.Configuration.SettingsProperty object from the collection. - - name: The name of the System.Configuration.SettingsProperty object. - """ - pass - - def SetReadOnly(self): - # type: (self: SettingsPropertyCollection) - """ - SetReadOnly(self: SettingsPropertyCollection) - Sets the collection to be read-only. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that specifies the number of System.Configuration.SettingsProperty objects in the collection. - - Get: Count(self: SettingsPropertyCollection) -> int - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value that indicates whether access to the collection is synchronized (thread safe). - - Get: IsSynchronized(self: SettingsPropertyCollection) -> bool - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the object to synchronize access to the collection. - - Get: SyncRoot(self: SettingsPropertyCollection) -> object - """ - - - -class SettingsPropertyIsReadOnlyException(Exception, ISerializable, _Exception): - """ - Provides an exception for read-only System.Configuration.SettingsProperty objects. - - SettingsPropertyIsReadOnlyException(message: str) - SettingsPropertyIsReadOnlyException(message: str, innerException: Exception) - SettingsPropertyIsReadOnlyException() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - __new__(cls: type) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class SettingsPropertyNotFoundException(Exception, ISerializable, _Exception): - """ - Provides an exception for System.Configuration.SettingsProperty objects that are not found. - - SettingsPropertyNotFoundException(message: str) - SettingsPropertyNotFoundException(message: str, innerException: Exception) - SettingsPropertyNotFoundException() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - __new__(cls: type) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class SettingsPropertyValue(object): - """ - Contains the value of a settings property that can be loaded and stored by an instance of System.Configuration.SettingsBase. - - SettingsPropertyValue(property: SettingsProperty) - """ - @staticmethod # known case of __new__ - def __new__(self, property): - """ __new__(cls: type, property: SettingsProperty) """ - pass - - Deserialized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets whether the value of a System.Configuration.SettingsProperty object has been deserialized. - - Get: Deserialized(self: SettingsPropertyValue) -> bool - - Set: Deserialized(self: SettingsPropertyValue) = value - """ - - IsDirty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets whether the value of a System.Configuration.SettingsProperty object has changed. - - Get: IsDirty(self: SettingsPropertyValue) -> bool - - Set: IsDirty(self: SettingsPropertyValue) = value - """ - - Name = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the name of the property from the associated System.Configuration.SettingsProperty object. - - Get: Name(self: SettingsPropertyValue) -> str - """ - - Property = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the System.Configuration.SettingsProperty object. - - Get: Property(self: SettingsPropertyValue) -> SettingsProperty - """ - - PropertyValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the value of the System.Configuration.SettingsProperty object. - - Get: PropertyValue(self: SettingsPropertyValue) -> object - - Set: PropertyValue(self: SettingsPropertyValue) = value - """ - - SerializedValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the serialized value of the System.Configuration.SettingsProperty object. - - Get: SerializedValue(self: SettingsPropertyValue) -> object - - Set: SerializedValue(self: SettingsPropertyValue) = value - """ - - UsingDefaultValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a Boolean value specifying whether the value of the System.Configuration.SettingsPropertyValue object is the default value as defined by the System.Configuration.SettingsProperty.DefaultValue property value on the associated System.Configuration.SettingsProperty object. - - Get: UsingDefaultValue(self: SettingsPropertyValue) -> bool - """ - - - -class SettingsPropertyValueCollection(object, IEnumerable, ICloneable, ICollection): - """ - Contains a collection of settings property values that map System.Configuration.SettingsProperty objects to System.Configuration.SettingsPropertyValue objects. - - SettingsPropertyValueCollection() - """ - def Add(self, property): - # type: (self: SettingsPropertyValueCollection, property: SettingsPropertyValue) - """ - Add(self: SettingsPropertyValueCollection, property: SettingsPropertyValue) - Adds a System.Configuration.SettingsPropertyValue object to the collection. - - property: A System.Configuration.SettingsPropertyValue object. - """ - pass - - def Clear(self): - # type: (self: SettingsPropertyValueCollection) - """ - Clear(self: SettingsPropertyValueCollection) - Removes all System.Configuration.SettingsPropertyValue objects from the collection. - """ - pass - - def Clone(self): - # type: (self: SettingsPropertyValueCollection) -> object - """ - Clone(self: SettingsPropertyValueCollection) -> object - - Creates a copy of the existing collection. - Returns: A System.Configuration.SettingsPropertyValueCollection class. - """ - pass - - def CopyTo(self, array, index): - # type: (self: SettingsPropertyValueCollection, array: Array, index: int) - """ - CopyTo(self: SettingsPropertyValueCollection, array: Array, index: int) - Copies this System.Configuration.SettingsPropertyValueCollection collection to an array. - - array: The array to copy the collection to. - index: The index at which to begin copying. - """ - pass - - def GetEnumerator(self): - # type: (self: SettingsPropertyValueCollection) -> IEnumerator - """ - GetEnumerator(self: SettingsPropertyValueCollection) -> IEnumerator - - Gets the System.Collections.IEnumerator object as it applies to the collection. - Returns: The System.Collections.IEnumerator object as it applies to the collection. - """ - pass - - def Remove(self, name): - # type: (self: SettingsPropertyValueCollection, name: str) - """ - Remove(self: SettingsPropertyValueCollection, name: str) - Removes a System.Configuration.SettingsPropertyValue object from the collection. - - name: The name of the System.Configuration.SettingsPropertyValue object. - """ - pass - - def SetReadOnly(self): - # type: (self: SettingsPropertyValueCollection) - """ - SetReadOnly(self: SettingsPropertyValueCollection) - Sets the collection to be read-only. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that specifies the number of System.Configuration.SettingsPropertyValue objects in the collection. - - Get: Count(self: SettingsPropertyValueCollection) -> int - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value that indicates whether access to the collection is synchronized (thread safe). - - Get: IsSynchronized(self: SettingsPropertyValueCollection) -> bool - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the object to synchronize access to the collection. - - Get: SyncRoot(self: SettingsPropertyValueCollection) -> object - """ - - - -class SettingsPropertyWrongTypeException(Exception, ISerializable, _Exception): - """ - Provides an exception that is thrown when an invalid type is used with a System.Configuration.SettingsProperty object. - - SettingsPropertyWrongTypeException(message: str) - SettingsPropertyWrongTypeException(message: str, innerException: Exception) - SettingsPropertyWrongTypeException() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - __new__(cls: type) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class SettingsProviderAttribute(Attribute, _Attribute): - """ - Specifies the settings provider used to provide storage for the current application settings class or property. This class cannot be inherited. - - SettingsProviderAttribute(providerTypeName: str) - SettingsProviderAttribute(providerType: Type) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, providerTypeName: str) - __new__(cls: type, providerType: Type) - """ - pass - - ProviderTypeName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the type name of the settings provider. - - Get: ProviderTypeName(self: SettingsProviderAttribute) -> str - """ - - - -class SettingsProviderCollection(ProviderCollection, IEnumerable, ICollection): - """ - Represents a collection of application settings providers. - - SettingsProviderCollection() - """ - def Add(self, provider): - # type: (self: SettingsProviderCollection, provider: ProviderBase) - """ - Add(self: SettingsProviderCollection, provider: ProviderBase) - Adds a new settings provider to the collection. - - provider: A System.Configuration.Provider.ProviderBase to add to the collection. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - -class SettingsSavingEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the System.Configuration.ApplicationSettingsBase.SettingsSaving event. - - SettingsSavingEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: SettingsSavingEventHandler, sender: object, e: CancelEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: SettingsSavingEventHandler, sender: object, e: CancelEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: SettingsSavingEventHandler, result: IAsyncResult) - """ EndInvoke(self: SettingsSavingEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: SettingsSavingEventHandler, sender: object, e: CancelEventArgs) - """ Invoke(self: SettingsSavingEventHandler, sender: object, e: CancelEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class SettingsSerializeAs(Enum, IComparable, IFormattable, IConvertible): - """ - Determines the serialization scheme used to store application settings. - - enum SettingsSerializeAs, values: Binary (2), ProviderSpecific (3), String (0), Xml (1) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Binary = None - ProviderSpecific = None - String = None - value__ = None - Xml = None - - -class SettingsSerializeAsAttribute(Attribute, _Attribute): - """ - Specifies the serialization mechanism that the settings provider should use. This class cannot be inherited. - - SettingsSerializeAsAttribute(serializeAs: SettingsSerializeAs) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, serializeAs): - """ __new__(cls: type, serializeAs: SettingsSerializeAs) """ - pass - - SerializeAs = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the System.Configuration.SettingsSerializeAs enumeration value that specifies the serialization scheme. - - Get: SerializeAs(self: SettingsSerializeAsAttribute) -> SettingsSerializeAs - """ - - - -class SettingValueElement(ConfigurationElement): - """ - Contains the XML representing the serialized value of the setting. This class cannot be inherited. - - SettingValueElement() - """ - def Equals(self, settingValue): - # type: (self: SettingValueElement, settingValue: object) -> bool - """ - Equals(self: SettingValueElement, settingValue: object) -> bool - - Compares the current System.Configuration.SettingValueElement instance to the specified object. - - settingValue: The object to compare. - Returns: true if the System.Configuration.SettingValueElement instance is equal to the specified object; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: SettingValueElement) -> int - """ - GetHashCode(self: SettingValueElement) -> int - - Gets a unique value representing the System.Configuration.SettingValueElement current instance. - Returns: A unique value representing the System.Configuration.SettingValueElement current instance. - """ - pass - - ElementProperty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ConfigurationElementProperty object that represents the System.Configuration.ConfigurationElement object itself. """ - - EvaluationContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ContextInformation object for the System.Configuration.ConfigurationElement object. """ - - HasContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - Properties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - ValueXml = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the value of a System.Configuration.SettingValueElement object by using an System.Xml.XmlNode object. - - Get: ValueXml(self: SettingValueElement) -> XmlNode - - Set: ValueXml(self: SettingValueElement) = value - """ - - - -class SingleTagSectionHandler(object, IConfigurationSectionHandler): - """ - Handles configuration sections that are represented by a single XML tag in the .config file. - - SingleTagSectionHandler() - """ - def Create(self, parent, context, section): - # type: (self: SingleTagSectionHandler, parent: object, context: object, section: XmlNode) -> object - """ - Create(self: SingleTagSectionHandler, parent: object, context: object, section: XmlNode) -> object - - Used internally to create a new instance of this object. - - parent: The parent of this object. - context: The context of this object. - section: The System.Xml.XmlNode object in the configuration. - Returns: The created object handler. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - -class SpecialSetting(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies the special setting category of a application settings property. - - enum SpecialSetting, values: ConnectionString (0), WebServiceUrl (1) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ConnectionString = None - value__ = None - WebServiceUrl = None - - -class SpecialSettingAttribute(Attribute, _Attribute): - """ - Indicates that an application settings property has a special significance. This class cannot be inherited. - - SpecialSettingAttribute(specialSetting: SpecialSetting) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, specialSetting): - """ __new__(cls: type, specialSetting: SpecialSetting) """ - pass - - SpecialSetting = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value describing the special setting category of the application settings property. - - Get: SpecialSetting(self: SpecialSettingAttribute) -> SpecialSetting - """ - - - -class UriSection(ConfigurationSection): - """ - Represents the Uri section within a configuration file. - - UriSection() - """ - ElementProperty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ConfigurationElementProperty object that represents the System.Configuration.ConfigurationElement object itself. """ - - EvaluationContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the System.Configuration.ContextInformation object for the System.Configuration.ConfigurationElement object. """ - - HasContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - Idn = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (IDN) processing in the System.Uri class. - """ - Gets an System.Configuration.IdnElement object that contains the configuration setting for International Domain Name (IDN) processing in the System.Uri class. - - Get: Idn(self: UriSection) -> IdnElement - """ - - IriParsing = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (IRI) parsing in the System.Uri class. - """ - Gets an System.Configuration.IriParsingElement object that contains the configuration setting for International Resource Identifiers (IRI) parsing in the System.Uri class. - - Get: IriParsing(self: UriSection) -> IriParsingElement - """ - - Properties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - - SchemeSettings = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.Configuration.SchemeSettingElementCollection object that contains the configuration settings for scheme parsing in the System.Uri class. - - Get: SchemeSettings(self: UriSection) -> SchemeSettingElementCollection - """ - - - -class UserScopedSettingAttribute(SettingAttribute, _Attribute): - """ - Specifies that an application settings group or property contains distinct values for each user of an application. This class cannot be inherited. - - UserScopedSettingAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class UserSettingsGroup(ConfigurationSectionGroup): - """ - Represents a grouping of related user settings sections within a configuration file. This class cannot be inherited. - - UserSettingsGroup() - """ - -# variables with complex values - diff --git a/pyesapi/stubs/System/Double.py b/pyesapi/stubs/System/Double.py deleted file mode 100644 index fea714c..0000000 --- a/pyesapi/stubs/System/Double.py +++ /dev/null @@ -1,2 +0,0 @@ -class Double: - ... \ No newline at end of file diff --git a/pyesapi/stubs/System/Int32.py b/pyesapi/stubs/System/Int32.py deleted file mode 100644 index 682a4be..0000000 --- a/pyesapi/stubs/System/Int32.py +++ /dev/null @@ -1,2 +0,0 @@ -class Int32: - ... diff --git a/pyesapi/stubs/System/Media.py b/pyesapi/stubs/System/Media.py deleted file mode 100644 index c9c754e..0000000 --- a/pyesapi/stubs/System/Media.py +++ /dev/null @@ -1,242 +0,0 @@ -# encoding: utf-8 -# module System.Media calls itself Media -# from System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class SoundPlayer(Component, IComponent, IDisposable, ISerializable): - """ - Controls playback of a sound from a .wav file. - - SoundPlayer() - SoundPlayer(soundLocation: str) - SoundPlayer(stream: Stream) - """ - def Dispose(self): - # type: (self: Component, disposing: bool) - """ - Dispose(self: Component, disposing: bool) - Releases the unmanaged resources used by the System.ComponentModel.Component and optionally releases the managed resources. - - disposing: true to release both managed and unmanaged resources; false to release only unmanaged resources. - """ - pass - - def GetService(self, *args): #cannot find CLR method - # type: (self: Component, service: Type) -> object - """ - GetService(self: Component, service: Type) -> object - - Returns an object that represents a service provided by the System.ComponentModel.Component or by its System.ComponentModel.Container. - - service: A service provided by the System.ComponentModel.Component. - Returns: An System.Object that represents a service provided by the System.ComponentModel.Component, or null if the System.ComponentModel.Component does not provide the specified service. - """ - pass - - def Load(self): - # type: (self: SoundPlayer) - """ - Load(self: SoundPlayer) - Loads a sound synchronously. - """ - pass - - def LoadAsync(self): - # type: (self: SoundPlayer) - """ - LoadAsync(self: SoundPlayer) - Loads a .wav file from a stream or a Web resource using a new thread. - """ - pass - - def MemberwiseClone(self, *args): #cannot find CLR method - # type: (self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - """ - MemberwiseClone(self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - - Creates a shallow copy of the current System.MarshalByRefObject object. - - cloneIdentity: false to delete the current System.MarshalByRefObject object's identity, which will cause the object to be assigned a new identity when it is marshaled across a remoting boundary. A value of false is usually appropriate. true to copy the current - System.MarshalByRefObject object's identity to its clone, which will cause remoting client calls to be routed to the remote server object. - - Returns: A shallow copy of the current System.MarshalByRefObject object. - MemberwiseClone(self: object) -> object - - Creates a shallow copy of the current System.Object. - Returns: A shallow copy of the current System.Object. - """ - pass - - def OnLoadCompleted(self, *args): #cannot find CLR method - # type: (self: SoundPlayer, e: AsyncCompletedEventArgs) - """ - OnLoadCompleted(self: SoundPlayer, e: AsyncCompletedEventArgs) - Raises the System.Media.SoundPlayer.LoadCompleted event. - - e: An System.ComponentModel.AsyncCompletedEventArgs that contains the event data. - """ - pass - - def OnSoundLocationChanged(self, *args): #cannot find CLR method - # type: (self: SoundPlayer, e: EventArgs) - """ - OnSoundLocationChanged(self: SoundPlayer, e: EventArgs) - Raises the System.Media.SoundPlayer.SoundLocationChanged event. - - e: An System.EventArgs that contains the event data. - """ - pass - - def OnStreamChanged(self, *args): #cannot find CLR method - # type: (self: SoundPlayer, e: EventArgs) - """ - OnStreamChanged(self: SoundPlayer, e: EventArgs) - Raises the System.Media.SoundPlayer.StreamChanged event. - - e: An System.EventArgs that contains the event data. - """ - pass - - def Play(self): - # type: (self: SoundPlayer) - """ - Play(self: SoundPlayer) - Plays the .wav file using a new thread, and loads the .wav file first if it has not been loaded. - """ - pass - - def PlayLooping(self): - # type: (self: SoundPlayer) - """ - PlayLooping(self: SoundPlayer) - Plays and loops the .wav file using a new thread, and loads the .wav file first if it has not been loaded. - """ - pass - - def PlaySync(self): - # type: (self: SoundPlayer) - """ - PlaySync(self: SoundPlayer) - Plays the .wav file and loads the .wav file first if it has not been loaded. - """ - pass - - def Stop(self): - # type: (self: SoundPlayer) - """ - Stop(self: SoundPlayer) - Stops playback of the sound if playback is occurring. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, soundLocation: str) - __new__(cls: type, stream: Stream) - __new__(cls: type, serializationInfo: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CanRaiseEvents = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a value indicating whether the component can raise an event. """ - - DesignMode = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a value that indicates whether the System.ComponentModel.Component is currently in design mode. """ - - Events = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the list of event handlers that are attached to this System.ComponentModel.Component. """ - - IsLoadCompleted = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether loading of a .wav file has successfully completed. - - Get: IsLoadCompleted(self: SoundPlayer) -> bool - """ - - LoadTimeout = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the time, in milliseconds, in which the .wav file must load. - - Get: LoadTimeout(self: SoundPlayer) -> int - - Set: LoadTimeout(self: SoundPlayer) = value - """ - - SoundLocation = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the file path or URL of the .wav file to load. - - Get: SoundLocation(self: SoundPlayer) -> str - - Set: SoundLocation(self: SoundPlayer) = value - """ - - Stream = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the System.IO.Stream from which to load the .wav file. - - Get: Stream(self: SoundPlayer) -> Stream - - Set: Stream(self: SoundPlayer) = value - """ - - Tag = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the System.Object that contains data about the System.Media.SoundPlayer. - - Get: Tag(self: SoundPlayer) -> object - - Set: Tag(self: SoundPlayer) = value - """ - - - LoadCompleted = None - SoundLocationChanged = None - StreamChanged = None - - -class SystemSound(object): - """ Represents a system sound type. """ - def Play(self): - # type: (self: SystemSound) - """ - Play(self: SystemSound) - Plays the system sound type. - """ - pass - - -class SystemSounds(object): - """ Retrieves sounds associated with a set of Windows operating system sound-event types. This class cannot be inherited. """ - Asterisk = None - Beep = None - Exclamation = None - Hand = None - Question = None - - diff --git a/pyesapi/stubs/System/Runtime/__init__.py b/pyesapi/stubs/System/Runtime/__init__.py deleted file mode 100644 index d18541d..0000000 --- a/pyesapi/stubs/System/Runtime/__init__.py +++ /dev/null @@ -1,210 +0,0 @@ -# encoding: utf-8 -# module System.Runtime calls itself Runtime -# from mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class AssemblyTargetedPatchBandAttribute(Attribute, _Attribute): - """ - Specifies patch band information for targeted patching of the .NET Framework. - - AssemblyTargetedPatchBandAttribute(targetedPatchBand: str) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, targetedPatchBand): - """ __new__(cls: type, targetedPatchBand: str) """ - pass - - TargetedPatchBand = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the patch band. - - Get: TargetedPatchBand(self: AssemblyTargetedPatchBandAttribute) -> str - """ - - - -class GCLargeObjectHeapCompactionMode(Enum, IComparable, IFormattable, IConvertible): - # type: (2), Default (1) - """ enum GCLargeObjectHeapCompactionMode, values: CompactOnce (2), Default (1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CompactOnce = None - Default = None - value__ = None - - -class GCLatencyMode(Enum, IComparable, IFormattable, IConvertible): - """ - Adjusts the time that the garbage collector intrudes in your application. - - enum GCLatencyMode, values: Batch (0), Interactive (1), LowLatency (2), NoGCRegion (4), SustainedLowLatency (3) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Batch = None - Interactive = None - LowLatency = None - NoGCRegion = None - SustainedLowLatency = None - value__ = None - - -class GCSettings(object): - """ Specifies the garbage collection settings for the current process. """ - IsServerGC = False - LargeObjectHeapCompactionMode = None - LatencyMode = None - __all__ = [] - - -class MemoryFailPoint(CriticalFinalizerObject, IDisposable): - """ - Checks for sufficient memory resources prior to execution. This class cannot be inherited. - - MemoryFailPoint(sizeInMegabytes: int) - """ - def Dispose(self): - # type: (self: MemoryFailPoint) - """ - Dispose(self: MemoryFailPoint) - Releases all resources used by the System.Runtime.MemoryFailPoint. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, sizeInMegabytes): - """ __new__(cls: type, sizeInMegabytes: int) """ - pass - - -class ProfileOptimization(object): - # no doc - @staticmethod - def SetProfileRoot(directoryPath): - # type: (directoryPath: str) - """ SetProfileRoot(directoryPath: str) """ - pass - - @staticmethod - def StartProfile(profile): - # type: (profile: str) - """ StartProfile(profile: str) """ - pass - - __all__ = [ - 'SetProfileRoot', - 'StartProfile', - ] - - -class TargetedPatchingOptOutAttribute(Attribute, _Attribute): - # type: (NGen) images. - """ - Indicates that the .NET Framework class library method to which this attribute is applied is unlikely to be affected by servicing releases, and therefore is eligible to be inlined across Native Image Generator (NGen) images. - - TargetedPatchingOptOutAttribute(reason: str) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, reason): - """ __new__(cls: type, reason: str) """ - pass - - Reason = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (NGen) images. - """ - Gets the reason why the method to which this attribute is applied is considered to be eligible for inlining across Native Image Generator (NGen) images. - - Get: Reason(self: TargetedPatchingOptOutAttribute) -> str - """ - - - -# variables with complex values - diff --git a/pyesapi/stubs/System/Timers.py b/pyesapi/stubs/System/Timers.py deleted file mode 100644 index 1e145ae..0000000 --- a/pyesapi/stubs/System/Timers.py +++ /dev/null @@ -1,296 +0,0 @@ -# encoding: utf-8 -# module System.Timers calls itself Timers -# from System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class ElapsedEventArgs(EventArgs): - """ Provides data for the System.Timers.Timer.Elapsed event. """ - SignalTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the time the System.Timers.Timer.Elapsed event was raised. - - Get: SignalTime(self: ElapsedEventArgs) -> DateTime - """ - - - -class ElapsedEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the System.Timers.Timer.Elapsed event of a System.Timers.Timer. - - ElapsedEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: ElapsedEventHandler, sender: object, e: ElapsedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: ElapsedEventHandler, sender: object, e: ElapsedEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: ElapsedEventHandler, result: IAsyncResult) - """ EndInvoke(self: ElapsedEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: ElapsedEventHandler, sender: object, e: ElapsedEventArgs) - """ Invoke(self: ElapsedEventHandler, sender: object, e: ElapsedEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class Timer(Component, IComponent, IDisposable, ISupportInitialize): - """ - Generates recurring events in an application. - - Timer() - Timer(interval: float) - """ - def BeginInit(self): - # type: (self: Timer) - """ - BeginInit(self: Timer) - Begins the run-time initialization of a System.Timers.Timer that is used on a form or by another component. - """ - pass - - def Close(self): - # type: (self: Timer) - """ - Close(self: Timer) - Releases the resources used by the System.Timers.Timer. - """ - pass - - def Dispose(self): - # type: (self: Timer, disposing: bool) - """ - Dispose(self: Timer, disposing: bool) - Releases all resources used by the current System.Timers.Timer. - - disposing: true to release both managed and unmanaged resources; false to release only unmanaged resources. - """ - pass - - def EndInit(self): - # type: (self: Timer) - """ - EndInit(self: Timer) - Ends the run-time initialization of a System.Timers.Timer that is used on a form or by another component. - """ - pass - - def GetService(self, *args): #cannot find CLR method - # type: (self: Component, service: Type) -> object - """ - GetService(self: Component, service: Type) -> object - - Returns an object that represents a service provided by the System.ComponentModel.Component or by its System.ComponentModel.Container. - - service: A service provided by the System.ComponentModel.Component. - Returns: An System.Object that represents a service provided by the System.ComponentModel.Component, or null if the System.ComponentModel.Component does not provide the specified service. - """ - pass - - def MemberwiseClone(self, *args): #cannot find CLR method - # type: (self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - """ - MemberwiseClone(self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - - Creates a shallow copy of the current System.MarshalByRefObject object. - - cloneIdentity: false to delete the current System.MarshalByRefObject object's identity, which will cause the object to be assigned a new identity when it is marshaled across a remoting boundary. A value of false is usually appropriate. true to copy the current - System.MarshalByRefObject object's identity to its clone, which will cause remoting client calls to be routed to the remote server object. - - Returns: A shallow copy of the current System.MarshalByRefObject object. - MemberwiseClone(self: object) -> object - - Creates a shallow copy of the current System.Object. - Returns: A shallow copy of the current System.Object. - """ - pass - - def Start(self): - # type: (self: Timer) - """ - Start(self: Timer) - Starts raising the System.Timers.Timer.Elapsed event by setting System.Timers.Timer.Enabled to true. - """ - pass - - def Stop(self): - # type: (self: Timer) - """ - Stop(self: Timer) - Stops raising the System.Timers.Timer.Elapsed event by setting System.Timers.Timer.Enabled to false. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, interval=None): - """ - __new__(cls: type) - __new__(cls: type, interval: float) - """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - AutoReset = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a value indicating whether the System.Timers.Timer should raise the System.Timers.Timer.Elapsed event each time the specified interval elapses or only after the first time it elapses. - - Get: AutoReset(self: Timer) -> bool - - Set: AutoReset(self: Timer) = value - """ - - CanRaiseEvents = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a value indicating whether the component can raise an event. """ - - DesignMode = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets a value that indicates whether the System.ComponentModel.Component is currently in design mode. """ - - Enabled = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a value indicating whether the System.Timers.Timer should raise the System.Timers.Timer.Elapsed event. - - Get: Enabled(self: Timer) -> bool - - Set: Enabled(self: Timer) = value - """ - - Events = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets the list of event handlers that are attached to this System.ComponentModel.Component. """ - - Interval = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the interval at which to raise the System.Timers.Timer.Elapsed event. - - Get: Interval(self: Timer) -> float - - Set: Interval(self: Timer) = value - """ - - Site = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the site that binds the System.Timers.Timer to its container in design mode. - - Get: Site(self: Timer) -> ISite - - Set: Site(self: Timer) = value - """ - - SynchronizingObject = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the object used to marshal event-handler calls that are issued when an interval has elapsed. - - Get: SynchronizingObject(self: Timer) -> ISynchronizeInvoke - - Set: SynchronizingObject(self: Timer) = value - """ - - - Elapsed = None - - -class TimersDescriptionAttribute(DescriptionAttribute, _Attribute): - """ - Sets the description that visual designers can display when referencing an event, extender, or property. - - TimersDescriptionAttribute(description: str) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, description): - """ __new__(cls: type, description: str) """ - pass - - Description = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the description that visual designers can display when referencing an event, extender, or property. - - Get: Description(self: TimersDescriptionAttribute) -> str - """ - - DescriptionValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ Gets or sets the string stored as the description. """ - - - diff --git a/pyesapi/stubs/System/Type/__init__.py b/pyesapi/stubs/System/Type/__init__.py deleted file mode 100644 index 2aaa49b..0000000 --- a/pyesapi/stubs/System/Type/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -class Type: - @staticmethod - def GetType(type_name: str): - ... - \ No newline at end of file diff --git a/pyesapi/stubs/System/Web.py b/pyesapi/stubs/System/Web.py deleted file mode 100644 index bfd0cb4..0000000 --- a/pyesapi/stubs/System/Web.py +++ /dev/null @@ -1,209 +0,0 @@ -# encoding: utf-8 -# module System.Web calls itself Web -# from System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class AspNetHostingPermission(CodeAccessPermission, IPermission, ISecurityEncodable, IStackWalk, IUnrestrictedPermission): - """ - Controls access permissions in ASP.NET hosted environments. This class cannot be inherited. - - AspNetHostingPermission(state: PermissionState) - AspNetHostingPermission(level: AspNetHostingPermissionLevel) - """ - def Copy(self): - # type: (self: AspNetHostingPermission) -> IPermission - """ - Copy(self: AspNetHostingPermission) -> IPermission - - When implemented by a derived class, creates and returns an identical copy of the current permission object. - Returns: A copy of the current permission object. - """ - pass - - def FromXml(self, securityElement): - # type: (self: AspNetHostingPermission, securityElement: SecurityElement) - """ - FromXml(self: AspNetHostingPermission, securityElement: SecurityElement) - Reconstructs a permission object with a specified state from an XML encoding. - - securityElement: The System.Security.SecurityElement containing the XML encoding to use to reconstruct the permission object. - """ - pass - - def Intersect(self, target): - # type: (self: AspNetHostingPermission, target: IPermission) -> IPermission - """ - Intersect(self: AspNetHostingPermission, target: IPermission) -> IPermission - - When implemented by a derived class, creates and returns a permission that is the intersection of the current permission and the specified permission. - - target: A permission to combine with the current permission. It must be of the same type as the current permission. - Returns: An System.Security.IPermission that represents the intersection of the current permission and the specified permission; otherwise, null if the intersection is empty. - """ - pass - - def IsSubsetOf(self, target): - # type: (self: AspNetHostingPermission, target: IPermission) -> bool - """ - IsSubsetOf(self: AspNetHostingPermission, target: IPermission) -> bool - - Returns a value indicating whether the current permission is a subset of the specified permission. - - target: The System.Security.IPermission to combine with the current permission. It must be of the same type as the current System.Security.IPermission. - Returns: true if the current System.Security.IPermission is a subset of the specified System.Security.IPermission; otherwise, false. - """ - pass - - def IsUnrestricted(self): - # type: (self: AspNetHostingPermission) -> bool - """ - IsUnrestricted(self: AspNetHostingPermission) -> bool - - Returns a value indicating whether unrestricted access to the resource that is protected by the current permission is allowed. - Returns: true if unrestricted use of the resource protected by the permission is allowed; otherwise, false. - """ - pass - - def ToXml(self): - # type: (self: AspNetHostingPermission) -> SecurityElement - """ - ToXml(self: AspNetHostingPermission) -> SecurityElement - - Creates an XML encoding of the permission object and its current state. - Returns: A System.Security.SecurityElement containing the XML encoding of the permission object, including any state information. - """ - pass - - def Union(self, target): - # type: (self: AspNetHostingPermission, target: IPermission) -> IPermission - """ - Union(self: AspNetHostingPermission, target: IPermission) -> IPermission - - Creates a permission that is the union of the current permission and the specified permission. - - target: A permission to combine with the current permission. It must be of the same type as the current permission. - Returns: An System.Security.IPermission that represents the union of the current permission and the specified permission. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, state: PermissionState) - __new__(cls: type, level: AspNetHostingPermissionLevel) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Level = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the current hosting permission level for an ASP.NET application. - - Get: Level(self: AspNetHostingPermission) -> AspNetHostingPermissionLevel - - Set: Level(self: AspNetHostingPermission) = value - """ - - - -class AspNetHostingPermissionAttribute(CodeAccessSecurityAttribute, _Attribute): - """ - Allows security actions for System.Web.AspNetHostingPermission to be applied to code using declarative security. This class cannot be inherited. - - AspNetHostingPermissionAttribute(action: SecurityAction) - """ - def CreatePermission(self): - # type: (self: AspNetHostingPermissionAttribute) -> IPermission - """ - CreatePermission(self: AspNetHostingPermissionAttribute) -> IPermission - - Creates a new System.Web.AspNetHostingPermission with the permission level previously set by the System.Web.AspNetHostingPermissionAttribute.Level property. - Returns: An System.Security.IPermission that is the new System.Web.AspNetHostingPermission. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, action): - """ __new__(cls: type, action: SecurityAction) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - Level = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the current hosting permission level. - - Get: Level(self: AspNetHostingPermissionAttribute) -> AspNetHostingPermissionLevel - - Set: Level(self: AspNetHostingPermissionAttribute) = value - """ - - - -class AspNetHostingPermissionLevel(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies the trust level that is granted to an ASP.NET Web application. - - enum AspNetHostingPermissionLevel, values: High (500), Low (300), Medium (400), Minimal (200), None (100), Unrestricted (600) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - High = None - Low = None - Medium = None - Minimal = None - None = None - Unrestricted = None - value__ = None - - diff --git a/pyesapi/stubs/System/Windows/Input.py b/pyesapi/stubs/System/Windows/Input.py deleted file mode 100644 index 41f1918..0000000 --- a/pyesapi/stubs/System/Windows/Input.py +++ /dev/null @@ -1,29 +0,0 @@ -# encoding: utf-8 -# module System.Windows.Input calls itself Input -# from System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class ICommand: - # no doc - def CanExecute(self, parameter): - # type: (self: ICommand, parameter: object) -> bool - """ CanExecute(self: ICommand, parameter: object) -> bool """ - pass - - def Execute(self, parameter): - # type: (self: ICommand, parameter: object) - """ Execute(self: ICommand, parameter: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - CanExecuteChanged = None - - diff --git a/pyesapi/stubs/System/Windows/Markup.py b/pyesapi/stubs/System/Windows/Markup.py deleted file mode 100644 index da664f0..0000000 --- a/pyesapi/stubs/System/Windows/Markup.py +++ /dev/null @@ -1,38 +0,0 @@ -# encoding: utf-8 -# module System.Windows.Markup calls itself Markup -# from System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class ValueSerializerAttribute(Attribute, _Attribute): - # type: (valueSerializerType: Type) - """ - ValueSerializerAttribute(valueSerializerType: Type) - ValueSerializerAttribute(valueSerializerTypeName: str) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, valueSerializerType: Type) - __new__(cls: type, valueSerializerTypeName: str) - """ - pass - - ValueSerializerType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ValueSerializerAttribute) -> Type - """ Get: ValueSerializerType(self: ValueSerializerAttribute) -> Type """ - - ValueSerializerTypeName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ValueSerializerAttribute) -> str - """ Get: ValueSerializerTypeName(self: ValueSerializerAttribute) -> str """ - - - diff --git a/pyesapi/stubs/System/Windows/__init__.py b/pyesapi/stubs/System/Windows/__init__.py deleted file mode 100644 index bd85ada..0000000 --- a/pyesapi/stubs/System/Windows/__init__.py +++ /dev/null @@ -1,11 +0,0 @@ -# encoding: utf-8 -# module System.Windows calls itself Windows -# from System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# no functions -# no classes -# variables with complex values - diff --git a/pyesapi/stubs/System/__init__.py b/pyesapi/stubs/System/__init__.py deleted file mode 100644 index aa5054c..0000000 --- a/pyesapi/stubs/System/__init__.py +++ /dev/null @@ -1,25723 +0,0 @@ -# encoding: utf-8 -# module System -# from mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089, System.Xml, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -# by generator 1.145 -# no doc -# no imports - -# functions - -def Action(p_object, method): # real signature unknown; restored from __doc__ - """ - Encapsulates a method that has no parameters and does not return a value. - - Action(object: object, method: IntPtr) - """ - pass - -def EventHandler(p_object, method): # real signature unknown; restored from __doc__ - """ - Represents the method that will handle an event that has no event data. - - EventHandler(object: object, method: IntPtr) - """ - pass - -def Func(*args, **kwargs): # real signature unknown - """ """ - pass - -def IComparable(*args, **kwargs): # real signature unknown - """ Defines a generalized type-specific comparison method that a value type or class implements to order or sort its instances. """ - pass - -def Nullable(*args, **kwargs): # real signature unknown - """ Supports a value type that can be assigned null like a reference type. This class cannot be inherited. """ - pass - -def Tuple(*args, **kwargs): # real signature unknown - """ Provides static methods for creating tuple objects. """ - pass - -def ValueTuple(*args, **kwargs): # real signature unknown - """ """ - pass - -def WeakReference(target): # real signature unknown; restored from __doc__ - """ - Represents a weak reference, which references an object while still allowing that object to be reclaimed by garbage collection. - - WeakReference(target: object) - WeakReference(target: object, trackResurrection: bool) - """ - pass - -# classes - -class Object: - """ - Supports all classes in the .NET Framework class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all classes in the .NET Framework; it is the root of the type hierarchy. - - object() - """ - def __delattr__(self, *args): #cannot find CLR method - """ __delattr__(self: object, name: str) """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(self: object, formatSpec: str) -> str """ - pass - - def __getattribute__(self, *args): #cannot find CLR method - """ __getattribute__(self: object, name: str) -> object """ - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self): - """ - __new__(cls: type) -> object - __new__(cls: type, *args�: Array[object]) -> object - __new__(cls: type, **kwargs�: dict, *args�: Array[object]) -> object - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __reduce__(self, *args): #cannot find CLR method - """ helper for pickle """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __setattr__(self, *args): #cannot find CLR method - """ __setattr__(self: object, name: str, value: object) """ - pass - - def __sizeof__(self, *args): #cannot find CLR method - """ __sizeof__(self: object) -> int """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __subclasshook__(self, *args): #cannot find CLR method - """ __subclasshook__(*args: Array[object]) -> NotImplementedType """ - pass - - __class__ = None - - -class Exception(object, ISerializable, _Exception): - """ - Represents errors that occur during application execution. - - Exception() - Exception(message: str) - Exception(message: str, innerException: Exception) - """ - def GetBaseException(self): - # type: (self: Exception) -> Exception - """ - GetBaseException(self: Exception) -> Exception - - When overridden in a derived class, returns the System.Exception that is the root cause of one or more subsequent exceptions. - Returns: The first exception thrown in a chain of exceptions. If the System.Exception.InnerException property of the current exception is a null reference (Nothing in Visual Basic), this property returns the current exception. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: Exception, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: Exception, info: SerializationInfo, context: StreamingContext) - When overridden in a derived class, sets the System.Runtime.Serialization.SerializationInfo with information about the exception. - - info: The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown. - context: The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination. - """ - pass - - def GetType(self): - # type: (self: Exception) -> Type - """ - GetType(self: Exception) -> Type - - Gets the runtime type of the current instance. - Returns: A System.Type object that represents the exact runtime type of the current instance. - """ - pass - - def ToString(self): - # type: (self: Exception) -> str - """ - ToString(self: Exception) -> str - - Creates and returns a string representation of the current exception. - Returns: A string representation of the current exception. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Data = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a collection of key/value pairs that provide additional user-defined information about the exception. - - Get: Data(self: Exception) -> IDictionary - """ - - HelpLink = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a link to the help file associated with this exception. - - Get: HelpLink(self: Exception) -> str - - Set: HelpLink(self: Exception) = value - """ - - HResult = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. - - Get: HResult(self: Exception) -> int - """ - - InnerException = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the System.Exception instance that caused the current exception. - - Get: InnerException(self: Exception) -> Exception - """ - - Message = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a message that describes the current exception. - - Get: Message(self: Exception) -> str - """ - - Source = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the name of the application or the object that causes the error. - - Get: Source(self: Exception) -> str - - Set: Source(self: Exception) = value - """ - - StackTrace = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a string representation of the immediate frames on the call stack. - - Get: StackTrace(self: Exception) -> str - """ - - TargetSite = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the method that throws the current exception. - - Get: TargetSite(self: Exception) -> MethodBase - """ - - - SerializeObjectState = None - - -class SystemException(Exception, ISerializable, _Exception): - """ - Defines the base class for predefined exceptions in the System namespace. - - SystemException() - SystemException(message: str) - SystemException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class AccessViolationException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when there is an attempt to read or write protected memory. - - AccessViolationException() - AccessViolationException(message: str) - AccessViolationException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class IDisposable: - """ Defines a method to release allocated resources. """ - def Dispose(self): - # type: (self: IDisposable) - """ - Dispose(self: IDisposable) - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class ActivationContext(object, IDisposable, ISerializable): - """ Identifies the activation context for the current application. This class cannot be inherited. """ - @staticmethod - def CreatePartialActivationContext(identity, manifestPaths=None): - # type: (identity: ApplicationIdentity) -> ActivationContext - """ - CreatePartialActivationContext(identity: ApplicationIdentity) -> ActivationContext - - Initializes a new instance of the System.ActivationContext class using the specified application identity. - - identity: An object that identifies an application. - Returns: An object with the specified application identity. - CreatePartialActivationContext(identity: ApplicationIdentity, manifestPaths: Array[str]) -> ActivationContext - - Initializes a new instance of the System.ActivationContext class using the specified application identity and array of manifest paths. - - identity: An object that identifies an application. - manifestPaths: A string array of manifest paths for the application. - Returns: An object with the specified application identity and array of manifest paths. - """ - pass - - def Dispose(self): - # type: (self: ActivationContext) - """ - Dispose(self: ActivationContext) - Releases all resources used by the System.ActivationContext. - """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - ApplicationManifestBytes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the ClickOnce application manifest for the current application. - - Get: ApplicationManifestBytes(self: ActivationContext) -> Array[Byte] - """ - - DeploymentManifestBytes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the ClickOnce deployment manifest for the current application. - - Get: DeploymentManifestBytes(self: ActivationContext) -> Array[Byte] - """ - - Form = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the form, or store context, for the current application. - - Get: Form(self: ActivationContext) -> ContextForm - """ - - Identity = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the application identity for the current application. - - Get: Identity(self: ActivationContext) -> ApplicationIdentity - """ - - - ContextForm = None - - -class Activator(object, _Activator): - """ Contains methods to create types of objects locally or remotely, or obtain references to existing remote objects. This class cannot be inherited. """ - @staticmethod - def CreateComInstanceFrom(assemblyName, typeName, hashValue=None, hashAlgorithm=None): - # type: (assemblyName: str, typeName: str) -> ObjectHandle - """ - CreateComInstanceFrom(assemblyName: str, typeName: str) -> ObjectHandle - - Creates an instance of the COM object whose name is specified, using the named assembly file and the constructor that best matches the specified parameters. - - assemblyName: The name of a file that contains an assembly where the type named typeName is sought. - typeName: The name of the preferred type. - Returns: A handle that must be unwrapped to access the newly created instance. - CreateComInstanceFrom(assemblyName: str, typeName: str, hashValue: Array[Byte], hashAlgorithm: AssemblyHashAlgorithm) -> ObjectHandle - - Creates an instance of the COM object whose name is specified, using the named assembly file and the default constructor. - - assemblyName: The name of a file that contains an assembly where the type named typeName is sought. - typeName: The name of the preferred type. - hashValue: The value of the computed hash code. - hashAlgorithm: The hash algorithm used for hashing files and generating the strong name. - Returns: A handle that must be unwrapped to access the newly created instance. - """ - pass - - @staticmethod - def CreateInstance(*__args): - # type: (type: Type, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo) -> object - """ - CreateInstance(type: Type, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo) -> object - - Creates an instance of the specified type using the constructor that best matches the specified parameters. - - type: The type of object to create. - bindingAttr: A combination of zero or more bit flags that affect the search for the type constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that uses bindingAttr and args to seek and identify the type constructor. If binder is null, the default binder is used. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the type constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - Returns: A reference to the newly created object. - CreateInstance(type: Type, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object]) -> object - - Creates an instance of the specified type using the constructor that best matches the specified parameters. - - type: The type of object to create. - bindingAttr: A combination of zero or more bit flags that affect the search for the type constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that uses bindingAttr and args to seek and identify the type constructor. If binder is null, the default binder is used. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the type constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - Returns: A reference to the newly created object. - CreateInstance(type: Type, *args: Array[object]) -> object - - Creates an instance of the specified type using the constructor that best matches the specified parameters. - - type: The type of object to create. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - Returns: A reference to the newly created object. - CreateInstance(type: Type, args: Array[object], activationAttributes: Array[object]) -> object - - Creates an instance of the specified type using the constructor that best matches the specified parameters. - - type: The type of object to create. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - Returns: A reference to the newly created object. - CreateInstance(type: Type) -> object - - Creates an instance of the specified type using that type's default constructor. - - type: The type of object to create. - Returns: A reference to the newly created object. - CreateInstance(assemblyName: str, typeName: str) -> ObjectHandle - - Creates an instance of the type whose name is specified, using the named assembly and default constructor. - - assemblyName: The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched. - typeName: The name of the preferred type. - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstance(assemblyName: str, typeName: str, activationAttributes: Array[object]) -> ObjectHandle - - Creates an instance of the type whose name is specified, using the named assembly and default constructor. - - assemblyName: The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched. - typeName: The name of the preferred type. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstance(type: Type, nonPublic: bool) -> object - - Creates an instance of the specified type using that type's default constructor. - - type: The type of object to create. - nonPublic: true if a public or nonpublic default constructor can match; false if only a public default constructor can match. - Returns: A reference to the newly created object. - CreateInstance[T]() -> T - CreateInstance(assemblyName: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object], securityInfo: Evidence) -> ObjectHandle - - Creates an instance of the type whose name is specified, using the named assembly and the constructor that best matches the specified parameters. - - assemblyName: The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched. - typeName: The name of the preferred type. - ignoreCase: true to specify that the search for typeName is not case-sensitive; false to specify that the search is case-sensitive. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - securityInfo: Information used to make security policy decisions and grant code permissions. - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstance(assemblyName: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object]) -> ObjectHandle - - Creates an instance of the type whose name is specified, using the named assembly and the constructor that best matches the specified parameters. - - assemblyName: The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched. - typeName: The name of the preferred type. - ignoreCase: true to specify that the search for typeName is not case-sensitive; false to specify that the search is case-sensitive. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstance(domain: AppDomain, assemblyName: str, typeName: str) -> ObjectHandle - - Creates an instance of the type whose name is specified in the specified remote domain, using the named assembly and default constructor. - - domain: The remote domain where the type named typeName is created. - assemblyName: The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched. - typeName: The name of the preferred type. - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstance(domain: AppDomain, assemblyName: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object], securityAttributes: Evidence) -> ObjectHandle - - Creates an instance of the type whose name is specified in the specified remote domain, using the named assembly and the constructor that best matches the specified parameters. - - domain: The domain where the type named typeName is created. - assemblyName: The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched. - typeName: The name of the preferred type. - ignoreCase: true to specify that the search for typeName is not case-sensitive; false to specify that the search is case-sensitive. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - securityAttributes: Information used to make security policy decisions and grant code permissions. - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstance(domain: AppDomain, assemblyName: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object]) -> ObjectHandle - - Creates an instance of the type whose name is specified in the specified remote domain, using the named assembly and the constructor that best matches the specified parameters. - - domain: The domain where the type named typeName is created. - assemblyName: The name of the assembly where the type named typeName is sought. If assemblyName is null, the executing assembly is searched. - typeName: The name of the preferred type. - ignoreCase: true to specify that the search for typeName is not case-sensitive; false to specify that the search is case-sensitive. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstance(activationContext: ActivationContext) -> ObjectHandle - - Creates an instance of the type designated by the specified System.ActivationContext object. - - activationContext: An activation context object that specifies the object to create. - Returns: A handle that must be unwrapped to access the newly created object. - CreateInstance(activationContext: ActivationContext, activationCustomData: Array[str]) -> ObjectHandle - - Creates an instance of the type that is designated by the specified System.ActivationContext object and activated with the specified custom activation data. - - activationContext: An activation context object that specifies the object to create. - activationCustomData: An array of Unicode strings that contain custom activation data. - Returns: A handle that must be unwrapped to access the newly created object. - """ - pass - - @staticmethod - def CreateInstanceFrom(*__args): - # type: (assemblyFile: str, typeName: str) -> ObjectHandle - """ - CreateInstanceFrom(assemblyFile: str, typeName: str) -> ObjectHandle - - Creates an instance of the type whose name is specified, using the named assembly file and default constructor. - - assemblyFile: The name of a file that contains an assembly where the type named typeName is sought. - typeName: The name of the preferred type. - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstanceFrom(assemblyFile: str, typeName: str, activationAttributes: Array[object]) -> ObjectHandle - - Creates an instance of the type whose name is specified, using the named assembly file and default constructor. - - assemblyFile: The name of a file that contains an assembly where the type named typeName is sought. - typeName: The name of the preferred type. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstanceFrom(assemblyFile: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object], securityInfo: Evidence) -> ObjectHandle - - Creates an instance of the type whose name is specified, using the named assembly file and the constructor that best matches the specified parameters. - - assemblyFile: The name of a file that contains an assembly where the type named typeName is sought. - typeName: The name of the preferred type. - ignoreCase: true to specify that the search for typeName is not case-sensitive; false to specify that the search is case-sensitive. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - securityInfo: Information used to make security policy decisions and grant code permissions. - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstanceFrom(assemblyFile: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object]) -> ObjectHandle - - Creates an instance of the type whose name is specified, using the named assembly file and the constructor that best matches the specified parameters. - - assemblyFile: The name of a file that contains an assembly where the type named typeName is sought. - typeName: The name of the preferred type. - ignoreCase: true to specify that the search for typeName is not case-sensitive; false to specify that the search is case-sensitive. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstanceFrom(domain: AppDomain, assemblyFile: str, typeName: str) -> ObjectHandle - - Creates an instance of the type whose name is specified in the specified remote domain, using the named assembly file and default constructor. - - domain: The remote domain where the type named typeName is created. - assemblyFile: The name of a file that contains an assembly where the type named typeName is sought. - typeName: The name of the preferred type. - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstanceFrom(domain: AppDomain, assemblyFile: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object], securityAttributes: Evidence) -> ObjectHandle - - Creates an instance of the type whose name is specified in the specified remote domain, using the named assembly file and the constructor that best matches the specified parameters. - - domain: The remote domain where the type named typeName is created. - assemblyFile: The name of a file that contains an assembly where the type named typeName is sought. - typeName: The name of the preferred type. - ignoreCase: true to specify that the search for typeName is not case-sensitive; false to specify that the search is case-sensitive. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - securityAttributes: Information used to make security policy decisions and grant code permissions. - Returns: A handle that must be unwrapped to access the newly created instance. - CreateInstanceFrom(domain: AppDomain, assemblyFile: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object]) -> ObjectHandle - - Creates an instance of the type whose name is specified in the specified remote domain, using the named assembly file and the constructor that best matches the specified parameters. - - domain: The remote domain where the type named typeName is created. - assemblyFile: The name of a file that contains an assembly where the type named typeName is sought. - typeName: The name of the preferred type. - ignoreCase: true to specify that the search for typeName is not case-sensitive; false to specify that the search is case-sensitive. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that uses bindingAttr and args to seek and identify the typeName constructor. If binder is null, the default binder is used. - args: An array of arguments that match in number, order, and type the parameters of the constructor to invoke. If args is an empty array or null, the constructor that takes no parameters (the default constructor) is invoked. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. This is typically an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that - is required to activate a remote object. - - Returns: A handle that must be unwrapped to access the newly created instance. - """ - pass - - @staticmethod - def GetObject(type, url, state=None): - # type: (type: Type, url: str) -> object - """ - GetObject(type: Type, url: str) -> object - - Creates a proxy for the well-known object indicated by the specified type and URL. - - type: The type of the well-known object to which you want to connect. - url: The URL of the well-known object. - Returns: A proxy that points to an endpoint served by the requested well-known object. - GetObject(type: Type, url: str, state: object) -> object - - Creates a proxy for the well-known object indicated by the specified type, URL, and channel data. - - type: The type of the well-known object to which you want to connect. - url: The URL of the well-known object. - state: Channel-specific data or null. - Returns: A proxy that points to an endpoint served by the requested well-known object. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - -class AggregateException(Exception, ISerializable, _Exception): - """ - Represents one or more errors that occur during application execution. - - AggregateException() - AggregateException(message: str) - AggregateException(message: str, innerException: Exception) - AggregateException(innerExceptions: IEnumerable[Exception]) - AggregateException(*innerExceptions: Array[Exception]) - AggregateException(message: str, innerExceptions: IEnumerable[Exception]) - AggregateException(message: str, *innerExceptions: Array[Exception]) - """ - def Flatten(self): - # type: (self: AggregateException) -> AggregateException - """ - Flatten(self: AggregateException) -> AggregateException - - Flattens an System.AggregateException instances into a single, new instance. - Returns: A new, flattened System.AggregateException. - """ - pass - - def GetBaseException(self): - # type: (self: AggregateException) -> Exception - """ - GetBaseException(self: AggregateException) -> Exception - - Returns the System.AggregateException that is the root cause of this exception. - Returns: Returns the System.AggregateException that is the root cause of this exception. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: AggregateException, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: AggregateException, info: SerializationInfo, context: StreamingContext) - Initializes a new instance of the System.AggregateException class with serialized data. - - info: The object that holds the serialized object data. - context: The contextual information about the source or destination. - """ - pass - - def Handle(self, predicate): - # type: (self: AggregateException, predicate: Func[Exception, bool]) - """ Handle(self: AggregateException, predicate: Func[Exception, bool]) """ - pass - - def ToString(self): - # type: (self: AggregateException) -> str - """ - ToString(self: AggregateException) -> str - - Creates and returns a string representation of the current System.AggregateException. - Returns: A string representation of the current exception. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, innerExceptions: IEnumerable[Exception]) - __new__(cls: type, *innerExceptions: Array[Exception]) - __new__(cls: type, message: str, innerExceptions: IEnumerable[Exception]) - __new__(cls: type, message: str, *innerExceptions: Array[Exception]) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - InnerExceptions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a read-only collection of the System.Exception instances that caused the current exception. - - Get: InnerExceptions(self: AggregateException) -> ReadOnlyCollection[Exception] - """ - - - SerializeObjectState = None - - -class AppContext(object): - # no doc - @staticmethod - def GetData(name): - # type: (name: str) -> object - """ GetData(name: str) -> object """ - pass - - @staticmethod - def SetSwitch(switchName, isEnabled): - # type: (switchName: str, isEnabled: bool) - """ SetSwitch(switchName: str, isEnabled: bool) """ - pass - - @staticmethod - def TryGetSwitch(switchName, isEnabled): - # type: (switchName: str) -> (bool, bool) - """ TryGetSwitch(switchName: str) -> (bool, bool) """ - pass - - BaseDirectory = 'C:\\Program Files\\IronPython 2.7\\' - TargetFrameworkName = '.NETFramework,Version=v4.5' - __all__ = [ - 'GetData', - 'SetSwitch', - 'TryGetSwitch', - ] - - -class MarshalByRefObject(object): - """ Enables access to objects across application domain boundaries in applications that support remoting. """ - def CreateObjRef(self, requestedType): - # type: (self: MarshalByRefObject, requestedType: Type) -> ObjRef - """ - CreateObjRef(self: MarshalByRefObject, requestedType: Type) -> ObjRef - - Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. - - requestedType: The System.Type of the object that the new System.Runtime.Remoting.ObjRef will reference. - Returns: Information required to generate a proxy. - """ - pass - - def GetLifetimeService(self): - # type: (self: MarshalByRefObject) -> object - """ - GetLifetimeService(self: MarshalByRefObject) -> object - - Retrieves the current lifetime service object that controls the lifetime policy for this instance. - Returns: An object of type System.Runtime.Remoting.Lifetime.ILease used to control the lifetime policy for this instance. - """ - pass - - def InitializeLifetimeService(self): - # type: (self: MarshalByRefObject) -> object - """ - InitializeLifetimeService(self: MarshalByRefObject) -> object - - Obtains a lifetime service object to control the lifetime policy for this instance. - Returns: An object of type System.Runtime.Remoting.Lifetime.ILease used to control the lifetime policy for this instance. This is the current lifetime service object for this instance if one exists; otherwise, a new lifetime service object initialized to the - value of the System.Runtime.Remoting.Lifetime.LifetimeServices.LeaseManagerPollTime property. - """ - pass - - -class _AppDomain: - """ Exposes the public members of the System.AppDomain class to unmanaged code. """ - def AppendPrivatePath(self, path): - # type: (self: _AppDomain, path: str) - """ - AppendPrivatePath(self: _AppDomain, path: str) - Provides COM objects with version-independent access to the System.AppDomain.AppendPrivatePath(System.String) method. - - path: The name of the directory to be appended to the private path. - """ - pass - - def ClearPrivatePath(self): - # type: (self: _AppDomain) - """ - ClearPrivatePath(self: _AppDomain) - Provides COM objects with version-independent access to the System.AppDomain.ClearPrivatePath method. - """ - pass - - def ClearShadowCopyPath(self): - # type: (self: _AppDomain) - """ - ClearShadowCopyPath(self: _AppDomain) - Provides COM objects with version-independent access to the System.AppDomain.ClearShadowCopyPath method. - """ - pass - - def CreateInstance(self, assemblyName, typeName, *__args): - # type: (self: _AppDomain, assemblyName: str, typeName: str) -> ObjectHandle - """ - CreateInstance(self: _AppDomain, assemblyName: str, typeName: str) -> ObjectHandle - - Provides COM objects with version-independent access to the System.AppDomain.CreateInstance(System.String,System.String) method. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - Returns: An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object. - CreateInstance(self: _AppDomain, assemblyName: str, typeName: str, activationAttributes: Array[object]) -> ObjectHandle - - Provides COM objects with version-independent access to the System.AppDomain.CreateInstance(System.String,System.String,System.Object[]) method overload. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - Returns: An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object. - CreateInstance(self: _AppDomain, assemblyName: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object], securityAttributes: Evidence) -> ObjectHandle - - Provides COM objects with version-independent access to the - System.AppDomain.CreateInstance(System.String,System.String,System.Boolean,System.Reflection.BindingFlags,System.Reflection.Binder,System.Object[],System.Globalization.CultureInfo,System.Object[],System.Security.Policy.Evidence) method overload. - - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - ignoreCase: A Boolean value specifying whether to perform a case-sensitive search or not. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects using reflection. If binder is null, the default binder is used. - args: The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the default constructor is preferred, args must be an empty array or null. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - securityAttributes: Information used to authorize creation of typeName. - Returns: An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object. - """ - pass - - def CreateInstanceFrom(self, assemblyFile, typeName, *__args): - # type: (self: _AppDomain, assemblyFile: str, typeName: str) -> ObjectHandle - """ - CreateInstanceFrom(self: _AppDomain, assemblyFile: str, typeName: str) -> ObjectHandle - - Provides COM objects with version-independent access to the System.AppDomain.CreateInstanceFrom(System.String,System.String) method overload. - - assemblyFile: The name, including the path, of a file that contains an assembly that defines the requested type. The assembly is loaded using the System.Reflection.Assembly.LoadFrom(System.String) method. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - Returns: An object that is a wrapper for the new instance, or null if typeName is not found. The return value needs to be unwrapped to access the real object. - CreateInstanceFrom(self: _AppDomain, assemblyFile: str, typeName: str, activationAttributes: Array[object]) -> ObjectHandle - - Provides COM objects with version-independent access to the System.AppDomain.CreateInstanceFrom(System.String,System.String,System.Object[]) method overload. - - assemblyFile: The name, including the path, of a file that contains an assembly that defines the requested type. The assembly is loaded using the System.Reflection.Assembly.LoadFrom(System.String) method. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - Returns: An object that is a wrapper for the new instance, or null if typeName is not found. The return value needs to be unwrapped to access the real object. - CreateInstanceFrom(self: _AppDomain, assemblyFile: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object], securityAttributes: Evidence) -> ObjectHandle - - Provides COM objects with version-independent access to the - System.AppDomain.CreateInstanceFrom(System.String,System.String,System.Boolean,System.Reflection.BindingFlags,System.Reflection.Binder,System.Object[],System.Globalization.CultureInfo,System.Object[],System.Security.Policy.Evidence) method overload. - - - assemblyFile: The name, including the path, of a file that contains an assembly that defines the requested type. The assembly is loaded using the System.Reflection.Assembly.LoadFrom(System.String) method. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - ignoreCase: A Boolean value specifying whether to perform a case-sensitive search or not. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects through reflection. If binder is null, the default binder is used. - args: The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the default constructor is preferred, args must be an empty array or null. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - securityAttributes: Information used to authorize creation of typeName. - Returns: An object that is a wrapper for the new instance, or null if typeName is not found. The return value needs to be unwrapped to access the real object. - """ - pass - - def DefineDynamicAssembly(self, name, access, *__args): - # type: (self: _AppDomain, name: AssemblyName, access: AssemblyBuilderAccess) -> AssemblyBuilder - """ - DefineDynamicAssembly(self: _AppDomain, name: AssemblyName, access: AssemblyBuilderAccess) -> AssemblyBuilder - - Provides COM objects with version-independent access to the System.AppDomain.DefineDynamicAssembly(System.Reflection.AssemblyName,System.Reflection.Emit.AssemblyBuilderAccess) method overload. - - name: The unique identity of the dynamic assembly. - access: The access mode for the dynamic assembly. - Returns: Represents the dynamic assembly created. - DefineDynamicAssembly(self: _AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str) -> AssemblyBuilder - - Provides COM objects with version-independent access to the System.AppDomain.DefineDynamicAssembly(System.Reflection.AssemblyName,System.Reflection.Emit.AssemblyBuilderAccess,System.String) method overload. - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - dir: The name of the directory where the assembly will be saved. If dir is null, the directory defaults to the current directory. - Returns: Represents the dynamic assembly created. - DefineDynamicAssembly(self: _AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, evidence: Evidence) -> AssemblyBuilder - - Provides COM objects with version-independent access to the System.AppDomain.DefineDynamicAssembly(System.Reflection.AssemblyName,System.Reflection.Emit.AssemblyBuilderAccess,System.Security.Policy.Evidence) method overload. - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - evidence: The evidence supplied for the dynamic assembly. The evidence is used unaltered as the final set of evidence used for policy resolution. - Returns: Represents the dynamic assembly created. - DefineDynamicAssembly(self: _AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, requiredPermissions: PermissionSet, optionalPermissions: PermissionSet, refusedPermissions: PermissionSet) -> AssemblyBuilder - - Provides COM objects with version-independent access to the - System.AppDomain.DefineDynamicAssembly(System.Reflection.AssemblyName,System.Reflection.Emit.AssemblyBuilderAccess,System.Security.PermissionSet,System.Security.PermissionSet,System.Security.PermissionSet) method overload. - - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - requiredPermissions: The required permissions request. - optionalPermissions: The optional permissions request. - refusedPermissions: The refused permissions request. - Returns: Represents the dynamic assembly created. - DefineDynamicAssembly(self: _AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str, evidence: Evidence) -> AssemblyBuilder - - Provides COM objects with version-independent access to the System.AppDomain.DefineDynamicAssembly(System.Reflection.AssemblyName,System.Reflection.Emit.AssemblyBuilderAccess,System.String,System.Security.Policy.Evidence) method overload. - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - dir: The name of the directory where the assembly will be saved. If dir is null, the directory defaults to the current directory. - evidence: The evidence supplied for the dynamic assembly. The evidence is used unaltered as the final set of evidence used for policy resolution. - Returns: Represents the dynamic assembly created. - DefineDynamicAssembly(self: _AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str, requiredPermissions: PermissionSet, optionalPermissions: PermissionSet, refusedPermissions: PermissionSet) -> AssemblyBuilder - - Provides COM objects with version-independent access to the - System.AppDomain.DefineDynamicAssembly(System.Reflection.AssemblyName,System.Reflection.Emit.AssemblyBuilderAccess,System.String,System.Security.PermissionSet,System.Security.PermissionSet,System.Security.PermissionSet) method overload. - - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - dir: The name of the directory where the assembly will be saved. If dir is null, the directory defaults to the current directory. - requiredPermissions: The required permissions request. - optionalPermissions: The optional permissions request. - refusedPermissions: The refused permissions request. - Returns: Represents the dynamic assembly created. - DefineDynamicAssembly(self: _AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, evidence: Evidence, requiredPermissions: PermissionSet, optionalPermissions: PermissionSet, refusedPermissions: PermissionSet) -> AssemblyBuilder - - Provides COM objects with version-independent access to the - System.AppDomain.DefineDynamicAssembly(System.Reflection.AssemblyName,System.Reflection.Emit.AssemblyBuilderAccess,System.Security.Policy.Evidence,System.Security.PermissionSet,System.Security.PermissionSet,System.Security.PermissionSet) method - overload. - - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - evidence: The evidence supplied for the dynamic assembly. The evidence is used unaltered as the final set of evidence used for policy resolution. - requiredPermissions: The required permissions request. - optionalPermissions: The optional permissions request. - refusedPermissions: The refused permissions request. - Returns: Represents the dynamic assembly created. - DefineDynamicAssembly(self: _AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str, evidence: Evidence, requiredPermissions: PermissionSet, optionalPermissions: PermissionSet, refusedPermissions: PermissionSet) -> AssemblyBuilder - - Provides COM objects with version-independent access to the - System.AppDomain.DefineDynamicAssembly(System.Reflection.AssemblyName,System.Reflection.Emit.AssemblyBuilderAccess,System.String,System.Security.Policy.Evidence,System.Security.PermissionSet,System.Security.PermissionSet,System.Security.PermissionSet) - method overload. - - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - dir: The name of the directory where the assembly will be saved. If dir is null, the directory defaults to the current directory. - evidence: The evidence supplied for the dynamic assembly. The evidence is used unaltered as the final set of evidence used for policy resolution. - requiredPermissions: The required permissions request. - optionalPermissions: The optional permissions request. - refusedPermissions: The refused permissions request. - Returns: Represents the dynamic assembly created. - DefineDynamicAssembly(self: _AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str, evidence: Evidence, requiredPermissions: PermissionSet, optionalPermissions: PermissionSet, refusedPermissions: PermissionSet, isSynchronized: bool) -> AssemblyBuilder - - Provides COM objects with version-independent access to the - System.AppDomain.DefineDynamicAssembly(System.Reflection.AssemblyName,System.Reflection.Emit.AssemblyBuilderAccess,System.String,System.Security.Policy.Evidence,System.Security.PermissionSet,System.Security.PermissionSet,System.Security.PermissionSet,S - ystem.Boolean) method overload. - - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - dir: The name of the directory where the dynamic assembly will be saved. If dir is null, the directory defaults to the current directory. - evidence: The evidence supplied for the dynamic assembly. The evidence is used unaltered as the final set of evidence used for policy resolution. - requiredPermissions: The required permissions request. - optionalPermissions: The optional permissions request. - refusedPermissions: The refused permissions request. - isSynchronized: true to synchronize the creation of modules, types, and members in the dynamic assembly; otherwise, false. - Returns: Represents the dynamic assembly created. - """ - pass - - def DoCallBack(self, theDelegate): - # type: (self: _AppDomain, theDelegate: CrossAppDomainDelegate) - """ - DoCallBack(self: _AppDomain, theDelegate: CrossAppDomainDelegate) - Provides COM objects with version-independent access to the System.AppDomain.DoCallBack(System.CrossAppDomainDelegate) method. - - theDelegate: A delegate that specifies a method to call. - """ - pass - - def Equals(self, other): - # type: (self: _AppDomain, other: object) -> bool - """ - Equals(self: _AppDomain, other: object) -> bool - - Provides COM objects with version-independent access to the inherited System.Object.Equals(System.Object) method. - - other: The System.Object to compare to the current System.Object. - Returns: true if the specified System.Object is equal to the current System.Object; otherwise, false. - """ - pass - - def ExecuteAssembly(self, assemblyFile, assemblySecurity=None, args=None): - # type: (self: _AppDomain, assemblyFile: str, assemblySecurity: Evidence) -> int - """ - ExecuteAssembly(self: _AppDomain, assemblyFile: str, assemblySecurity: Evidence) -> int - - Provides COM objects with version-independent access to the System.AppDomain.ExecuteAssembly(System.String,System.Security.Policy.Evidence) method overload. - - assemblyFile: The name of the file that contains the assembly to execute. - assemblySecurity: Evidence for loading the assembly. - Returns: The value returned by the entry point of the assembly. - ExecuteAssembly(self: _AppDomain, assemblyFile: str) -> int - - Provides COM objects with version-independent access to the System.AppDomain.ExecuteAssembly(System.String) method overload. - - assemblyFile: The name of the file that contains the assembly to execute. - Returns: The value returned by the entry point of the assembly. - ExecuteAssembly(self: _AppDomain, assemblyFile: str, assemblySecurity: Evidence, args: Array[str]) -> int - - Provides COM objects with version-independent access to the System.AppDomain.ExecuteAssembly(System.String,System.Security.Policy.Evidence,System.String[]) method overload. - - assemblyFile: The name of the file that contains the assembly to execute. - assemblySecurity: The supplied evidence for the assembly. - args: The arguments to the entry point of the assembly. - Returns: The value returned by the entry point of the assembly. - """ - pass - - def GetAssemblies(self): - # type: (self: _AppDomain) -> Array[Assembly] - """ - GetAssemblies(self: _AppDomain) -> Array[Assembly] - - Provides COM objects with version-independent access to the System.AppDomain.GetAssemblies method. - Returns: An array of assemblies in this application domain. - """ - pass - - def GetData(self, name): - # type: (self: _AppDomain, name: str) -> object - """ - GetData(self: _AppDomain, name: str) -> object - - Provides COM objects with version-independent access to the System.AppDomain.GetData(System.String) method. - - name: The name of a predefined application domain property, or the name of an application domain property you have defined. - Returns: The value of the name property. - """ - pass - - def GetHashCode(self): - # type: (self: _AppDomain) -> int - """ - GetHashCode(self: _AppDomain) -> int - - Provides COM objects with version-independent access to the inherited System.Object.GetHashCode method. - Returns: A hash code for the current System.Object. - """ - pass - - def GetIDsOfNames(self, riid, rgszNames, cNames, lcid, rgDispId): - # type: (self: _AppDomain, riid: Guid, rgszNames: IntPtr, cNames: UInt32, lcid: UInt32, rgDispId: IntPtr) -> Guid - """ - GetIDsOfNames(self: _AppDomain, riid: Guid, rgszNames: IntPtr, cNames: UInt32, lcid: UInt32, rgDispId: IntPtr) -> Guid - - Maps a set of names to a corresponding set of dispatch identifiers. - - riid: Reserved for future use. Must be IID_NULL. - rgszNames: Passed-in array of names to be mapped. - cNames: Count of the names to be mapped. - lcid: The locale context in which to interpret the names. - rgDispId: Caller-allocated array which receives the IDs corresponding to the names. - """ - pass - - def GetLifetimeService(self): - # type: (self: _AppDomain) -> object - """ - GetLifetimeService(self: _AppDomain) -> object - - Provides COM objects with version-independent access to the inherited System.MarshalByRefObject.GetLifetimeService method. - Returns: An object of type System.Runtime.Remoting.Lifetime.ILease used to control the lifetime policy for this instance. - """ - pass - - def GetType(self): - # type: (self: _AppDomain) -> Type - """ - GetType(self: _AppDomain) -> Type - - Provides COM objects with version-independent access to the System.AppDomain.GetType method. - Returns: A System.Type representing the type of the current instance. - """ - pass - - def GetTypeInfo(self, iTInfo, lcid, ppTInfo): - # type: (self: _AppDomain, iTInfo: UInt32, lcid: UInt32, ppTInfo: IntPtr) - """ - GetTypeInfo(self: _AppDomain, iTInfo: UInt32, lcid: UInt32, ppTInfo: IntPtr) - Retrieves the type information for an object, which can then be used to get the type information for an interface. - - iTInfo: The type information to return. - lcid: The locale identifier for the type information. - ppTInfo: Receives a pointer to the requested type information object. - """ - pass - - def GetTypeInfoCount(self, pcTInfo): - # type: (self: _AppDomain) -> UInt32 - """ - GetTypeInfoCount(self: _AppDomain) -> UInt32 - - Retrieves the number of type information interfaces that an object provides (either 0 or 1). - """ - pass - - def InitializeLifetimeService(self): - # type: (self: _AppDomain) -> object - """ - InitializeLifetimeService(self: _AppDomain) -> object - - Provides COM objects with version-independent access to the System.AppDomain.InitializeLifetimeService method. - Returns: Always null. - """ - pass - - def Invoke(self, dispIdMember, riid, lcid, wFlags, pDispParams, pVarResult, pExcepInfo, puArgErr): - # type: (self: _AppDomain, dispIdMember: UInt32, riid: Guid, lcid: UInt32, wFlags: Int16, pDispParams: IntPtr, pVarResult: IntPtr, pExcepInfo: IntPtr, puArgErr: IntPtr) -> Guid - """ - Invoke(self: _AppDomain, dispIdMember: UInt32, riid: Guid, lcid: UInt32, wFlags: Int16, pDispParams: IntPtr, pVarResult: IntPtr, pExcepInfo: IntPtr, puArgErr: IntPtr) -> Guid - - Provides access to properties and methods exposed by an object. - - dispIdMember: Identifies the member. - riid: Reserved for future use. Must be IID_NULL. - lcid: The locale context in which to interpret arguments. - wFlags: Flags describing the context of the call. - pDispParams: Pointer to a structure containing an array of arguments, an array of argument DISPIDs for named arguments, and counts for the number of elements in the arrays. - pVarResult: Pointer to the location where the result is to be stored. - pExcepInfo: Pointer to a structure that contains exception information. - puArgErr: The index of the first argument that has an error. - """ - pass - - def Load(self, *__args): - # type: (self: _AppDomain, assemblyRef: AssemblyName) -> Assembly - """ - Load(self: _AppDomain, assemblyRef: AssemblyName) -> Assembly - - Provides COM objects with version-independent access to the System.AppDomain.Load(System.Reflection.AssemblyName) method overload. - - assemblyRef: An object that describes the assembly to load. - Returns: The loaded assembly. - Load(self: _AppDomain, assemblyString: str) -> Assembly - - Provides COM objects with version-independent access to the System.AppDomain.Load(System.String) method overload. - - assemblyString: The display name of the assembly. See System.Reflection.Assembly.FullName. - Returns: The loaded assembly. - Load(self: _AppDomain, rawAssembly: Array[Byte]) -> Assembly - - Provides COM objects with version-independent access to the System.AppDomain.Load(System.Byte[]) method overload. - - rawAssembly: An array of type byte that is a COFF-based image containing an emitted assembly. - Returns: The loaded assembly. - Load(self: _AppDomain, rawAssembly: Array[Byte], rawSymbolStore: Array[Byte]) -> Assembly - - Provides COM objects with version-independent access to the System.AppDomain.Load(System.Byte[],System.Byte[]) method overload. - - rawAssembly: An array of type byte that is a COFF-based image containing an emitted assembly. - rawSymbolStore: An array of type byte containing the raw bytes representing the symbols for the assembly. - Returns: The loaded assembly. - Load(self: _AppDomain, rawAssembly: Array[Byte], rawSymbolStore: Array[Byte], securityEvidence: Evidence) -> Assembly - - Provides COM objects with version-independent access to the System.AppDomain.Load(System.Byte[],System.Byte[],System.Security.Policy.Evidence) method overload. - - rawAssembly: An array of type byte that is a COFF-based image containing an emitted assembly. - rawSymbolStore: An array of type byte containing the raw bytes representing the symbols for the assembly. - securityEvidence: Evidence for loading the assembly. - Returns: The loaded assembly. - Load(self: _AppDomain, assemblyRef: AssemblyName, assemblySecurity: Evidence) -> Assembly - - Provides COM objects with version-independent access to the System.AppDomain.Load(System.Reflection.AssemblyName,System.Security.Policy.Evidence) method overload. - - assemblyRef: An object that describes the assembly to load. - assemblySecurity: Evidence for loading the assembly. - Returns: The loaded assembly. - Load(self: _AppDomain, assemblyString: str, assemblySecurity: Evidence) -> Assembly - - Provides COM objects with version-independent access to the System.AppDomain.Load(System.String,System.Security.Policy.Evidence) method overload. - - assemblyString: The display name of the assembly. See System.Reflection.Assembly.FullName. - assemblySecurity: Evidence for loading the assembly. - Returns: The loaded assembly. - """ - pass - - def SetAppDomainPolicy(self, domainPolicy): - # type: (self: _AppDomain, domainPolicy: PolicyLevel) - """ - SetAppDomainPolicy(self: _AppDomain, domainPolicy: PolicyLevel) - Provides COM objects with version-independent access to the System.AppDomain.SetAppDomainPolicy(System.Security.Policy.PolicyLevel) method. - - domainPolicy: The security policy level. - """ - pass - - def SetCachePath(self, s): - # type: (self: _AppDomain, s: str) - """ - SetCachePath(self: _AppDomain, s: str) - Provides COM objects with version-independent access to the System.AppDomain.SetCachePath(System.String) method. - - s: The fully qualified path to the shadow copy location. - """ - pass - - def SetData(self, name, data): - # type: (self: _AppDomain, name: str, data: object) - """ - SetData(self: _AppDomain, name: str, data: object) - Provides COM objects with version-independent access to the System.AppDomain.SetData(System.String,System.Object) method. - - name: The name of a user-defined application domain property to create or change. - data: The value of the property. - """ - pass - - def SetPrincipalPolicy(self, policy): - # type: (self: _AppDomain, policy: PrincipalPolicy) - """ - SetPrincipalPolicy(self: _AppDomain, policy: PrincipalPolicy) - Provides COM objects with version-independent access to the System.AppDomain.SetPrincipalPolicy(System.Security.Principal.PrincipalPolicy) method. - - policy: One of the System.Security.Principal.PrincipalPolicy values that specifies the type of the principal object to attach to threads. - """ - pass - - def SetShadowCopyPath(self, s): - # type: (self: _AppDomain, s: str) - """ - SetShadowCopyPath(self: _AppDomain, s: str) - Provides COM objects with version-independent access to the System.AppDomain.SetShadowCopyPath(System.String) method. - - s: A list of directory names, where each name is separated by a semicolon. - """ - pass - - def SetThreadPrincipal(self, principal): - # type: (self: _AppDomain, principal: IPrincipal) - """ - SetThreadPrincipal(self: _AppDomain, principal: IPrincipal) - Provides COM objects with version-independent access to the System.AppDomain.SetThreadPrincipal(System.Security.Principal.IPrincipal) method. - - principal: The principal object to attach to threads. - """ - pass - - def ToString(self): - # type: (self: _AppDomain) -> str - """ - ToString(self: _AppDomain) -> str - - Provides COM objects with version-independent access to the System.AppDomain.ToString method. - Returns: A string formed by concatenating the literal string "Name:", the friendly name of the application domain, and either string representations of the context policies or the string "There are no context policies." - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - BaseDirectory = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Provides COM objects with version-independent access to the System.AppDomain.BaseDirectory property. - - Get: BaseDirectory(self: _AppDomain) -> str - """ - - DynamicDirectory = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Provides COM objects with version-independent access to the System.AppDomain.DynamicDirectory property. - - Get: DynamicDirectory(self: _AppDomain) -> str - """ - - Evidence = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Provides COM objects with version-independent access to the System.AppDomain.Evidence property. - - Get: Evidence(self: _AppDomain) -> Evidence - """ - - FriendlyName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Provides COM objects with version-independent access to the System.AppDomain.FriendlyName property. - - Get: FriendlyName(self: _AppDomain) -> str - """ - - RelativeSearchPath = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Provides COM objects with version-independent access to the System.AppDomain.RelativeSearchPath property. - - Get: RelativeSearchPath(self: _AppDomain) -> str - """ - - ShadowCopyFiles = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Provides COM objects with version-independent access to the System.AppDomain.ShadowCopyFiles property. - - Get: ShadowCopyFiles(self: _AppDomain) -> bool - """ - - - AssemblyLoad = None - AssemblyResolve = None - DomainUnload = None - ProcessExit = None - ResourceResolve = None - TypeResolve = None - UnhandledException = None - - -class AppDomain(MarshalByRefObject, _AppDomain, IEvidenceFactory): - """ Represents an application domain, which is an isolated environment where applications execute. This class cannot be inherited. """ - def AppendPrivatePath(self, path): - # type: (self: AppDomain, path: str) - """ - AppendPrivatePath(self: AppDomain, path: str) - Appends the specified directory name to the private path list. - - path: The name of the directory to be appended to the private path. - """ - pass - - def ApplyPolicy(self, assemblyName): - # type: (self: AppDomain, assemblyName: str) -> str - """ - ApplyPolicy(self: AppDomain, assemblyName: str) -> str - - Returns the assembly display name after policy has been applied. - - assemblyName: The assembly display name, in the form provided by the System.Reflection.Assembly.FullName property. - Returns: A string containing the assembly display name after policy has been applied. - """ - pass - - def ClearPrivatePath(self): - # type: (self: AppDomain) - """ - ClearPrivatePath(self: AppDomain) - Resets the path that specifies the location of private assemblies to the empty string (""). - """ - pass - - def ClearShadowCopyPath(self): - # type: (self: AppDomain) - """ - ClearShadowCopyPath(self: AppDomain) - Resets the list of directories containing shadow copied assemblies to the empty string (""). - """ - pass - - def CreateComInstanceFrom(self, *__args): - # type: (self: AppDomain, assemblyName: str, typeName: str) -> ObjectHandle - """ - CreateComInstanceFrom(self: AppDomain, assemblyName: str, typeName: str) -> ObjectHandle - - Creates a new instance of a specified COM type. Parameters specify the name of a file that contains an assembly containing the type and the name of the type. - - assemblyName: The name of a file containing an assembly that defines the requested type. - typeName: The name of the requested type. - Returns: An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object. - CreateComInstanceFrom(self: AppDomain, assemblyFile: str, typeName: str, hashValue: Array[Byte], hashAlgorithm: AssemblyHashAlgorithm) -> ObjectHandle - - Creates a new instance of a specified COM type. Parameters specify the name of a file that contains an assembly containing the type and the name of the type. - - assemblyFile: The name of a file containing an assembly that defines the requested type. - typeName: The name of the requested type. - hashValue: Represents the value of the computed hash code. - hashAlgorithm: Represents the hash algorithm used by the assembly manifest. - Returns: An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object. - """ - pass - - @staticmethod - def CreateDomain(friendlyName, securityInfo=None, *__args): - # type: (friendlyName: str, securityInfo: Evidence) -> AppDomain - """ - CreateDomain(friendlyName: str, securityInfo: Evidence) -> AppDomain - - Creates a new application domain with the given name using the supplied evidence. - - friendlyName: The friendly name of the domain. This friendly name can be displayed in user interfaces to identify the domain. For more information, see System.AppDomain.FriendlyName. - securityInfo: Evidence that establishes the identity of the code that runs in the application domain. Pass null to use the evidence of the current application domain. - Returns: The newly created application domain. - CreateDomain(friendlyName: str, securityInfo: Evidence, appBasePath: str, appRelativeSearchPath: str, shadowCopyFiles: bool) -> AppDomain - - Creates a new application domain with the given name, using evidence, application base path, relative search path, and a parameter that specifies whether a shadow copy of an assembly is to be loaded into the application domain. - - friendlyName: The friendly name of the domain. This friendly name can be displayed in user interfaces to identify the domain. For more information, see System.AppDomain.FriendlyName. - securityInfo: Evidence that establishes the identity of the code that runs in the application domain. Pass null to use the evidence of the current application domain. - appBasePath: The base directory that the assembly resolver uses to probe for assemblies. For more information, see System.AppDomain.BaseDirectory. - appRelativeSearchPath: The path relative to the base directory where the assembly resolver should probe for private assemblies. For more information, see System.AppDomain.RelativeSearchPath. - shadowCopyFiles: If true, a shadow copy of an assembly is loaded into this application domain. - Returns: The newly created application domain. - CreateDomain(friendlyName: str) -> AppDomain - - Creates a new application domain with the specified name. - - friendlyName: The friendly name of the domain. - Returns: The newly created application domain. - CreateDomain(friendlyName: str, securityInfo: Evidence, info: AppDomainSetup) -> AppDomain - - Creates a new application domain using the specified name, evidence, and application domain setup information. - - friendlyName: The friendly name of the domain. This friendly name can be displayed in user interfaces to identify the domain. For more information, see System.AppDomain.FriendlyName. - securityInfo: Evidence that establishes the identity of the code that runs in the application domain. Pass null to use the evidence of the current application domain. - info: An object that contains application domain initialization information. - Returns: The newly created application domain. - CreateDomain(friendlyName: str, securityInfo: Evidence, info: AppDomainSetup, grantSet: PermissionSet, *fullTrustAssemblies: Array[StrongName]) -> AppDomain - - Creates a new application domain using the specified name, evidence, application domain setup information, default permission set, and array of fully trusted assemblies. - - friendlyName: The friendly name of the domain. This friendly name can be displayed in user interfaces to identify the domain. For more information, see the description of System.AppDomain.FriendlyName. - securityInfo: Evidence that establishes the identity of the code that runs in the application domain. Pass null to use the evidence of the current application domain. - info: An object that contains application domain initialization information. - grantSet: A default permission set that is granted to all assemblies loaded into the new application domain that do not have specific grants. - fullTrustAssemblies: An array of strong names representing assemblies to be considered fully trusted in the new application domain. - Returns: The newly created application domain. - CreateDomain(friendlyName: str, securityInfo: Evidence, appBasePath: str, appRelativeSearchPath: str, shadowCopyFiles: bool, adInit: AppDomainInitializer, adInitArgs: Array[str]) -> AppDomain - - Creates a new application domain with the given name, using evidence, application base path, relative search path, and a parameter that specifies whether a shadow copy of an assembly is to be loaded into the application domain. Specifies a callback - method that is invoked when the application domain is initialized, and an array of string arguments to pass the callback method. - - - friendlyName: The friendly name of the domain. This friendly name can be displayed in user interfaces to identify the domain. For more information, see System.AppDomain.FriendlyName. - securityInfo: Evidence that establishes the identity of the code that runs in the application domain. Pass null to use the evidence of the current application domain. - appBasePath: The base directory that the assembly resolver uses to probe for assemblies. For more information, see System.AppDomain.BaseDirectory. - appRelativeSearchPath: The path relative to the base directory where the assembly resolver should probe for private assemblies. For more information, see System.AppDomain.RelativeSearchPath. - shadowCopyFiles: true to load a shadow copy of an assembly into the application domain. - adInit: An System.AppDomainInitializer delegate that represents a callback method to invoke when the new System.AppDomain object is initialized. - adInitArgs: An array of string arguments to be passed to the callback represented by adInit, when the new System.AppDomain object is initialized. - Returns: The newly created application domain. - """ - pass - - def CreateInstance(self, assemblyName, typeName, *__args): - # type: (self: AppDomain, assemblyName: str, typeName: str) -> ObjectHandle - """ - CreateInstance(self: AppDomain, assemblyName: str, typeName: str) -> ObjectHandle - - Creates a new instance of the specified type defined in the specified assembly. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - Returns: An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object. - CreateInstance(self: AppDomain, assemblyName: str, typeName: str, activationAttributes: Array[object]) -> ObjectHandle - - Creates a new instance of the specified type defined in the specified assembly. A parameter specifies an array of activation attributes. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - Returns: An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object. - CreateInstance(self: AppDomain, assemblyName: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object], securityAttributes: Evidence) -> ObjectHandle - - Creates a new instance of the specified type defined in the specified assembly. Parameters specify a binder, binding flags, constructor arguments, culture-specific information used to interpret arguments, activation attributes, and authorization to - create the type. - - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - ignoreCase: A Boolean value specifying whether to perform a case-sensitive search or not. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects using reflection. If binder is null, the default binder is used. - args: The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the default constructor is preferred, args must be an empty array or null. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - securityAttributes: Information used to authorize creation of typeName. - Returns: An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object. - CreateInstance(self: AppDomain, assemblyName: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object]) -> ObjectHandle - - Creates a new instance of the specified type defined in the specified assembly. Parameters specify a binder, binding flags, constructor arguments, culture-specific information used to interpret arguments, and optional activation attributes. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - ignoreCase: A Boolean value specifying whether to perform a case-sensitive search or not. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects using reflection. If binder is null, the default binder is used. - args: The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the default constructor is preferred, args must be an empty array or null. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - Returns: An object that is a wrapper for the new instance specified by typeName. The return value needs to be unwrapped to access the real object. - """ - pass - - def CreateInstanceAndUnwrap(self, assemblyName, typeName, *__args): - # type: (self: AppDomain, assemblyName: str, typeName: str) -> object - """ - CreateInstanceAndUnwrap(self: AppDomain, assemblyName: str, typeName: str) -> object - - Creates a new instance of the specified type. Parameters specify the assembly where the type is defined, and the name of the type. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - Returns: An instance of the object specified by typeName. - CreateInstanceAndUnwrap(self: AppDomain, assemblyName: str, typeName: str, activationAttributes: Array[object]) -> object - - Creates a new instance of the specified type. Parameters specify the assembly where the type is defined, the name of the type, and an array of activation attributes. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - Returns: An instance of the object specified by typeName. - CreateInstanceAndUnwrap(self: AppDomain, assemblyName: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object], securityAttributes: Evidence) -> object - - Creates a new instance of the specified type. Parameters specify the name of the type, and how it is found and created. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - ignoreCase: A Boolean value specifying whether to perform a case-sensitive search or not. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects using reflection. If binder is null, the default binder is used. - args: The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the default constructor is preferred, args must be an empty array or null. - culture: A culture-specific object used to govern the coercion of types. If culture is null, the CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - securityAttributes: Information used to authorize creation of typeName. - Returns: An instance of the object specified by typeName. - CreateInstanceAndUnwrap(self: AppDomain, assemblyName: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object]) -> object - - Creates a new instance of the specified type defined in the specified assembly, specifying whether the case of the type name is ignored; the binding attributes and the binder that are used to select the type to be created; the arguments of the - constructor; the culture; and the activation attributes. - - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - ignoreCase: A Boolean value specifying whether to perform a case-sensitive search or not. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects using reflection. If binder is null, the default binder is used. - args: The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the default constructor is preferred, args must be an empty array or null. - culture: A culture-specific object used to govern the coercion of types. If culture is null, the CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - Returns: An instance of the object specified by typeName. - """ - pass - - def CreateInstanceFrom(self, assemblyFile, typeName, *__args): - # type: (self: AppDomain, assemblyFile: str, typeName: str) -> ObjectHandle - """ - CreateInstanceFrom(self: AppDomain, assemblyFile: str, typeName: str) -> ObjectHandle - - Creates a new instance of the specified type defined in the specified assembly file. - - assemblyFile: The name, including the path, of a file that contains an assembly that defines the requested type. The assembly is loaded using the System.Reflection.Assembly.LoadFrom(System.String) method. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - Returns: An object that is a wrapper for the new instance, or null if typeName is not found. The return value needs to be unwrapped to access the real object. - CreateInstanceFrom(self: AppDomain, assemblyFile: str, typeName: str, activationAttributes: Array[object]) -> ObjectHandle - - Creates a new instance of the specified type defined in the specified assembly file. - - assemblyFile: The name, including the path, of a file that contains an assembly that defines the requested type. The assembly is loaded using the System.Reflection.Assembly.LoadFrom(System.String) method. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - Returns: An object that is a wrapper for the new instance, or null if typeName is not found. The return value needs to be unwrapped to access the real object. - CreateInstanceFrom(self: AppDomain, assemblyFile: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object], securityAttributes: Evidence) -> ObjectHandle - - Creates a new instance of the specified type defined in the specified assembly file. - - assemblyFile: The name, including the path, of a file that contains an assembly that defines the requested type. The assembly is loaded using the System.Reflection.Assembly.LoadFrom(System.String) method. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - ignoreCase: A Boolean value specifying whether to perform a case-sensitive search or not. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects through reflection. If binder is null, the default binder is used. - args: The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the default constructor is preferred, args must be an empty array or null. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - securityAttributes: Information used to authorize creation of typeName. - Returns: An object that is a wrapper for the new instance, or null if typeName is not found. The return value needs to be unwrapped to access the real object. - CreateInstanceFrom(self: AppDomain, assemblyFile: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object]) -> ObjectHandle - - Creates a new instance of the specified type defined in the specified assembly file. - - assemblyFile: The name, including the path, of a file that contains an assembly that defines the requested type. The assembly is loaded using the System.Reflection.Assembly.LoadFrom(System.String) method. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - ignoreCase: A Boolean value specifying whether to perform a case-sensitive search or not. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects through reflection. If binder is null, the default binder is used. - args: The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the default constructor is preferred, args must be an empty array or null. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - Returns: An object that is a wrapper for the new instance, or null if typeName is not found. The return value needs to be unwrapped to access the real object. - """ - pass - - def CreateInstanceFromAndUnwrap(self, *__args): - # type: (self: AppDomain, assemblyName: str, typeName: str) -> object - """ - CreateInstanceFromAndUnwrap(self: AppDomain, assemblyName: str, typeName: str) -> object - - Creates a new instance of the specified type defined in the specified assembly file. - - assemblyName: The file name and path of the assembly that defines the requested type. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - Returns: The requested object, or null if typeName is not found. - CreateInstanceFromAndUnwrap(self: AppDomain, assemblyName: str, typeName: str, activationAttributes: Array[object]) -> object - - Creates a new instance of the specified type defined in the specified assembly file. - - assemblyName: The file name and path of the assembly that defines the requested type. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly (see the System.Type.FullName property). - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - Returns: The requested object, or null if typeName is not found. - CreateInstanceFromAndUnwrap(self: AppDomain, assemblyName: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object], securityAttributes: Evidence) -> object - - Creates a new instance of the specified type defined in the specified assembly file. - - assemblyName: The file name and path of the assembly that defines the requested type. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - ignoreCase: A Boolean value specifying whether to perform a case-sensitive search or not. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects through reflection. If binder is null, the default binder is used. - args: The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the default constructor is preferred, args must be an empty array or null. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - securityAttributes: Information used to authorize creation of typeName. - Returns: The requested object, or null if typeName is not found. - CreateInstanceFromAndUnwrap(self: AppDomain, assemblyFile: str, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[object], culture: CultureInfo, activationAttributes: Array[object]) -> object - - Creates a new instance of the specified type defined in the specified assembly file, specifying whether the case of the type name is ignored; the binding attributes and the binder that are used to select the type to be created; the arguments of the - constructor; the culture; and the activation attributes. - - - assemblyFile: The file name and path of the assembly that defines the requested type. - typeName: The fully qualified name of the requested type, including the namespace but not the assembly, as returned by the System.Type.FullName property. - ignoreCase: A Boolean value specifying whether to perform a case-sensitive search or not. - bindingAttr: A combination of zero or more bit flags that affect the search for the typeName constructor. If bindingAttr is zero, a case-sensitive search for public constructors is conducted. - binder: An object that enables the binding, coercion of argument types, invocation of members, and retrieval of System.Reflection.MemberInfo objects through reflection. If binder is null, the default binder is used. - args: The arguments to pass to the constructor. This array of arguments must match in number, order, and type the parameters of the constructor to invoke. If the default constructor is preferred, args must be an empty array or null. - culture: Culture-specific information that governs the coercion of args to the formal types declared for the typeName constructor. If culture is null, the System.Globalization.CultureInfo for the current thread is used. - activationAttributes: An array of one or more attributes that can participate in activation. Typically, an array that contains a single System.Runtime.Remoting.Activation.UrlAttribute object. The System.Runtime.Remoting.Activation.UrlAttribute specifies the URL that is - required to activate a remote object. - - Returns: The requested object, or null if typeName is not found. - """ - pass - - def DefineDynamicAssembly(self, name, access, *__args): - # type: (self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess) -> AssemblyBuilder - """ - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess) -> AssemblyBuilder - - Defines a dynamic assembly with the specified name and access mode. - - name: The unique identity of the dynamic assembly. - access: The access mode for the dynamic assembly. - Returns: A dynamic assembly with the specified name and access mode. - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, assemblyAttributes: IEnumerable[CustomAttributeBuilder]) -> AssemblyBuilder - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, assemblyAttributes: IEnumerable[CustomAttributeBuilder], securityContextSource: SecurityContextSource) -> AssemblyBuilder - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str) -> AssemblyBuilder - - Defines a dynamic assembly using the specified name, access mode, and storage directory. - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - dir: The name of the directory where the assembly will be saved. If dir is null, the directory defaults to the current directory. - Returns: A dynamic assembly with the specified name and features. - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, evidence: Evidence) -> AssemblyBuilder - - Defines a dynamic assembly using the specified name, access mode, and evidence. - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - evidence: The evidence supplied for the dynamic assembly. The evidence is used unaltered as the final set of evidence used for policy resolution. - Returns: A dynamic assembly with the specified name and features. - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, requiredPermissions: PermissionSet, optionalPermissions: PermissionSet, refusedPermissions: PermissionSet) -> AssemblyBuilder - - Defines a dynamic assembly using the specified name, access mode, and permission requests. - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - requiredPermissions: The required permissions request. - optionalPermissions: The optional permissions request. - refusedPermissions: The refused permissions request. - Returns: A dynamic assembly with the specified name and features. - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str, evidence: Evidence) -> AssemblyBuilder - - Defines a dynamic assembly using the specified name, access mode, storage directory, and evidence. - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - dir: The name of the directory where the assembly will be saved. If dir is null, the directory defaults to the current directory. - evidence: The evidence supplied for the dynamic assembly. The evidence is used unaltered as the final set of evidence used for policy resolution. - Returns: A dynamic assembly with the specified name and features. - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str, requiredPermissions: PermissionSet, optionalPermissions: PermissionSet, refusedPermissions: PermissionSet) -> AssemblyBuilder - - Defines a dynamic assembly using the specified name, access mode, storage directory, and permission requests. - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - dir: The name of the directory where the assembly will be saved. If dir is null, the directory defaults to the current directory. - requiredPermissions: The required permissions request. - optionalPermissions: The optional permissions request. - refusedPermissions: The refused permissions request. - Returns: A dynamic assembly with the specified name and features. - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, evidence: Evidence, requiredPermissions: PermissionSet, optionalPermissions: PermissionSet, refusedPermissions: PermissionSet) -> AssemblyBuilder - - Defines a dynamic assembly using the specified name, access mode, evidence, and permission requests. - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - evidence: The evidence supplied for the dynamic assembly. The evidence is used unaltered as the final set of evidence used for policy resolution. - requiredPermissions: The required permissions request. - optionalPermissions: The optional permissions request. - refusedPermissions: The refused permissions request. - Returns: A dynamic assembly with the specified name and features. - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str, evidence: Evidence, requiredPermissions: PermissionSet, optionalPermissions: PermissionSet, refusedPermissions: PermissionSet) -> AssemblyBuilder - - Defines a dynamic assembly using the specified name, access mode, storage directory, evidence, and permission requests. - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - dir: The name of the directory where the assembly will be saved. If dir is null, the directory defaults to the current directory. - evidence: The evidence supplied for the dynamic assembly. The evidence is used unaltered as the final set of evidence used for policy resolution. - requiredPermissions: The required permissions request. - optionalPermissions: The optional permissions request. - refusedPermissions: The refused permissions request. - Returns: A dynamic assembly with the specified name and features. - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str, evidence: Evidence, requiredPermissions: PermissionSet, optionalPermissions: PermissionSet, refusedPermissions: PermissionSet, isSynchronized: bool) -> AssemblyBuilder - - Defines a dynamic assembly using the specified name, access mode, storage directory, evidence, permission requests, and synchronization option. - - name: The unique identity of the dynamic assembly. - access: The mode in which the dynamic assembly will be accessed. - dir: The name of the directory where the dynamic assembly will be saved. If dir is null, the directory defaults to the current directory. - evidence: The evidence supplied for the dynamic assembly. The evidence is used unaltered as the final set of evidence used for policy resolution. - requiredPermissions: The required permissions request. - optionalPermissions: The optional permissions request. - refusedPermissions: The refused permissions request. - isSynchronized: true to synchronize the creation of modules, types, and members in the dynamic assembly; otherwise, false. - Returns: A dynamic assembly with the specified name and features. - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str, evidence: Evidence, requiredPermissions: PermissionSet, optionalPermissions: PermissionSet, refusedPermissions: PermissionSet, isSynchronized: bool, assemblyAttributes: IEnumerable[CustomAttributeBuilder]) -> AssemblyBuilder - DefineDynamicAssembly(self: AppDomain, name: AssemblyName, access: AssemblyBuilderAccess, dir: str, isSynchronized: bool, assemblyAttributes: IEnumerable[CustomAttributeBuilder]) -> AssemblyBuilder - """ - pass - - def DoCallBack(self, callBackDelegate): - # type: (self: AppDomain, callBackDelegate: CrossAppDomainDelegate) - """ - DoCallBack(self: AppDomain, callBackDelegate: CrossAppDomainDelegate) - Executes the code in another application domain that is identified by the specified delegate. - - callBackDelegate: A delegate that specifies a method to call. - """ - pass - - def ExecuteAssembly(self, assemblyFile, *__args): - # type: (self: AppDomain, assemblyFile: str) -> int - """ - ExecuteAssembly(self: AppDomain, assemblyFile: str) -> int - - Executes the assembly contained in the specified file. - - assemblyFile: The name of the file that contains the assembly to execute. - Returns: The value returned by the entry point of the assembly. - ExecuteAssembly(self: AppDomain, assemblyFile: str, assemblySecurity: Evidence) -> int - - Executes the assembly contained in the specified file, using the specified evidence. - - assemblyFile: The name of the file that contains the assembly to execute. - assemblySecurity: Evidence for loading the assembly. - Returns: The value returned by the entry point of the assembly. - ExecuteAssembly(self: AppDomain, assemblyFile: str, assemblySecurity: Evidence, args: Array[str]) -> int - - Executes the assembly contained in the specified file, using the specified evidence and arguments. - - assemblyFile: The name of the file that contains the assembly to execute. - assemblySecurity: The supplied evidence for the assembly. - args: The arguments to the entry point of the assembly. - Returns: The value returned by the entry point of the assembly. - ExecuteAssembly(self: AppDomain, assemblyFile: str, args: Array[str]) -> int - - Executes the assembly contained in the specified file, using the specified arguments. - - assemblyFile: The name of the file that contains the assembly to execute. - args: The arguments to the entry point of the assembly. - Returns: The value that is returned by the entry point of the assembly. - ExecuteAssembly(self: AppDomain, assemblyFile: str, assemblySecurity: Evidence, args: Array[str], hashValue: Array[Byte], hashAlgorithm: AssemblyHashAlgorithm) -> int - - Executes the assembly contained in the specified file, using the specified evidence, arguments, hash value, and hash algorithm. - - assemblyFile: The name of the file that contains the assembly to execute. - assemblySecurity: The supplied evidence for the assembly. - args: The arguments to the entry point of the assembly. - hashValue: Represents the value of the computed hash code. - hashAlgorithm: Represents the hash algorithm used by the assembly manifest. - Returns: The value returned by the entry point of the assembly. - ExecuteAssembly(self: AppDomain, assemblyFile: str, args: Array[str], hashValue: Array[Byte], hashAlgorithm: AssemblyHashAlgorithm) -> int - - Executes the assembly contained in the specified file, using the specified arguments, hash value, and hash algorithm. - - assemblyFile: The name of the file that contains the assembly to execute. - args: The arguments to the entry point of the assembly. - hashValue: Represents the value of the computed hash code. - hashAlgorithm: Represents the hash algorithm used by the assembly manifest. - Returns: The value that is returned by the entry point of the assembly. - """ - pass - - def ExecuteAssemblyByName(self, assemblyName, *__args): - # type: (self: AppDomain, assemblyName: str) -> int - """ - ExecuteAssemblyByName(self: AppDomain, assemblyName: str) -> int - - Executes an assembly given its display name. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - Returns: The value returned by the entry point of the assembly. - ExecuteAssemblyByName(self: AppDomain, assemblyName: str, assemblySecurity: Evidence) -> int - - Executes an assembly given its display name, using the specified evidence. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - assemblySecurity: Evidence for loading the assembly. - Returns: The value returned by the entry point of the assembly. - ExecuteAssemblyByName(self: AppDomain, assemblyName: str, assemblySecurity: Evidence, *args: Array[str]) -> int - - Executes the assembly given its display name, using the specified evidence and arguments. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - assemblySecurity: Evidence for loading the assembly. - args: Command-line arguments to pass when starting the process. - Returns: The value returned by the entry point of the assembly. - ExecuteAssemblyByName(self: AppDomain, assemblyName: str, *args: Array[str]) -> int - - Executes the assembly given its display name, using the specified arguments. - - assemblyName: The display name of the assembly. See System.Reflection.Assembly.FullName. - args: Command-line arguments to pass when starting the process. - Returns: The value that is returned by the entry point of the assembly. - ExecuteAssemblyByName(self: AppDomain, assemblyName: AssemblyName, assemblySecurity: Evidence, *args: Array[str]) -> int - - Executes the assembly given an System.Reflection.AssemblyName, using the specified evidence and arguments. - - assemblyName: An System.Reflection.AssemblyName object representing the name of the assembly. - assemblySecurity: Evidence for loading the assembly. - args: Command-line arguments to pass when starting the process. - Returns: The value returned by the entry point of the assembly. - ExecuteAssemblyByName(self: AppDomain, assemblyName: AssemblyName, *args: Array[str]) -> int - - Executes the assembly given an System.Reflection.AssemblyName, using the specified arguments. - - assemblyName: An System.Reflection.AssemblyName object representing the name of the assembly. - args: Command-line arguments to pass when starting the process. - Returns: The value that is returned by the entry point of the assembly. - """ - pass - - def GetAssemblies(self): - # type: (self: AppDomain) -> Array[Assembly] - """ - GetAssemblies(self: AppDomain) -> Array[Assembly] - - Gets the assemblies that have been loaded into the execution context of this application domain. - Returns: An array of assemblies in this application domain. - """ - pass - - @staticmethod - def GetCurrentThreadId(): - # type: () -> int - """ - GetCurrentThreadId() -> int - - Gets the current thread identifier. - Returns: A 32-bit signed integer that is the identifier of the current thread. - """ - pass - - def GetData(self, name): - # type: (self: AppDomain, name: str) -> object - """ - GetData(self: AppDomain, name: str) -> object - - Gets the value stored in the current application domain for the specified name. - - name: The name of a predefined application domain property, or the name of an application domain property you have defined. - Returns: The value of the name property, or null if the property does not exist. - """ - pass - - def GetType(self): - # type: (self: AppDomain) -> Type - """ - GetType(self: AppDomain) -> Type - - Gets the type of the current instance. - Returns: The type of the current instance. - """ - pass - - def InitializeLifetimeService(self): - # type: (self: AppDomain) -> object - """ - InitializeLifetimeService(self: AppDomain) -> object - - Gives the System.AppDomain an infinite lifetime by preventing a lease from being created. - Returns: Always null. - """ - pass - - def IsCompatibilitySwitchSet(self, value): - # type: (self: AppDomain, value: str) -> Nullable[bool] - """ - IsCompatibilitySwitchSet(self: AppDomain, value: str) -> Nullable[bool] - - Gets a nullable Boolean value that indicates whether any compatibility switches are set, and if so, whether the specified compatibility switch is set. - - value: The compatibility switch to test. - Returns: A null reference (Nothing in Visual Basic) if no compatibility switches are set; otherwise, a Boolean value that indicates whether the compatibility switch that is specified by value is set. - """ - pass - - def IsDefaultAppDomain(self): - # type: (self: AppDomain) -> bool - """ - IsDefaultAppDomain(self: AppDomain) -> bool - - Returns a value that indicates whether the application domain is the default application domain for the process. - Returns: true if the current System.AppDomain object represents the default application domain for the process; otherwise, false. - """ - pass - - def IsFinalizingForUnload(self): - # type: (self: AppDomain) -> bool - """ - IsFinalizingForUnload(self: AppDomain) -> bool - - Indicates whether this application domain is unloading, and the objects it contains are being finalized by the common language runtime. - Returns: true if this application domain is unloading and the common language runtime has started invoking finalizers; otherwise, false. - """ - pass - - def Load(self, *__args): - # type: (self: AppDomain, assemblyRef: AssemblyName) -> Assembly - """ - Load(self: AppDomain, assemblyRef: AssemblyName) -> Assembly - - Loads an System.Reflection.Assembly given its System.Reflection.AssemblyName. - - assemblyRef: An object that describes the assembly to load. - Returns: The loaded assembly. - Load(self: AppDomain, assemblyString: str) -> Assembly - - Loads an System.Reflection.Assembly given its display name. - - assemblyString: The display name of the assembly. See System.Reflection.Assembly.FullName. - Returns: The loaded assembly. - Load(self: AppDomain, rawAssembly: Array[Byte]) -> Assembly - - Loads the System.Reflection.Assembly with a common object file format (COFF) based image containing an emitted System.Reflection.Assembly. - - rawAssembly: An array of type byte that is a COFF-based image containing an emitted assembly. - Returns: The loaded assembly. - Load(self: AppDomain, rawAssembly: Array[Byte], rawSymbolStore: Array[Byte]) -> Assembly - - Loads the System.Reflection.Assembly with a common object file format (COFF) based image containing an emitted System.Reflection.Assembly. The raw bytes representing the symbols for the System.Reflection.Assembly are also loaded. - - rawAssembly: An array of type byte that is a COFF-based image containing an emitted assembly. - rawSymbolStore: An array of type byte containing the raw bytes representing the symbols for the assembly. - Returns: The loaded assembly. - Load(self: AppDomain, rawAssembly: Array[Byte], rawSymbolStore: Array[Byte], securityEvidence: Evidence) -> Assembly - - Loads the System.Reflection.Assembly with a common object file format (COFF) based image containing an emitted System.Reflection.Assembly. The raw bytes representing the symbols for the System.Reflection.Assembly are also loaded. - - rawAssembly: An array of type byte that is a COFF-based image containing an emitted assembly. - rawSymbolStore: An array of type byte containing the raw bytes representing the symbols for the assembly. - securityEvidence: Evidence for loading the assembly. - Returns: The loaded assembly. - Load(self: AppDomain, assemblyRef: AssemblyName, assemblySecurity: Evidence) -> Assembly - - Loads an System.Reflection.Assembly given its System.Reflection.AssemblyName. - - assemblyRef: An object that describes the assembly to load. - assemblySecurity: Evidence for loading the assembly. - Returns: The loaded assembly. - Load(self: AppDomain, assemblyString: str, assemblySecurity: Evidence) -> Assembly - - Loads an System.Reflection.Assembly given its display name. - - assemblyString: The display name of the assembly. See System.Reflection.Assembly.FullName. - assemblySecurity: Evidence for loading the assembly. - Returns: The loaded assembly. - """ - pass - - def MemberwiseClone(self, *args): #cannot find CLR method - # type: (self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - """ - MemberwiseClone(self: MarshalByRefObject, cloneIdentity: bool) -> MarshalByRefObject - - Creates a shallow copy of the current System.MarshalByRefObject object. - - cloneIdentity: false to delete the current System.MarshalByRefObject object's identity, which will cause the object to be assigned a new identity when it is marshaled across a remoting boundary. A value of false is usually appropriate. true to copy the current - System.MarshalByRefObject object's identity to its clone, which will cause remoting client calls to be routed to the remote server object. - - Returns: A shallow copy of the current System.MarshalByRefObject object. - MemberwiseClone(self: object) -> object - - Creates a shallow copy of the current System.Object. - Returns: A shallow copy of the current System.Object. - """ - pass - - def ReflectionOnlyGetAssemblies(self): - # type: (self: AppDomain) -> Array[Assembly] - """ - ReflectionOnlyGetAssemblies(self: AppDomain) -> Array[Assembly] - - Returns the assemblies that have been loaded into the reflection-only context of the application domain. - Returns: An array of System.Reflection.Assembly objects that represent the assemblies loaded into the reflection-only context of the application domain. - """ - pass - - def SetAppDomainPolicy(self, domainPolicy): - # type: (self: AppDomain, domainPolicy: PolicyLevel) - """ - SetAppDomainPolicy(self: AppDomain, domainPolicy: PolicyLevel) - Establishes the security policy level for this application domain. - - domainPolicy: The security policy level. - """ - pass - - def SetCachePath(self, path): - # type: (self: AppDomain, path: str) - """ - SetCachePath(self: AppDomain, path: str) - Establishes the specified directory path as the location where assemblies are shadow copied. - - path: The fully qualified path to the shadow copy location. - """ - pass - - def SetData(self, name, data, permission=None): - # type: (self: AppDomain, name: str, data: object) - """ - SetData(self: AppDomain, name: str, data: object) - Assigns the specified value to the specified application domain property. - - name: The name of a user-defined application domain property to create or change. - data: The value of the property. - SetData(self: AppDomain, name: str, data: object, permission: IPermission) - Assigns the specified value to the specified application domain property, with a specified permission to demand of the caller when the property is retrieved. - - name: The name of a user-defined application domain property to create or change. - data: The value of the property. - permission: The permission to demand of the caller when the property is retrieved. - """ - pass - - def SetDynamicBase(self, path): - # type: (self: AppDomain, path: str) - """ - SetDynamicBase(self: AppDomain, path: str) - Establishes the specified directory path as the base directory for subdirectories where dynamically generated files are stored and accessed. - - path: The fully qualified path that is the base directory for subdirectories where dynamic assemblies are stored. - """ - pass - - def SetPrincipalPolicy(self, policy): - # type: (self: AppDomain, policy: PrincipalPolicy) - """ - SetPrincipalPolicy(self: AppDomain, policy: PrincipalPolicy) - Specifies how principal and identity objects should be attached to a thread if the thread attempts to bind to a principal while executing in this application domain. - - policy: One of the System.Security.Principal.PrincipalPolicy values that specifies the type of the principal object to attach to threads. - """ - pass - - def SetShadowCopyFiles(self): - # type: (self: AppDomain) - """ - SetShadowCopyFiles(self: AppDomain) - Turns on shadow copying. - """ - pass - - def SetShadowCopyPath(self, path): - # type: (self: AppDomain, path: str) - """ - SetShadowCopyPath(self: AppDomain, path: str) - Establishes the specified directory path as the location of assemblies to be shadow copied. - - path: A list of directory names, where each name is separated by a semicolon. - """ - pass - - def SetThreadPrincipal(self, principal): - # type: (self: AppDomain, principal: IPrincipal) - """ - SetThreadPrincipal(self: AppDomain, principal: IPrincipal) - Sets the default principal object to be attached to threads if they attempt to bind to a principal while executing in this application domain. - - principal: The principal object to attach to threads. - """ - pass - - def ToString(self): - # type: (self: AppDomain) -> str - """ - ToString(self: AppDomain) -> str - - Obtains a string representation that includes the friendly name of the application domain and any context policies. - Returns: A string formed by concatenating the literal string "Name:", the friendly name of the application domain, and either string representations of the context policies or the string "There are no context policies." - """ - pass - - @staticmethod - def Unload(domain): - # type: (domain: AppDomain) - """ - Unload(domain: AppDomain) - Unloads the specified application domain. - - domain: An application domain to unload. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ActivationContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the activation context for the current application domain. - - Get: ActivationContext(self: AppDomain) -> ActivationContext - """ - - ApplicationIdentity = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the identity of the application in the application domain. - - Get: ApplicationIdentity(self: AppDomain) -> ApplicationIdentity - """ - - ApplicationTrust = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets information describing permissions granted to an application and whether the application has a trust level that allows it to run. - - Get: ApplicationTrust(self: AppDomain) -> ApplicationTrust - """ - - BaseDirectory = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the base directory that the assembly resolver uses to probe for assemblies. - - Get: BaseDirectory(self: AppDomain) -> str - """ - - DomainManager = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the domain manager that was provided by the host when the application domain was initialized. - - Get: DomainManager(self: AppDomain) -> AppDomainManager - """ - - DynamicDirectory = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the directory that the assembly resolver uses to probe for dynamically created assemblies. - - Get: DynamicDirectory(self: AppDomain) -> str - """ - - Evidence = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the System.Security.Policy.Evidence associated with this application domain. - - Get: Evidence(self: AppDomain) -> Evidence - """ - - FriendlyName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the friendly name of this application domain. - - Get: FriendlyName(self: AppDomain) -> str - """ - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an integer that uniquely identifies the application domain within the process. - - Get: Id(self: AppDomain) -> int - """ - - IsFullyTrusted = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether assemblies that are loaded into the current application domain execute with full trust. - - Get: IsFullyTrusted(self: AppDomain) -> bool - """ - - IsHomogenous = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the current application domain has a set of permissions that is granted to all assemblies that are loaded into the application domain. - - Get: IsHomogenous(self: AppDomain) -> bool - """ - - MonitoringSurvivedMemorySize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of bytes that survived the last full, blocking collection and that are known to be referenced by the current application domain. - - Get: MonitoringSurvivedMemorySize(self: AppDomain) -> Int64 - """ - - MonitoringTotalAllocatedMemorySize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the total size, in bytes, of all memory allocations that have been made by the application domain since it was created, without subtracting memory that has been collected. - - Get: MonitoringTotalAllocatedMemorySize(self: AppDomain) -> Int64 - """ - - MonitoringTotalProcessorTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the total processor time that has been used by all threads while executing in the current application domain, since the process started. - - Get: MonitoringTotalProcessorTime(self: AppDomain) -> TimeSpan - """ - - PermissionSet = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the permission set of a sandboxed application domain. - - Get: PermissionSet(self: AppDomain) -> PermissionSet - """ - - RelativeSearchPath = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the path under the base directory where the assembly resolver should probe for private assemblies. - - Get: RelativeSearchPath(self: AppDomain) -> str - """ - - SetupInformation = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the application domain configuration information for this instance. - - Get: SetupInformation(self: AppDomain) -> AppDomainSetup - """ - - ShadowCopyFiles = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an indication whether the application domain is configured to shadow copy files. - - Get: ShadowCopyFiles(self: AppDomain) -> bool - """ - - - AssemblyLoad = None - AssemblyResolve = None - CurrentDomain = None - DomainUnload = None - FirstChanceException = None - MonitoringIsEnabled = False - ProcessExit = None - ReflectionOnlyAssemblyResolve = None - ResourceResolve = None - TypeResolve = None - UnhandledException = None - - -class Delegate(object, ICloneable, ISerializable): - """ Represents a delegate, which is a data structure that refers to a static method or to a class instance and an instance method of that class. """ - def Call(self, *args): #cannot find CLR method - """ x.__call__(...) <==> x(...)x.__call__(...) <==> x(...) """ - pass - - def Clone(self): - # type: (self: Delegate) -> object - """ - Clone(self: Delegate) -> object - - Creates a shallow copy of the delegate. - Returns: A shallow copy of the delegate. - """ - pass - - @staticmethod - def Combine(*__args): - # type: (a: Delegate, b: Delegate) -> Delegate - """ - Combine(a: Delegate, b: Delegate) -> Delegate - - Concatenates the invocation lists of two delegates. - - a: The delegate whose invocation list comes first. - b: The delegate whose invocation list comes last. - Returns: A new delegate with an invocation list that concatenates the invocation lists of a and b in that order. Returns a if b is null, returns b if a is a null reference, and returns a null reference if both a and b are null references. - Combine(*delegates: Array[Delegate]) -> Delegate - - Concatenates the invocation lists of an array of delegates. - - delegates: The array of delegates to combine. - Returns: A new delegate with an invocation list that concatenates the invocation lists of the delegates in the delegates array. Returns null if delegates is null, if delegates contains zero elements, or if every entry in delegates is null. - """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, d: Delegate) -> Delegate - """ - CombineImpl(self: Delegate, d: Delegate) -> Delegate - - Concatenates the invocation lists of the specified multicast (combinable) delegate and the current multicast (combinable) delegate. - - d: The multicast (combinable) delegate whose invocation list to append to the end of the invocation list of the current multicast (combinable) delegate. - Returns: A new multicast (combinable) delegate with an invocation list that concatenates the invocation list of the current multicast (combinable) delegate and the invocation list of d, or the current multicast (combinable) delegate if d is null. - """ - pass - - @staticmethod - def CreateDelegate(type, *__args): - # type: (type: Type, target: object, method: str) -> Delegate - """ - CreateDelegate(type: Type, target: object, method: str) -> Delegate - - Creates a delegate of the specified type that represents the specified instance method to invoke on the specified class instance. - - type: The System.Type of delegate to create. - target: The class instance on which method is invoked. - method: The name of the instance method that the delegate is to represent. - Returns: A delegate of the specified type that represents the specified instance method to invoke on the specified class instance. - CreateDelegate(type: Type, target: object, method: str, ignoreCase: bool) -> Delegate - - Creates a delegate of the specified type that represents the specified instance method to invoke on the specified class instance with the specified case-sensitivity. - - type: The System.Type of delegate to create. - target: The class instance on which method is invoked. - method: The name of the instance method that the delegate is to represent. - ignoreCase: A Boolean indicating whether to ignore the case when comparing the name of the method. - Returns: A delegate of the specified type that represents the specified instance method to invoke on the specified class instance. - CreateDelegate(type: Type, target: object, method: str, ignoreCase: bool, throwOnBindFailure: bool) -> Delegate - - Creates a delegate of the specified type that represents the specified instance method to invoke on the specified class instance, with the specified case-sensitivity and the specified behavior on failure to bind. - - type: The System.Type of delegate to create. - target: The class instance on which method is invoked. - method: The name of the instance method that the delegate is to represent. - ignoreCase: A Boolean indicating whether to ignore the case when comparing the name of the method. - throwOnBindFailure: true to throw an exception if method cannot be bound; otherwise, false. - Returns: A delegate of the specified type that represents the specified instance method to invoke on the specified class instance. - CreateDelegate(type: Type, target: Type, method: str) -> Delegate - - Creates a delegate of the specified type that represents the specified static method of the specified class. - - type: The System.Type of delegate to create. - target: The System.Type representing the class that implements method. - method: The name of the static method that the delegate is to represent. - Returns: A delegate of the specified type that represents the specified static method of the specified class. - CreateDelegate(type: Type, target: Type, method: str, ignoreCase: bool) -> Delegate - - Creates a delegate of the specified type that represents the specified static method of the specified class, with the specified case-sensitivity. - - type: The System.Type of delegate to create. - target: The System.Type representing the class that implements method. - method: The name of the static method that the delegate is to represent. - ignoreCase: A Boolean indicating whether to ignore the case when comparing the name of the method. - Returns: A delegate of the specified type that represents the specified static method of the specified class. - CreateDelegate(type: Type, target: Type, method: str, ignoreCase: bool, throwOnBindFailure: bool) -> Delegate - - Creates a delegate of the specified type that represents the specified static method of the specified class, with the specified case-sensitivity and the specified behavior on failure to bind. - - type: The System.Type of delegate to create. - target: The System.Type representing the class that implements method. - method: The name of the static method that the delegate is to represent. - ignoreCase: A Boolean indicating whether to ignore the case when comparing the name of the method. - throwOnBindFailure: true to throw an exception if method cannot be bound; otherwise, false. - Returns: A delegate of the specified type that represents the specified static method of the specified class. - CreateDelegate(type: Type, method: MethodInfo, throwOnBindFailure: bool) -> Delegate - - Creates a delegate of the specified type to represent the specified static method, with the specified behavior on failure to bind. - - type: The System.Type of delegate to create. - method: The System.Reflection.MethodInfo describing the static or instance method the delegate is to represent. - throwOnBindFailure: true to throw an exception if method cannot be bound; otherwise, false. - Returns: A delegate of the specified type to represent the specified static method. - CreateDelegate(type: Type, firstArgument: object, method: MethodInfo) -> Delegate - - Creates a delegate of the specified type that represents the specified static or instance method, with the specified first argument. - - type: The System.Type of delegate to create. - firstArgument: The object to which the delegate is bound, or null to treat method as static (Shared in Visual Basic). - method: The System.Reflection.MethodInfo describing the static or instance method the delegate is to represent. - Returns: A delegate of the specified type that represents the specified static or instance method. - CreateDelegate(type: Type, firstArgument: object, method: MethodInfo, throwOnBindFailure: bool) -> Delegate - - Creates a delegate of the specified type that represents the specified static or instance method, with the specified first argument and the specified behavior on failure to bind. - - type: A System.Type representing the type of delegate to create. - firstArgument: An System.Object that is the first argument of the method the delegate represents. For instance methods, it must be compatible with the instance type. - method: The System.Reflection.MethodInfo describing the static or instance method the delegate is to represent. - throwOnBindFailure: true to throw an exception if method cannot be bound; otherwise, false. - Returns: A delegate of the specified type that represents the specified static or instance method, or null if throwOnBindFailure is false and the delegate cannot be bound to method. - CreateDelegate(type: Type, method: MethodInfo) -> Delegate - - Creates a delegate of the specified type to represent the specified static method. - - type: The System.Type of delegate to create. - method: The System.Reflection.MethodInfo describing the static or instance method the delegate is to represent. Only static methods are supported in the .NET Framework version 1.0 and 1.1. - Returns: A delegate of the specified type to represent the specified static method. - """ - pass - - def DynamicInvoke(self, args): - # type: (self: Delegate, *args: Array[object]) -> object - """ - DynamicInvoke(self: Delegate, *args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def Equals(self, obj): - # type: (self: Delegate, obj: object) -> bool - """ - Equals(self: Delegate, obj: object) -> bool - - Determines whether the specified object and the current delegate are of the same type and share the same targets, methods, and invocation list. - - obj: The object to compare with the current delegate. - Returns: true if obj and the current delegate have the same targets, methods, and invocation list; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: Delegate) -> int - """ - GetHashCode(self: Delegate) -> int - - Returns a hash code for the delegate. - Returns: A hash code for the delegate. - """ - pass - - def GetInvocationList(self): - # type: (self: Delegate) -> Array[Delegate] - """ - GetInvocationList(self: Delegate) -> Array[Delegate] - - Returns the invocation list of the delegate. - Returns: An array of delegates representing the invocation list of the current delegate. - """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: Delegate) -> MethodInfo - """ - GetMethodImpl(self: Delegate) -> MethodInfo - - Gets the static method represented by the current delegate. - Returns: A System.Reflection.MethodInfo describing the static method represented by the current delegate. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: Delegate, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: Delegate, info: SerializationInfo, context: StreamingContext) - Not supported. - - info: Not supported. - context: Not supported. - """ - pass - - def InPlaceAdd(self, *args): #cannot find CLR method - # type: (self: Delegate, other: Delegate) -> Delegate - """ InPlaceAdd(self: Delegate, other: Delegate) -> Delegate """ - pass - - def InPlaceSubtract(self, *args): #cannot find CLR method - # type: (self: Delegate, other: Delegate) -> Delegate - """ InPlaceSubtract(self: Delegate, other: Delegate) -> Delegate """ - pass - - @staticmethod - def Remove(source, value): - # type: (source: Delegate, value: Delegate) -> Delegate - """ - Remove(source: Delegate, value: Delegate) -> Delegate - - Removes the last occurrence of the invocation list of a delegate from the invocation list of another delegate. - - source: The delegate from which to remove the invocation list of value. - value: The delegate that supplies the invocation list to remove from the invocation list of source. - Returns: A new delegate with an invocation list formed by taking the invocation list of source and removing the last occurrence of the invocation list of value, if the invocation list of value is found within the invocation list of source. Returns source if - value is null or if the invocation list of value is not found within the invocation list of source. Returns a null reference if the invocation list of value is equal to the invocation list of source or if source is a null reference. - """ - pass - - @staticmethod - def RemoveAll(source, value): - # type: (source: Delegate, value: Delegate) -> Delegate - """ - RemoveAll(source: Delegate, value: Delegate) -> Delegate - - Removes all occurrences of the invocation list of a delegate from the invocation list of another delegate. - - source: The delegate from which to remove the invocation list of value. - value: The delegate that supplies the invocation list to remove from the invocation list of source. - Returns: A new delegate with an invocation list formed by taking the invocation list of source and removing all occurrences of the invocation list of value, if the invocation list of value is found within the invocation list of source. Returns source if value - is null or if the invocation list of value is not found within the invocation list of source. Returns a null reference if the invocation list of value is equal to the invocation list of source, if source contains only a series of invocation lists that - are equal to the invocation list of value, or if source is a null reference. - """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, d: Delegate) -> Delegate - """ - RemoveImpl(self: Delegate, d: Delegate) -> Delegate - - Removes the invocation list of a delegate from the invocation list of another delegate. - - d: The delegate that supplies the invocation list to remove from the invocation list of the current delegate. - Returns: A new delegate with an invocation list formed by taking the invocation list of the current delegate and removing the invocation list of value, if the invocation list of value is found within the current delegate's invocation list. Returns the current - delegate if value is null or if the invocation list of value is not found within the current delegate's invocation list. Returns null if the invocation list of value is equal to the current delegate's invocation list. - """ - pass - - def __call__(self, *args): #cannot find CLR method - """ x.__call__(...) <==> x(...)x.__call__(...) <==> x(...) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __iadd__(self, *args): #cannot find CLR method - """ __iadd__(self: Delegate, other: Delegate) -> Delegate """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __isub__(self, *args): #cannot find CLR method - """ __isub__(self: Delegate, other: Delegate) -> Delegate """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ __new__(type: type, function: object) -> object """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Method = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the method represented by the delegate. - - Get: Method(self: Delegate) -> MethodInfo - """ - - Target = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the class instance on which the current delegate invokes the instance method. - - Get: Target(self: Delegate) -> object - """ - - - -class MulticastDelegate(Delegate, ICloneable, ISerializable): - """ Represents a multicast delegate; that is, a delegate that can have more than one element in its invocation list. """ - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def Equals(self, obj): - # type: (self: MulticastDelegate, obj: object) -> bool - """ - Equals(self: MulticastDelegate, obj: object) -> bool - - Determines whether this multicast delegate and the specified object are equal. - - obj: The object to compare with this instance. - Returns: true if obj and this instance have the same invocation lists; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: MulticastDelegate) -> int - """ - GetHashCode(self: MulticastDelegate) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetInvocationList(self): - # type: (self: MulticastDelegate) -> Array[Delegate] - """ - GetInvocationList(self: MulticastDelegate) -> Array[Delegate] - - Returns the invocation list of this multicast delegate, in invocation order. - Returns: An array of delegates whose invocation lists collectively match the invocation list of this instance. - """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: MulticastDelegate, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: MulticastDelegate, info: SerializationInfo, context: StreamingContext) - Populates a System.Runtime.Serialization.SerializationInfo object with all the data needed to serialize this instance. - - info: An object that holds all the data needed to serialize or deserialize this instance. - context: (Reserved) The location where serialized data is stored and retrieved. - """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type, target: object, method: str) - __new__(cls: type, target: Type, method: str) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class AppDomainInitializer(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the callback method to invoke when the application domain is initialized. - - AppDomainInitializer(object: object, method: IntPtr) - """ - def BeginInvoke(self, args, callback, object): - # type: (self: AppDomainInitializer, args: Array[str], callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: AppDomainInitializer, args: Array[str], callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: AppDomainInitializer, result: IAsyncResult) - """ EndInvoke(self: AppDomainInitializer, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, args): - # type: (self: AppDomainInitializer, args: Array[str]) - """ Invoke(self: AppDomainInitializer, args: Array[str]) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class AppDomainManager(MarshalByRefObject): - """ - Provides a managed equivalent of an unmanaged host. - - AppDomainManager() - """ - def CheckSecuritySettings(self, state): - # type: (self: AppDomainManager, state: SecurityState) -> bool - """ - CheckSecuritySettings(self: AppDomainManager, state: SecurityState) -> bool - - Indicates whether the specified operation is allowed in the application domain. - - state: A subclass of System.Security.SecurityState that identifies the operation whose security status is requested. - Returns: true if the host allows the operation specified by state to be performed in the application domain; otherwise, false. - """ - pass - - def CreateDomain(self, friendlyName, securityInfo, appDomainInfo): - # type: (self: AppDomainManager, friendlyName: str, securityInfo: Evidence, appDomainInfo: AppDomainSetup) -> AppDomain - """ - CreateDomain(self: AppDomainManager, friendlyName: str, securityInfo: Evidence, appDomainInfo: AppDomainSetup) -> AppDomain - - Returns a new or existing application domain. - - friendlyName: The friendly name of the domain. - securityInfo: An object that contains evidence mapped through the security policy to establish a top-of-stack permission set. - appDomainInfo: An object that contains application domain initialization information. - Returns: A new or existing application domain. - """ - pass - - def CreateDomainHelper(self, *args): #cannot find CLR method - # type: (friendlyName: str, securityInfo: Evidence, appDomainInfo: AppDomainSetup) -> AppDomain - """ - CreateDomainHelper(friendlyName: str, securityInfo: Evidence, appDomainInfo: AppDomainSetup) -> AppDomain - - Provides a helper method to create an application domain. - - friendlyName: The friendly name of the domain. - securityInfo: An object that contains evidence mapped through the security policy to establish a top-of-stack permission set. - appDomainInfo: An object that contains application domain initialization information. - Returns: A newly created application domain. - """ - pass - - def InitializeNewDomain(self, appDomainInfo): - # type: (self: AppDomainManager, appDomainInfo: AppDomainSetup) - """ - InitializeNewDomain(self: AppDomainManager, appDomainInfo: AppDomainSetup) - Initializes the new application domain. - - appDomainInfo: An object that contains application domain initialization information. - """ - pass - - ApplicationActivator = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the application activator that handles the activation of add-ins and manifest-based applications for the domain. - - Get: ApplicationActivator(self: AppDomainManager) -> ApplicationActivator - """ - - EntryAssembly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the entry assembly for an application. - - Get: EntryAssembly(self: AppDomainManager) -> Assembly - """ - - HostExecutionContextManager = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the host execution context manager that manages the flow of the execution context. - - Get: HostExecutionContextManager(self: AppDomainManager) -> HostExecutionContextManager - """ - - HostSecurityManager = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the host security manager that participates in security decisions for the application domain. - - Get: HostSecurityManager(self: AppDomainManager) -> HostSecurityManager - """ - - InitializationFlags = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the initialization flags for custom application domain managers. - - Get: InitializationFlags(self: AppDomainManager) -> AppDomainManagerInitializationOptions - - Set: InitializationFlags(self: AppDomainManager) = value - """ - - - -class IConvertible: - """ Defines methods that convert the value of the implementing reference or value type to a common language runtime type that has an equivalent value. """ - def GetTypeCode(self): - # type: (self: IConvertible) -> TypeCode - """ - GetTypeCode(self: IConvertible) -> TypeCode - - Returns the System.TypeCode for this instance. - Returns: The enumerated constant that is the System.TypeCode of the class or value type that implements this interface. - """ - pass - - def ToBoolean(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> bool - """ - ToBoolean(self: IConvertible, provider: IFormatProvider) -> bool - - Converts the value of this instance to an equivalent Boolean value using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: A Boolean value equivalent to the value of this instance. - """ - pass - - def ToByte(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> Byte - """ - ToByte(self: IConvertible, provider: IFormatProvider) -> Byte - - Converts the value of this instance to an equivalent 8-bit unsigned integer using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: An 8-bit unsigned integer equivalent to the value of this instance. - """ - pass - - def ToChar(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> Char - """ - ToChar(self: IConvertible, provider: IFormatProvider) -> Char - - Converts the value of this instance to an equivalent Unicode character using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: A Unicode character equivalent to the value of this instance. - """ - pass - - def ToDateTime(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> DateTime - """ - ToDateTime(self: IConvertible, provider: IFormatProvider) -> DateTime - - Converts the value of this instance to an equivalent System.DateTime using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: A System.DateTime instance equivalent to the value of this instance. - """ - pass - - def ToDecimal(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> Decimal - """ - ToDecimal(self: IConvertible, provider: IFormatProvider) -> Decimal - - Converts the value of this instance to an equivalent System.Decimal number using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: A System.Decimal number equivalent to the value of this instance. - """ - pass - - def ToDouble(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> float - """ - ToDouble(self: IConvertible, provider: IFormatProvider) -> float - - Converts the value of this instance to an equivalent double-precision floating-point number using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: A double-precision floating-point number equivalent to the value of this instance. - """ - pass - - def ToInt16(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> Int16 - """ - ToInt16(self: IConvertible, provider: IFormatProvider) -> Int16 - - Converts the value of this instance to an equivalent 16-bit signed integer using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: An 16-bit signed integer equivalent to the value of this instance. - """ - pass - - def ToInt32(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> int - """ - ToInt32(self: IConvertible, provider: IFormatProvider) -> int - - Converts the value of this instance to an equivalent 32-bit signed integer using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: An 32-bit signed integer equivalent to the value of this instance. - """ - pass - - def ToInt64(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> Int64 - """ - ToInt64(self: IConvertible, provider: IFormatProvider) -> Int64 - - Converts the value of this instance to an equivalent 64-bit signed integer using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: An 64-bit signed integer equivalent to the value of this instance. - """ - pass - - def ToSByte(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> SByte - """ - ToSByte(self: IConvertible, provider: IFormatProvider) -> SByte - - Converts the value of this instance to an equivalent 8-bit signed integer using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: An 8-bit signed integer equivalent to the value of this instance. - """ - pass - - def ToSingle(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> Single - """ - ToSingle(self: IConvertible, provider: IFormatProvider) -> Single - - Converts the value of this instance to an equivalent single-precision floating-point number using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: A single-precision floating-point number equivalent to the value of this instance. - """ - pass - - def ToString(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> str - """ - ToString(self: IConvertible, provider: IFormatProvider) -> str - - Converts the value of this instance to an equivalent System.String using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: A System.String instance equivalent to the value of this instance. - """ - pass - - def ToType(self, conversionType, provider): - # type: (self: IConvertible, conversionType: Type, provider: IFormatProvider) -> object - """ - ToType(self: IConvertible, conversionType: Type, provider: IFormatProvider) -> object - - Converts the value of this instance to an System.Object of the specified System.Type that has an equivalent value, using the specified culture-specific formatting information. - - conversionType: The System.Type to which the value of this instance is converted. - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: An System.Object instance of type conversionType whose value is equivalent to the value of this instance. - """ - pass - - def ToUInt16(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> UInt16 - """ - ToUInt16(self: IConvertible, provider: IFormatProvider) -> UInt16 - - Converts the value of this instance to an equivalent 16-bit unsigned integer using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: An 16-bit unsigned integer equivalent to the value of this instance. - """ - pass - - def ToUInt32(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> UInt32 - """ - ToUInt32(self: IConvertible, provider: IFormatProvider) -> UInt32 - - Converts the value of this instance to an equivalent 32-bit unsigned integer using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: An 32-bit unsigned integer equivalent to the value of this instance. - """ - pass - - def ToUInt64(self, provider): - # type: (self: IConvertible, provider: IFormatProvider) -> UInt64 - """ - ToUInt64(self: IConvertible, provider: IFormatProvider) -> UInt64 - - Converts the value of this instance to an equivalent 64-bit unsigned integer using the specified culture-specific formatting information. - - provider: An System.IFormatProvider interface implementation that supplies culture-specific formatting information. - Returns: An 64-bit unsigned integer equivalent to the value of this instance. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IFormattable: - """ Provides functionality to format the value of an object into a string representation. """ - def ToString(self, format, formatProvider): - # type: (self: IFormattable, format: str, formatProvider: IFormatProvider) -> str - """ - ToString(self: IFormattable, format: str, formatProvider: IFormatProvider) -> str - - Formats the value of the current instance using the specified format. - - format: The format to use.-or- A null reference (Nothing in Visual Basic) to use the default format defined for the type of the System.IFormattable implementation. - formatProvider: The provider to use to format the value.-or- A null reference (Nothing in Visual Basic) to obtain the numeric format information from the current locale setting of the operating system. - Returns: The value of the current instance in the specified format. - """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class Enum(object, IComparable, IFormattable, IConvertible): - """ Provides the base class for enumerations. """ - def CompareTo(self, target): - # type: (self: Enum, target: object) -> int - """ - CompareTo(self: Enum, target: object) -> int - - Compares this instance to a specified object and returns an indication of their relative values. - - target: An object to compare, or null. - Returns: A signed number that indicates the relative values of this instance and target.Value Meaning Less than zero The value of this instance is less than the value of target. Zero The value of this instance is equal to the value of target. Greater than zero - The value of this instance is greater than the value of target.-or- target is null. - """ - pass - - def Equals(self, obj): - # type: (self: Enum, obj: object) -> bool - """ - Equals(self: Enum, obj: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - obj: An object to compare with this instance, or null. - Returns: true if obj is an System.Enum with the same underlying type and value as this instance; otherwise, false. - """ - pass - - @staticmethod - def Format(enumType, value, format): - # type: (enumType: Type, value: object, format: str) -> str - """ - Format(enumType: Type, value: object, format: str) -> str - - Converts the specified value of a specified enumerated type to its equivalent string representation according to the specified format. - - enumType: The enumeration type of the value to convert. - value: The value to convert. - format: The output format to use. - Returns: A string representation of value. - """ - pass - - def GetHashCode(self): - # type: (self: Enum) -> int - """ - GetHashCode(self: Enum) -> int - - Returns the hash code for the value of this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - @staticmethod - def GetName(enumType, value): - # type: (enumType: Type, value: object) -> str - """ - GetName(enumType: Type, value: object) -> str - - Retrieves the name of the constant in the specified enumeration that has the specified value. - - enumType: An enumeration type. - value: The value of a particular enumerated constant in terms of its underlying type. - Returns: A string containing the name of the enumerated constant in enumType whose value is value; or null if no such constant is found. - """ - pass - - @staticmethod - def GetNames(enumType): - # type: (enumType: Type) -> Array[str] - """ - GetNames(enumType: Type) -> Array[str] - - Retrieves an array of the names of the constants in a specified enumeration. - - enumType: An enumeration type. - Returns: A string array of the names of the constants in enumType. - """ - pass - - def GetTypeCode(self): - # type: (self: Enum) -> TypeCode - """ - GetTypeCode(self: Enum) -> TypeCode - - Returns the underlying System.TypeCode for this instance. - Returns: The type for this instance. - """ - pass - - @staticmethod - def GetUnderlyingType(enumType): - # type: (enumType: Type) -> Type - """ - GetUnderlyingType(enumType: Type) -> Type - - Returns the underlying type of the specified enumeration. - - enumType: The enumeration whose underlying type will be retrieved. - Returns: The underlying type of enumType. - """ - pass - - @staticmethod - def GetValues(enumType): - # type: (enumType: Type) -> Array - """ - GetValues(enumType: Type) -> Array - - Retrieves an array of the values of the constants in a specified enumeration. - - enumType: The enumeration type to retrieve values from. - Returns: An array that contains the values of the constants in enumType. - """ - pass - - def HasFlag(self, flag): - # type: (self: Enum, flag: Enum) -> bool - """ - HasFlag(self: Enum, flag: Enum) -> bool - - Determines whether one or more bit fields are set in the current instance. - - flag: An enumeration value. - Returns: true if the bit field or bit fields that are set in flag are also set in the current instance; otherwise, false. - """ - pass - - @staticmethod - def IsDefined(enumType, value): - # type: (enumType: Type, value: object) -> bool - """ - IsDefined(enumType: Type, value: object) -> bool - - Indicates whether a constant with a specified value exists in a specified enumeration. - - enumType: The enumeration type to check. - value: The value or name of a constant in enumType. - Returns: true if a constant in enumType has a value equal to value; otherwise, false. - """ - pass - - @staticmethod - def Parse(enumType, value, ignoreCase=None): - # type: (enumType: Type, value: str) -> object - """ - Parse(enumType: Type, value: str) -> object - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. - - enumType: An enumeration type. - value: A string containing the name or value to convert. - Returns: An object of type enumType whose value is represented by value. - Parse(enumType: Type, value: str, ignoreCase: bool) -> object - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-insensitive. - - enumType: An enumeration type. - value: A string containing the name or value to convert. - ignoreCase: true to ignore case; false to regard case. - Returns: An object of type enumType whose value is represented by value. - """ - pass - - @staticmethod - def ToObject(enumType, value): - # type: (enumType: Type, value: object) -> object - """ - ToObject(enumType: Type, value: object) -> object - - Converts the specified object with an integer value to an enumeration member. - - enumType: The enumeration type to return. - value: The value convert to an enumeration member. - Returns: An enumeration object whose value is value. - ToObject(enumType: Type, value: SByte) -> object - - Converts the specified 8-bit signed integer value to an enumeration member. - - enumType: The enumeration type to return. - value: The value to convert to an enumeration member. - Returns: An instance of the enumeration set to value. - ToObject(enumType: Type, value: Int16) -> object - - Converts the specified 16-bit signed integer to an enumeration member. - - enumType: The enumeration type to return. - value: The value to convert to an enumeration member. - Returns: An instance of the enumeration set to value. - ToObject(enumType: Type, value: int) -> object - - Converts the specified 32-bit signed integer to an enumeration member. - - enumType: The enumeration type to return. - value: The value to convert to an enumeration member. - Returns: An instance of the enumeration set to value. - ToObject(enumType: Type, value: Byte) -> object - - Converts the specified 8-bit unsigned integer to an enumeration member. - - enumType: The enumeration type to return. - value: The value to convert to an enumeration member. - Returns: An instance of the enumeration set to value. - ToObject(enumType: Type, value: UInt16) -> object - - Converts the specified 16-bit unsigned integer value to an enumeration member. - - enumType: The enumeration type to return. - value: The value to convert to an enumeration member. - Returns: An instance of the enumeration set to value. - ToObject(enumType: Type, value: UInt32) -> object - - Converts the specified 32-bit unsigned integer value to an enumeration member. - - enumType: The enumeration type to return. - value: The value to convert to an enumeration member. - Returns: An instance of the enumeration set to value. - ToObject(enumType: Type, value: Int64) -> object - - Converts the specified 64-bit signed integer to an enumeration member. - - enumType: The enumeration type to return. - value: The value to convert to an enumeration member. - Returns: An instance of the enumeration set to value. - ToObject(enumType: Type, value: UInt64) -> object - - Converts the specified 64-bit unsigned integer value to an enumeration member. - - enumType: The enumeration type to return. - value: The value to convert to an enumeration member. - Returns: An instance of the enumeration set to value. - """ - pass - - def ToString(self, *__args): - # type: (self: Enum) -> str - """ - ToString(self: Enum) -> str - - Converts the value of this instance to its equivalent string representation. - Returns: The string representation of the value of this instance. - ToString(self: Enum, format: str, provider: IFormatProvider) -> str - - This method overload is obsolete; use System.Enum.ToString(System.String). - - format: A format specification. - provider: (Obsolete.) - Returns: The string representation of the value of this instance as specified by format. - ToString(self: Enum, format: str) -> str - - Converts the value of this instance to its equivalent string representation using the specified format. - - format: A format string. - Returns: The string representation of the value of this instance as specified by format. - ToString(self: Enum, provider: IFormatProvider) -> str - - This method overload is obsolete; use System.Enum.ToString. - - provider: (obsolete) - Returns: The string representation of the value of this instance. - """ - pass - - @staticmethod - def TryParse(value, *__args): - # type: (value: str) -> (bool, TEnum) - """ - TryParse[TEnum](value: str) -> (bool, TEnum) - TryParse[TEnum](value: str, ignoreCase: bool) -> (bool, TEnum) - """ - pass - - def __and__(self, *args): #cannot find CLR method - """ __and__(self: object, other: object) -> object """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __invert__(self, *args): #cannot find CLR method - """ __invert__(self: object) -> object """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(self: object) -> bool """ - pass - - def __or__(self, *args): #cannot find CLR method - """ __or__(self: object, other: object) -> object """ - pass - - def __rand__(self, *args): #cannot find CLR method - """ __rand__(self: object, other: object) -> object """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __ror__(self, *args): #cannot find CLR method - """ __ror__(self: object, other: object) -> object """ - pass - - def __rxor__(self, *args): #cannot find CLR method - """ __rxor__(self: object, other: object) -> object """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __xor__(self, *args): #cannot find CLR method - """ __xor__(self: object, other: object) -> object """ - pass - - -class AppDomainManagerInitializationOptions(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies the action that a custom application domain manager takes when initializing a new domain. - - enum (flags) AppDomainManagerInitializationOptions, values: None (0), RegisterWithHost (1) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - None = None - RegisterWithHost = None - value__ = None - - -class AppDomainSetup(object, IAppDomainSetup): - """ - Represents assembly binding information that can be added to an instance of System.AppDomain. - - AppDomainSetup() - AppDomainSetup(activationContext: ActivationContext) - AppDomainSetup(activationArguments: ActivationArguments) - """ - def GetConfigurationBytes(self): - # type: (self: AppDomainSetup) -> Array[Byte] - """ - GetConfigurationBytes(self: AppDomainSetup) -> Array[Byte] - - Returns the XML configuration information set by the System.AppDomainSetup.SetConfigurationBytes(System.Byte[]) method, which overrides the application's XML configuration information. - Returns: An array that contains the XML configuration information that was set by the System.AppDomainSetup.SetConfigurationBytes(System.Byte[]) method, or null if the System.AppDomainSetup.SetConfigurationBytes(System.Byte[]) method has not been called. - """ - pass - - def SetCompatibilitySwitches(self, switches): - # type: (self: AppDomainSetup, switches: IEnumerable[str]) - """ SetCompatibilitySwitches(self: AppDomainSetup, switches: IEnumerable[str]) """ - pass - - def SetConfigurationBytes(self, value): - # type: (self: AppDomainSetup, value: Array[Byte]) - """ - SetConfigurationBytes(self: AppDomainSetup, value: Array[Byte]) - Provides XML configuration information for the application domain, overriding the application's XML configuration information. - - value: An array that contains the XML configuration information to be used for the application domain. - """ - pass - - def SetNativeFunction(self, functionName, functionVersion, functionPointer): - # type: (self: AppDomainSetup, functionName: str, functionVersion: int, functionPointer: IntPtr) - """ SetNativeFunction(self: AppDomainSetup, functionName: str, functionVersion: int, functionPointer: IntPtr) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, activationContext: ActivationContext) - __new__(cls: type, activationArguments: ActivationArguments) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - ActivationArguments = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets data about the activation of an application domain. - - Get: ActivationArguments(self: AppDomainSetup) -> ActivationArguments - - Set: ActivationArguments(self: AppDomainSetup) = value - """ - - AppDomainInitializer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the System.AppDomainInitializer delegate, which represents a callback method that is invoked when the application domain is initialized. - - Get: AppDomainInitializer(self: AppDomainSetup) -> AppDomainInitializer - - Set: AppDomainInitializer(self: AppDomainSetup) = value - """ - - AppDomainInitializerArguments = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the arguments passed to the callback method represented by the System.AppDomainInitializer delegate. The callback method is invoked when the application domain is initialized. - - Get: AppDomainInitializerArguments(self: AppDomainSetup) -> Array[str] - - Set: AppDomainInitializerArguments(self: AppDomainSetup) = value - """ - - AppDomainManagerAssembly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the display name of the assembly that provides the type of the application domain manager for application domains created using this System.AppDomainSetup object. - - Get: AppDomainManagerAssembly(self: AppDomainSetup) -> str - - Set: AppDomainManagerAssembly(self: AppDomainSetup) = value - """ - - AppDomainManagerType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the full name of the type that provides the application domain manager for application domains created using this System.AppDomainSetup object. - - Get: AppDomainManagerType(self: AppDomainSetup) -> str - - Set: AppDomainManagerType(self: AppDomainSetup) = value - """ - - ApplicationBase = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the name of the directory containing the application. - - Get: ApplicationBase(self: AppDomainSetup) -> str - - Set: ApplicationBase(self: AppDomainSetup) = value - """ - - ApplicationName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the name of the application. - - Get: ApplicationName(self: AppDomainSetup) -> str - - Set: ApplicationName(self: AppDomainSetup) = value - """ - - ApplicationTrust = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets an object containing security and trust information. - - Get: ApplicationTrust(self: AppDomainSetup) -> ApplicationTrust - - Set: ApplicationTrust(self: AppDomainSetup) = value - """ - - CachePath = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the name of an area specific to the application where files are shadow copied. - - Get: CachePath(self: AppDomainSetup) -> str - - Set: CachePath(self: AppDomainSetup) = value - """ - - ConfigurationFile = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the name of the configuration file for an application domain. - - Get: ConfigurationFile(self: AppDomainSetup) -> str - - Set: ConfigurationFile(self: AppDomainSetup) = value - """ - - DisallowApplicationBaseProbing = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Specifies whether the application base path and private binary path are probed when searching for assemblies to load. - - Get: DisallowApplicationBaseProbing(self: AppDomainSetup) -> bool - - Set: DisallowApplicationBaseProbing(self: AppDomainSetup) = value - """ - - DisallowBindingRedirects = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a value that indicates whether an application domain allows assembly binding redirection. - - Get: DisallowBindingRedirects(self: AppDomainSetup) -> bool - - Set: DisallowBindingRedirects(self: AppDomainSetup) = value - """ - - DisallowCodeDownload = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a value that indicates whether HTTP download of assemblies is allowed for an application domain. - - Get: DisallowCodeDownload(self: AppDomainSetup) -> bool - - Set: DisallowCodeDownload(self: AppDomainSetup) = value - """ - - DisallowPublisherPolicy = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a value that indicates whether the section of the configuration file is applied to an application domain. - - Get: DisallowPublisherPolicy(self: AppDomainSetup) -> bool - - Set: DisallowPublisherPolicy(self: AppDomainSetup) = value - """ - - DynamicBase = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the base directory where the directory for dynamically generated files is located. - - Get: DynamicBase(self: AppDomainSetup) -> str - - Set: DynamicBase(self: AppDomainSetup) = value - """ - - LicenseFile = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the location of the license file associated with this domain. - - Get: LicenseFile(self: AppDomainSetup) -> str - - Set: LicenseFile(self: AppDomainSetup) = value - """ - - LoaderOptimization = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Specifies the optimization policy used to load an executable. - - Get: LoaderOptimization(self: AppDomainSetup) -> LoaderOptimization - - Set: LoaderOptimization(self: AppDomainSetup) = value - """ - - PartialTrustVisibleAssemblies = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a list of assemblies marked with the System.Security.PartialTrustVisibilityLevel.NotVisibleByDefault flag that are made visible to partial-trust code running in a sandboxed application domain. - - Get: PartialTrustVisibleAssemblies(self: AppDomainSetup) -> Array[str] - - Set: PartialTrustVisibleAssemblies(self: AppDomainSetup) = value - """ - - PrivateBinPath = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the list of directories under the application base directory that are probed for private assemblies. - - Get: PrivateBinPath(self: AppDomainSetup) -> str - - Set: PrivateBinPath(self: AppDomainSetup) = value - """ - - PrivateBinPathProbe = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a string value that includes or excludes System.AppDomainSetup.ApplicationBase from the search path for the application, and searches only System.AppDomainSetup.PrivateBinPath. - - Get: PrivateBinPathProbe(self: AppDomainSetup) -> str - - Set: PrivateBinPathProbe(self: AppDomainSetup) = value - """ - - SandboxInterop = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a value that indicates whether interface caching is disabled for interop calls in the application domain, so that a QueryInterface is performed on each call. - - Get: SandboxInterop(self: AppDomainSetup) -> bool - - Set: SandboxInterop(self: AppDomainSetup) = value - """ - - ShadowCopyDirectories = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the names of the directories containing assemblies to be shadow copied. - - Get: ShadowCopyDirectories(self: AppDomainSetup) -> str - - Set: ShadowCopyDirectories(self: AppDomainSetup) = value - """ - - ShadowCopyFiles = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a string that indicates whether shadow copying is turned on or off. - - Get: ShadowCopyFiles(self: AppDomainSetup) -> str - - Set: ShadowCopyFiles(self: AppDomainSetup) = value - """ - - TargetFrameworkName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: AppDomainSetup) -> str - """ - Get: TargetFrameworkName(self: AppDomainSetup) -> str - - Set: TargetFrameworkName(self: AppDomainSetup) = value - """ - - - -class AppDomainUnloadedException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when an attempt is made to access an unloaded application domain. - - AppDomainUnloadedException() - AppDomainUnloadedException(message: str) - AppDomainUnloadedException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class ApplicationException(Exception, ISerializable, _Exception): - """ - The exception that is thrown when a non-fatal application error occurs. - - ApplicationException() - ApplicationException(message: str) - ApplicationException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class ApplicationId(object): - """ - Contains information used to uniquely identify a manifest-based application. This class cannot be inherited. - - ApplicationId(publicKeyToken: Array[Byte], name: str, version: Version, processorArchitecture: str, culture: str) - """ - def Copy(self): - # type: (self: ApplicationId) -> ApplicationId - """ - Copy(self: ApplicationId) -> ApplicationId - - Creates and returns an identical copy of the current application identity. - Returns: An System.ApplicationId object that represents an exact copy of the original. - """ - pass - - def Equals(self, o): - # type: (self: ApplicationId, o: object) -> bool - """ - Equals(self: ApplicationId, o: object) -> bool - - Determines whether the specified System.ApplicationId object is equivalent to the current System.ApplicationId. - - o: The System.ApplicationId object to compare to the current System.ApplicationId. - Returns: true if the specified System.ApplicationId object is equivalent to the current System.ApplicationId; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: ApplicationId) -> int - """ - GetHashCode(self: ApplicationId) -> int - - Gets the hash code for the current application identity. - Returns: The hash code for the current application identity. - """ - pass - - def ToString(self): - # type: (self: ApplicationId) -> str - """ - ToString(self: ApplicationId) -> str - - Creates and returns a string representation of the application identity. - Returns: A string representation of the application identity. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - @staticmethod # known case of __new__ - def __new__(self, publicKeyToken, name, version, processorArchitecture, culture): - """ __new__(cls: type, publicKeyToken: Array[Byte], name: str, version: Version, processorArchitecture: str, culture: str) """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - Culture = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a string representing the culture information for the application. - - Get: Culture(self: ApplicationId) -> str - """ - - Name = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the name of the application. - - Get: Name(self: ApplicationId) -> str - """ - - ProcessorArchitecture = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the target processor architecture for the application. - - Get: ProcessorArchitecture(self: ApplicationId) -> str - """ - - PublicKeyToken = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the public key token for the application. - - Get: PublicKeyToken(self: ApplicationId) -> Array[Byte] - """ - - Version = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the version of the application. - - Get: Version(self: ApplicationId) -> Version - """ - - - -class ApplicationIdentity(object, ISerializable): - """ - Provides the ability to uniquely identify a manifest-activated application. This class cannot be inherited. - - ApplicationIdentity(applicationIdentityFullName: str) - """ - def ToString(self): - # type: (self: ApplicationIdentity) -> str - """ - ToString(self: ApplicationIdentity) -> str - - Returns the full name of the manifest-activated application. - Returns: The full name of the manifest-activated application. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, applicationIdentityFullName): - """ __new__(cls: type, applicationIdentityFullName: str) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CodeBase = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the location of the deployment manifest as a URL. - - Get: CodeBase(self: ApplicationIdentity) -> str - """ - - FullName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the full name of the application. - - Get: FullName(self: ApplicationIdentity) -> str - """ - - - -class ArgIterator(object): - """ - Represents a variable-length argument list; that is, the parameters of a function that takes a variable number of arguments. - - ArgIterator(arglist: RuntimeArgumentHandle) - ArgIterator(arglist: RuntimeArgumentHandle, ptr: Void*) - """ - def End(self): - # type: (self: ArgIterator) - """ - End(self: ArgIterator) - Concludes processing of the variable-length argument list represented by this instance. - """ - pass - - def Equals(self, o): - # type: (self: ArgIterator, o: object) -> bool - """ - Equals(self: ArgIterator, o: object) -> bool - - This method is not supported, and always throws System.NotSupportedException. - - o: An object to be compared to this instance. - Returns: This comparison is not supported. No value is returned. - """ - pass - - def GetHashCode(self): - # type: (self: ArgIterator) -> int - """ - GetHashCode(self: ArgIterator) -> int - - Returns the hash code of this object. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetNextArg(self, rth=None): - # type: (self: ArgIterator) -> TypedReference - """ - GetNextArg(self: ArgIterator) -> TypedReference - - Returns the next argument in a variable-length argument list. - Returns: The next argument as a System.TypedReference object. - GetNextArg(self: ArgIterator, rth: RuntimeTypeHandle) -> TypedReference - - Returns the next argument in a variable-length argument list that has a specified type. - - rth: A runtime type handle that identifies the type of the argument to retrieve. - Returns: The next argument as a System.TypedReference object. - """ - pass - - def GetNextArgType(self): - # type: (self: ArgIterator) -> RuntimeTypeHandle - """ - GetNextArgType(self: ArgIterator) -> RuntimeTypeHandle - - Returns the type of the next argument. - Returns: The type of the next argument. - """ - pass - - def GetRemainingCount(self): - # type: (self: ArgIterator) -> int - """ - GetRemainingCount(self: ArgIterator) -> int - - Returns the number of arguments remaining in the argument list. - Returns: The number of remaining arguments. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - @staticmethod # known case of __new__ - def __new__(self, arglist, ptr=None): - """ - __new__(cls: type, arglist: RuntimeArgumentHandle) - __new__(cls: type, arglist: RuntimeArgumentHandle, ptr: Void*) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - -class ArgumentException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when one of the arguments provided to a method is not valid. - - ArgumentException() - ArgumentException(message: str) - ArgumentException(message: str, innerException: Exception) - ArgumentException(message: str, paramName: str, innerException: Exception) - ArgumentException(message: str, paramName: str) - """ - def GetObjectData(self, info, context): - # type: (self: ArgumentException, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: ArgumentException, info: SerializationInfo, context: StreamingContext) - Sets the System.Runtime.Serialization.SerializationInfo object with the parameter name and additional exception information. - - info: The object that holds the serialized object data. - context: The contextual information about the source or destination. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, *__args): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, message: str, paramName: str, innerException: Exception) - __new__(cls: type, message: str, paramName: str) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Message = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the error message and the parameter name, or only the error message if no parameter name is set. - - Get: Message(self: ArgumentException) -> str - """ - - ParamName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the name of the parameter that causes this exception. - - Get: ParamName(self: ArgumentException) -> str - """ - - - SerializeObjectState = None - - -class ArgumentNullException(ArgumentException, ISerializable, _Exception): - # type: (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument. - """ - The exception that is thrown when a null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument. - - ArgumentNullException() - ArgumentNullException(paramName: str) - ArgumentNullException(message: str, innerException: Exception) - ArgumentNullException(paramName: str, message: str) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, paramName: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, paramName: str, message: str) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class ArgumentOutOfRangeException(ArgumentException, ISerializable, _Exception): - """ - The exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method. - - ArgumentOutOfRangeException() - ArgumentOutOfRangeException(paramName: str) - ArgumentOutOfRangeException(paramName: str, message: str) - ArgumentOutOfRangeException(message: str, innerException: Exception) - ArgumentOutOfRangeException(paramName: str, actualValue: object, message: str) - """ - def GetObjectData(self, info, context): - # type: (self: ArgumentOutOfRangeException, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: ArgumentOutOfRangeException, info: SerializationInfo, context: StreamingContext) - Sets the System.Runtime.Serialization.SerializationInfo object with the invalid argument value and additional exception information. - - info: The object that holds the serialized object data. - context: An object that describes the source or destination of the serialized data. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, paramName: str) - __new__(cls: type, paramName: str, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, paramName: str, actualValue: object, message: str) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ActualValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the argument value that causes this exception. - - Get: ActualValue(self: ArgumentOutOfRangeException) -> object - """ - - Message = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the error message and the string representation of the invalid argument value, or only the error message if the argument value is null. - - Get: Message(self: ArgumentOutOfRangeException) -> str - """ - - - SerializeObjectState = None - - -class ArithmeticException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown for errors in an arithmetic, casting, or conversion operation. - - ArithmeticException() - ArithmeticException(message: str) - ArithmeticException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class ICloneable: - """ Supports cloning, which creates a new instance of a class with the same value as an existing instance. """ - def Clone(self): - # type: (self: ICloneable) -> object - """ - Clone(self: ICloneable) -> object - - Creates a new object that is a copy of the current instance. - Returns: A new object that is a copy of this instance. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class Array(object, ICloneable, IList, ICollection, IEnumerable, IStructuralComparable, IStructuralEquatable): - """ Provides methods for creating, manipulating, searching, and sorting arrays, thereby serving as the base class for all arrays in the common language runtime. """ - @staticmethod - def AsReadOnly(array): - # type: (array: Array[T]) -> ReadOnlyCollection[T] - """ AsReadOnly[T](array: Array[T]) -> ReadOnlyCollection[T] """ - pass - - @staticmethod - def BinarySearch(array, *__args): - # type: (array: Array, value: object) -> int - """ - BinarySearch(array: Array, value: object) -> int - - Searches an entire one-dimensional sorted System.Array for a specific element, using the System.IComparable interface implemented by each element of the System.Array and by the specified object. - - array: The sorted one-dimensional System.Array to search. - value: The object to search for. - Returns: The index of the specified value in the specified array, if value is found. If value is not found and value is less than one or more elements in array, a negative number which is the bitwise complement of the index of the first element that is larger - than value. If value is not found and value is greater than any of the elements in array, a negative number which is the bitwise complement of (the index of the last element plus 1). - - BinarySearch(array: Array, index: int, length: int, value: object) -> int - - Searches a range of elements in a one-dimensional sorted System.Array for a value, using the System.IComparable interface implemented by each element of the System.Array and by the specified value. - - array: The sorted one-dimensional System.Array to search. - index: The starting index of the range to search. - length: The length of the range to search. - value: The object to search for. - Returns: The index of the specified value in the specified array, if value is found. If value is not found and value is less than one or more elements in array, a negative number which is the bitwise complement of the index of the first element that is larger - than value. If value is not found and value is greater than any of the elements in array, a negative number which is the bitwise complement of (the index of the last element plus 1). - - BinarySearch(array: Array, value: object, comparer: IComparer) -> int - - Searches an entire one-dimensional sorted System.Array for a value using the specified System.Collections.IComparer interface. - - array: The sorted one-dimensional System.Array to search. - value: The object to search for. - comparer: The System.Collections.IComparer implementation to use when comparing elements.-or- null to use the System.IComparable implementation of each element. - Returns: The index of the specified value in the specified array, if value is found. If value is not found and value is less than one or more elements in array, a negative number which is the bitwise complement of the index of the first element that is larger - than value. If value is not found and value is greater than any of the elements in array, a negative number which is the bitwise complement of (the index of the last element plus 1). - - BinarySearch(array: Array, index: int, length: int, value: object, comparer: IComparer) -> int - - Searches a range of elements in a one-dimensional sorted System.Array for a value, using the specified System.Collections.IComparer interface. - - array: The sorted one-dimensional System.Array to search. - index: The starting index of the range to search. - length: The length of the range to search. - value: The object to search for. - comparer: The System.Collections.IComparer implementation to use when comparing elements.-or- null to use the System.IComparable implementation of each element. - Returns: The index of the specified value in the specified array, if value is found. If value is not found and value is less than one or more elements in array, a negative number which is the bitwise complement of the index of the first element that is larger - than value. If value is not found and value is greater than any of the elements in array, a negative number which is the bitwise complement of (the index of the last element plus 1). - - BinarySearch[T](array: Array[T], value: T) -> int - BinarySearch[T](array: Array[T], value: T, comparer: IComparer[T]) -> int - BinarySearch[T](array: Array[T], index: int, length: int, value: T) -> int - BinarySearch[T](array: Array[T], index: int, length: int, value: T, comparer: IComparer[T]) -> int - """ - pass - - @staticmethod - def Clear(array, index, length): - # type: (array: Array, index: int, length: int) - """ - Clear(array: Array, index: int, length: int) - Sets a range of elements in the System.Array to zero, to false, or to null, depending on the element type. - - array: The System.Array whose elements need to be cleared. - index: The starting index of the range of elements to clear. - length: The number of elements to clear. - """ - pass - - def Clone(self): - # type: (self: Array) -> object - """ - Clone(self: Array) -> object - - Creates a shallow copy of the System.Array. - Returns: A shallow copy of the System.Array. - """ - pass - - @staticmethod - def ConstrainedCopy(sourceArray, sourceIndex, destinationArray, destinationIndex, length): - # type: (sourceArray: Array, sourceIndex: int, destinationArray: Array, destinationIndex: int, length: int) - """ - ConstrainedCopy(sourceArray: Array, sourceIndex: int, destinationArray: Array, destinationIndex: int, length: int) - Copies a range of elements from an System.Array starting at the specified source index and pastes them to another System.Array starting at the specified destination index. Guarantees that all changes are undone if the copy does not succeed completely. - - sourceArray: The System.Array that contains the data to copy. - sourceIndex: A 32-bit integer that represents the index in the sourceArray at which copying begins. - destinationArray: The System.Array that receives the data. - destinationIndex: A 32-bit integer that represents the index in the destinationArray at which storing begins. - length: A 32-bit integer that represents the number of elements to copy. - """ - pass - - @staticmethod - def ConvertAll(array, converter): - # type: (TInput, TOutput)](array: Array[TInput], converter: Converter[TInput, TOutput]) -> Array[TOutput] - """ ConvertAll[(TInput, TOutput)](array: Array[TInput], converter: Converter[TInput, TOutput]) -> Array[TOutput] """ - pass - - @staticmethod - def Copy(sourceArray, *__args): - # type: (sourceArray: Array, destinationArray: Array, length: int) - """ - Copy(sourceArray: Array, destinationArray: Array, length: int) - Copies a range of elements from an System.Array starting at the first element and pastes them into another System.Array starting at the first element. The length is specified as a 32-bit integer. - - sourceArray: The System.Array that contains the data to copy. - destinationArray: The System.Array that receives the data. - length: A 32-bit integer that represents the number of elements to copy. - Copy(sourceArray: Array, sourceIndex: int, destinationArray: Array, destinationIndex: int, length: int) - Copies a range of elements from an System.Array starting at the specified source index and pastes them to another System.Array starting at the specified destination index. The length and the indexes are specified as 32-bit integers. - - sourceArray: The System.Array that contains the data to copy. - sourceIndex: A 32-bit integer that represents the index in the sourceArray at which copying begins. - destinationArray: The System.Array that receives the data. - destinationIndex: A 32-bit integer that represents the index in the destinationArray at which storing begins. - length: A 32-bit integer that represents the number of elements to copy. - Copy(sourceArray: Array, destinationArray: Array, length: Int64) - Copies a range of elements from an System.Array starting at the first element and pastes them into another System.Array starting at the first element. The length is specified as a 64-bit integer. - - sourceArray: The System.Array that contains the data to copy. - destinationArray: The System.Array that receives the data. - length: A 64-bit integer that represents the number of elements to copy. The integer must be between zero and System.Int32.MaxValue, inclusive. - Copy(sourceArray: Array, sourceIndex: Int64, destinationArray: Array, destinationIndex: Int64, length: Int64) - Copies a range of elements from an System.Array starting at the specified source index and pastes them to another System.Array starting at the specified destination index. The length and the indexes are specified as 64-bit integers. - - sourceArray: The System.Array that contains the data to copy. - sourceIndex: A 64-bit integer that represents the index in the sourceArray at which copying begins. - destinationArray: The System.Array that receives the data. - destinationIndex: A 64-bit integer that represents the index in the destinationArray at which storing begins. - length: A 64-bit integer that represents the number of elements to copy. The integer must be between zero and System.Int32.MaxValue, inclusive. - """ - pass - - def CopyTo(self, array, index): - # type: (self: Array, array: Array, index: int) - """ - CopyTo(self: Array, array: Array, index: int) - Copies all the elements of the current one-dimensional System.Array to the specified one-dimensional System.Array starting at the specified destination System.Array index. The index is specified as a 32-bit integer. - - array: The one-dimensional System.Array that is the destination of the elements copied from the current System.Array. - index: A 32-bit integer that represents the index in array at which copying begins. - CopyTo(self: Array, array: Array, index: Int64) - Copies all the elements of the current one-dimensional System.Array to the specified one-dimensional System.Array starting at the specified destination System.Array index. The index is specified as a 64-bit integer. - - array: The one-dimensional System.Array that is the destination of the elements copied from the current System.Array. - index: A 64-bit integer that represents the index in array at which copying begins. - """ - pass - - @staticmethod - def CreateInstance(elementType, *__args): - # type: (elementType: Type, length: int) -> Array - """ - CreateInstance(elementType: Type, length: int) -> Array - - Creates a one-dimensional System.Array of the specified System.Type and length, with zero-based indexing. - - elementType: The System.Type of the System.Array to create. - length: The size of the System.Array to create. - Returns: A new one-dimensional System.Array of the specified System.Type with the specified length, using zero-based indexing. - CreateInstance(elementType: Type, length1: int, length2: int) -> Array - - Creates a two-dimensional System.Array of the specified System.Type and dimension lengths, with zero-based indexing. - - elementType: The System.Type of the System.Array to create. - length1: The size of the first dimension of the System.Array to create. - length2: The size of the second dimension of the System.Array to create. - Returns: A new two-dimensional System.Array of the specified System.Type with the specified length for each dimension, using zero-based indexing. - CreateInstance(elementType: Type, length1: int, length2: int, length3: int) -> Array - - Creates a three-dimensional System.Array of the specified System.Type and dimension lengths, with zero-based indexing. - - elementType: The System.Type of the System.Array to create. - length1: The size of the first dimension of the System.Array to create. - length2: The size of the second dimension of the System.Array to create. - length3: The size of the third dimension of the System.Array to create. - Returns: A new three-dimensional System.Array of the specified System.Type with the specified length for each dimension, using zero-based indexing. - CreateInstance(elementType: Type, *lengths: Array[int]) -> Array - - Creates a multidimensional System.Array of the specified System.Type and dimension lengths, with zero-based indexing. The dimension lengths are specified in an array of 32-bit integers. - - elementType: The System.Type of the System.Array to create. - lengths: An array of 32-bit integers that represent the size of each dimension of the System.Array to create. - Returns: A new multidimensional System.Array of the specified System.Type with the specified length for each dimension, using zero-based indexing. - CreateInstance(elementType: Type, *lengths: Array[Int64]) -> Array - - Creates a multidimensional System.Array of the specified System.Type and dimension lengths, with zero-based indexing. The dimension lengths are specified in an array of 64-bit integers. - - elementType: The System.Type of the System.Array to create. - lengths: An array of 64-bit integers that represent the size of each dimension of the System.Array to create. Each integer in the array must be between zero and System.Int32.MaxValue, inclusive. - Returns: A new multidimensional System.Array of the specified System.Type with the specified length for each dimension, using zero-based indexing. - CreateInstance(elementType: Type, lengths: Array[int], lowerBounds: Array[int]) -> Array - - Creates a multidimensional System.Array of the specified System.Type and dimension lengths, with the specified lower bounds. - - elementType: The System.Type of the System.Array to create. - lengths: A one-dimensional array that contains the size of each dimension of the System.Array to create. - lowerBounds: A one-dimensional array that contains the lower bound (starting index) of each dimension of the System.Array to create. - Returns: A new multidimensional System.Array of the specified System.Type with the specified length and lower bound for each dimension. - """ - pass - - @staticmethod - def Empty(): - # type: () -> Array[T] - """ Empty[T]() -> Array[T] """ - pass - - @staticmethod - def Exists(array, match): - # type: (array: Array[T], match: Predicate[T]) -> bool - """ Exists[T](array: Array[T], match: Predicate[T]) -> bool """ - pass - - @staticmethod - def Find(array, match): - # type: (array: Array[T], match: Predicate[T]) -> T - """ Find[T](array: Array[T], match: Predicate[T]) -> T """ - pass - - @staticmethod - def FindAll(array, match): - # type: (array: Array[T], match: Predicate[T]) -> Array[T] - """ FindAll[T](array: Array[T], match: Predicate[T]) -> Array[T] """ - pass - - @staticmethod - def FindIndex(array, *__args): - # type: (array: Array[T], match: Predicate[T]) -> int - """ - FindIndex[T](array: Array[T], match: Predicate[T]) -> int - FindIndex[T](array: Array[T], startIndex: int, match: Predicate[T]) -> int - FindIndex[T](array: Array[T], startIndex: int, count: int, match: Predicate[T]) -> int - """ - pass - - @staticmethod - def FindLast(array, match): - # type: (array: Array[T], match: Predicate[T]) -> T - """ FindLast[T](array: Array[T], match: Predicate[T]) -> T """ - pass - - @staticmethod - def FindLastIndex(array, *__args): - # type: (array: Array[T], match: Predicate[T]) -> int - """ - FindLastIndex[T](array: Array[T], match: Predicate[T]) -> int - FindLastIndex[T](array: Array[T], startIndex: int, match: Predicate[T]) -> int - FindLastIndex[T](array: Array[T], startIndex: int, count: int, match: Predicate[T]) -> int - """ - pass - - @staticmethod - def ForEach(array, action): - # type: (array: Array[T], action: Action[T]) - """ ForEach[T](array: Array[T], action: Action[T]) """ - pass - - def GetEnumerator(self): - # type: (self: Array) -> IEnumerator - """ - GetEnumerator(self: Array) -> IEnumerator - - Returns an System.Collections.IEnumerator for the System.Array. - Returns: An System.Collections.IEnumerator for the System.Array. - """ - pass - - def GetLength(self, dimension): - # type: (self: Array, dimension: int) -> int - """ - GetLength(self: Array, dimension: int) -> int - - Gets a 32-bit integer that represents the number of elements in the specified dimension of the System.Array. - - dimension: A zero-based dimension of the System.Array whose length needs to be determined. - Returns: A 32-bit integer that represents the number of elements in the specified dimension. - """ - pass - - def GetLongLength(self, dimension): - # type: (self: Array, dimension: int) -> Int64 - """ - GetLongLength(self: Array, dimension: int) -> Int64 - - Gets a 64-bit integer that represents the number of elements in the specified dimension of the System.Array. - - dimension: A zero-based dimension of the System.Array whose length needs to be determined. - Returns: A 64-bit integer that represents the number of elements in the specified dimension. - """ - pass - - def GetLowerBound(self, dimension): - # type: (self: Array, dimension: int) -> int - """ - GetLowerBound(self: Array, dimension: int) -> int - - Gets the lower bound of the specified dimension in the System.Array. - - dimension: A zero-based dimension of the System.Array whose lower bound needs to be determined. - Returns: The lower bound of the specified dimension in the System.Array. - """ - pass - - def GetUpperBound(self, dimension): - # type: (self: Array, dimension: int) -> int - """ - GetUpperBound(self: Array, dimension: int) -> int - - Gets the upper bound of the specified dimension in the System.Array. - - dimension: A zero-based dimension of the System.Array whose upper bound needs to be determined. - Returns: The upper bound of the specified dimension in the System.Array. - """ - pass - - def GetValue(self, *__args): - # type: (self: Array, *indices: Array[int]) -> object - """ - GetValue(self: Array, *indices: Array[int]) -> object - - Gets the value at the specified position in the multidimensional System.Array. The indexes are specified as an array of 32-bit integers. - - indices: A one-dimensional array of 32-bit integers that represent the indexes specifying the position of the System.Array element to get. - Returns: The value at the specified position in the multidimensional System.Array. - GetValue(self: Array, index: int) -> object - - Gets the value at the specified position in the one-dimensional System.Array. The index is specified as a 32-bit integer. - - index: A 32-bit integer that represents the position of the System.Array element to get. - Returns: The value at the specified position in the one-dimensional System.Array. - GetValue(self: Array, index1: int, index2: int) -> object - - Gets the value at the specified position in the two-dimensional System.Array. The indexes are specified as 32-bit integers. - - index1: A 32-bit integer that represents the first-dimension index of the System.Array element to get. - index2: A 32-bit integer that represents the second-dimension index of the System.Array element to get. - Returns: The value at the specified position in the two-dimensional System.Array. - GetValue(self: Array, index1: int, index2: int, index3: int) -> object - - Gets the value at the specified position in the three-dimensional System.Array. The indexes are specified as 32-bit integers. - - index1: A 32-bit integer that represents the first-dimension index of the System.Array element to get. - index2: A 32-bit integer that represents the second-dimension index of the System.Array element to get. - index3: A 32-bit integer that represents the third-dimension index of the System.Array element to get. - Returns: The value at the specified position in the three-dimensional System.Array. - GetValue(self: Array, index: Int64) -> object - - Gets the value at the specified position in the one-dimensional System.Array. The index is specified as a 64-bit integer. - - index: A 64-bit integer that represents the position of the System.Array element to get. - Returns: The value at the specified position in the one-dimensional System.Array. - GetValue(self: Array, index1: Int64, index2: Int64) -> object - - Gets the value at the specified position in the two-dimensional System.Array. The indexes are specified as 64-bit integers. - - index1: A 64-bit integer that represents the first-dimension index of the System.Array element to get. - index2: A 64-bit integer that represents the second-dimension index of the System.Array element to get. - Returns: The value at the specified position in the two-dimensional System.Array. - GetValue(self: Array, index1: Int64, index2: Int64, index3: Int64) -> object - - Gets the value at the specified position in the three-dimensional System.Array. The indexes are specified as 64-bit integers. - - index1: A 64-bit integer that represents the first-dimension index of the System.Array element to get. - index2: A 64-bit integer that represents the second-dimension index of the System.Array element to get. - index3: A 64-bit integer that represents the third-dimension index of the System.Array element to get. - Returns: The value at the specified position in the three-dimensional System.Array. - GetValue(self: Array, *indices: Array[Int64]) -> object - - Gets the value at the specified position in the multidimensional System.Array. The indexes are specified as an array of 64-bit integers. - - indices: A one-dimensional array of 64-bit integers that represent the indexes specifying the position of the System.Array element to get. - Returns: The value at the specified position in the multidimensional System.Array. - """ - pass - - @staticmethod - def IndexOf(array, value, startIndex=None, count=None): - # type: (array: Array, value: object) -> int - """ - IndexOf(array: Array, value: object) -> int - - Searches for the specified object and returns the index of the first occurrence within the entire one-dimensional System.Array. - - array: The one-dimensional System.Array to search. - value: The object to locate in array. - Returns: The index of the first occurrence of value within the entire array, if found; otherwise, the lower bound of the array minus 1. - IndexOf(array: Array, value: object, startIndex: int) -> int - - Searches for the specified object and returns the index of the first occurrence within the range of elements in the one-dimensional System.Array that extends from the specified index to the last element. - - array: The one-dimensional System.Array to search. - value: The object to locate in array. - startIndex: The starting index of the search. 0 (zero) is valid in an empty array. - Returns: The index of the first occurrence of value within the range of elements in array that extends from startIndex to the last element, if found; otherwise, the lower bound of the array minus 1. - IndexOf(array: Array, value: object, startIndex: int, count: int) -> int - - Searches for the specified object and returns the index of the first occurrence within the range of elements in the one-dimensional System.Array that starts at the specified index and contains the specified number of elements. - - array: The one-dimensional System.Array to search. - value: The object to locate in array. - startIndex: The starting index of the search. 0 (zero) is valid in an empty array. - count: The number of elements in the section to search. - Returns: The index of the first occurrence of value within the range of elements in array that starts at startIndex and contains the number of elements specified in count, if found; otherwise, the lower bound of the array minus 1. - IndexOf[T](array: Array[T], value: T) -> int - IndexOf[T](array: Array[T], value: T, startIndex: int) -> int - IndexOf[T](array: Array[T], value: T, startIndex: int, count: int) -> int - """ - pass - - def Initialize(self): - # type: (self: Array) - """ - Initialize(self: Array) - Initializes every element of the value-type System.Array by calling the default constructor of the value type. - """ - pass - - @staticmethod - def LastIndexOf(array, value, startIndex=None, count=None): - # type: (array: Array, value: object) -> int - """ - LastIndexOf(array: Array, value: object) -> int - - Searches for the specified object and returns the index of the last occurrence within the entire one-dimensional System.Array. - - array: The one-dimensional System.Array to search. - value: The object to locate in array. - Returns: The index of the last occurrence of value within the entire array, if found; otherwise, the lower bound of the array minus 1. - LastIndexOf(array: Array, value: object, startIndex: int) -> int - - Searches for the specified object and returns the index of the last occurrence within the range of elements in the one-dimensional System.Array that extends from the first element to the specified index. - - array: The one-dimensional System.Array to search. - value: The object to locate in array. - startIndex: The starting index of the backward search. - Returns: The index of the last occurrence of value within the range of elements in array that extends from the first element to startIndex, if found; otherwise, the lower bound of the array minus 1. - LastIndexOf(array: Array, value: object, startIndex: int, count: int) -> int - - Searches for the specified object and returns the index of the last occurrence within the range of elements in the one-dimensional System.Array that contains the specified number of elements and ends at the specified index. - - array: The one-dimensional System.Array to search. - value: The object to locate in array. - startIndex: The starting index of the backward search. - count: The number of elements in the section to search. - Returns: The index of the last occurrence of value within the range of elements in array that contains the number of elements specified in count and ends at startIndex, if found; otherwise, the lower bound of the array minus 1. - LastIndexOf[T](array: Array[T], value: T) -> int - LastIndexOf[T](array: Array[T], value: T, startIndex: int) -> int - LastIndexOf[T](array: Array[T], value: T, startIndex: int, count: int) -> int - """ - pass - - @staticmethod - def Resize(array, newSize): - # type: (array: Array[T], newSize: int) -> Array[T] - """ Resize[T](array: Array[T], newSize: int) -> Array[T] """ - pass - - @staticmethod - def Reverse(array, index=None, length=None): - # type: (array: Array) - """ - Reverse(array: Array) - Reverses the sequence of the elements in the entire one-dimensional System.Array. - - array: The one-dimensional System.Array to reverse. - Reverse(array: Array, index: int, length: int) - Reverses the sequence of the elements in a range of elements in the one-dimensional System.Array. - - array: The one-dimensional System.Array to reverse. - index: The starting index of the section to reverse. - length: The number of elements in the section to reverse. - """ - pass - - def SetValue(self, value, *__args): - # type: (self: Array, value: object, index: int) - """ - SetValue(self: Array, value: object, index: int) - Sets a value to the element at the specified position in the one-dimensional System.Array. The index is specified as a 32-bit integer. - - value: The new value for the specified element. - index: A 32-bit integer that represents the position of the System.Array element to set. - SetValue(self: Array, value: object, index1: int, index2: int) - Sets a value to the element at the specified position in the two-dimensional System.Array. The indexes are specified as 32-bit integers. - - value: The new value for the specified element. - index1: A 32-bit integer that represents the first-dimension index of the System.Array element to set. - index2: A 32-bit integer that represents the second-dimension index of the System.Array element to set. - SetValue(self: Array, value: object, index1: int, index2: int, index3: int) - Sets a value to the element at the specified position in the three-dimensional System.Array. The indexes are specified as 32-bit integers. - - value: The new value for the specified element. - index1: A 32-bit integer that represents the first-dimension index of the System.Array element to set. - index2: A 32-bit integer that represents the second-dimension index of the System.Array element to set. - index3: A 32-bit integer that represents the third-dimension index of the System.Array element to set. - SetValue(self: Array, value: object, *indices: Array[int]) - Sets a value to the element at the specified position in the multidimensional System.Array. The indexes are specified as an array of 32-bit integers. - - value: The new value for the specified element. - indices: A one-dimensional array of 32-bit integers that represent the indexes specifying the position of the element to set. - SetValue(self: Array, value: object, index: Int64) - Sets a value to the element at the specified position in the one-dimensional System.Array. The index is specified as a 64-bit integer. - - value: The new value for the specified element. - index: A 64-bit integer that represents the position of the System.Array element to set. - SetValue(self: Array, value: object, index1: Int64, index2: Int64) - Sets a value to the element at the specified position in the two-dimensional System.Array. The indexes are specified as 64-bit integers. - - value: The new value for the specified element. - index1: A 64-bit integer that represents the first-dimension index of the System.Array element to set. - index2: A 64-bit integer that represents the second-dimension index of the System.Array element to set. - SetValue(self: Array, value: object, index1: Int64, index2: Int64, index3: Int64) - Sets a value to the element at the specified position in the three-dimensional System.Array. The indexes are specified as 64-bit integers. - - value: The new value for the specified element. - index1: A 64-bit integer that represents the first-dimension index of the System.Array element to set. - index2: A 64-bit integer that represents the second-dimension index of the System.Array element to set. - index3: A 64-bit integer that represents the third-dimension index of the System.Array element to set. - SetValue(self: Array, value: object, *indices: Array[Int64]) - Sets a value to the element at the specified position in the multidimensional System.Array. The indexes are specified as an array of 64-bit integers. - - value: The new value for the specified element. - indices: A one-dimensional array of 64-bit integers that represent the indexes specifying the position of the element to set. - """ - pass - - @staticmethod - def Sort(*__args): - # type: (array: Array) - """ - Sort(array: Array) - Sorts the elements in an entire one-dimensional System.Array using the System.IComparable implementation of each element of the System.Array. - - array: The one-dimensional System.Array to sort. - Sort[T](array: Array[T], index: int, length: int, comparer: IComparer[T])Sort[(TKey, TValue)](keys: Array[TKey], items: Array[TValue], comparer: IComparer[TKey])Sort[T](array: Array[T], comparer: IComparer[T])Sort[(TKey, TValue)](keys: Array[TKey], items: Array[TValue], index: int, length: int)Sort[T](array: Array[T], index: int, length: int)Sort[(TKey, TValue)](keys: Array[TKey], items: Array[TValue])Sort[(TKey, TValue)](keys: Array[TKey], items: Array[TValue], index: int, length: int, comparer: IComparer[TKey])Sort[T](array: Array[T])Sort(array: Array, index: int, length: int, comparer: IComparer) - Sorts the elements in a range of elements in a one-dimensional System.Array using the specified System.Collections.IComparer. - - array: The one-dimensional System.Array to sort. - index: The starting index of the range to sort. - length: The number of elements in the range to sort. - comparer: The System.Collections.IComparer implementation to use when comparing elements.-or-null to use the System.IComparable implementation of each element. - Sort(keys: Array, items: Array, comparer: IComparer) - Sorts a pair of one-dimensional System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the specified System.Collections.IComparer. - - keys: The one-dimensional System.Array that contains the keys to sort. - items: The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array.-or-null to sort only the keysSystem.Array. - comparer: The System.Collections.IComparer implementation to use when comparing elements.-or-null to use the System.IComparable implementation of each element. - Sort(array: Array, comparer: IComparer) - Sorts the elements in a one-dimensional System.Array using the specified System.Collections.IComparer. - - array: The one-dimensional System.Array to sort. - comparer: The System.Collections.IComparer implementation to use when comparing elements.-or-null to use the System.IComparable implementation of each element. - Sort(keys: Array, items: Array, index: int, length: int) - Sorts a range of elements in a pair of one-dimensional System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the System.IComparable implementation of each key. - - keys: The one-dimensional System.Array that contains the keys to sort. - items: The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array.-or-null to sort only the keysSystem.Array. - index: The starting index of the range to sort. - length: The number of elements in the range to sort. - Sort(array: Array, index: int, length: int) - Sorts the elements in a range of elements in a one-dimensional System.Array using the System.IComparable implementation of each element of the System.Array. - - array: The one-dimensional System.Array to sort. - index: The starting index of the range to sort. - length: The number of elements in the range to sort. - Sort(keys: Array, items: Array) - Sorts a pair of one-dimensional System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the System.IComparable implementation of each key. - - keys: The one-dimensional System.Array that contains the keys to sort. - items: The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array.-or-null to sort only the keysSystem.Array. - Sort(keys: Array, items: Array, index: int, length: int, comparer: IComparer) - Sorts a range of elements in a pair of one-dimensional System.Array objects (one contains the keys and the other contains the corresponding items) based on the keys in the first System.Array using the specified System.Collections.IComparer. - - keys: The one-dimensional System.Array that contains the keys to sort. - items: The one-dimensional System.Array that contains the items that correspond to each of the keys in the keysSystem.Array.-or-null to sort only the keysSystem.Array. - index: The starting index of the range to sort. - length: The number of elements in the range to sort. - comparer: The System.Collections.IComparer implementation to use when comparing elements.-or-null to use the System.IComparable implementation of each element. - Sort[T](array: Array[T], comparison: Comparison[T]) - """ - pass - - @staticmethod - def TrueForAll(array, match): - # type: (array: Array[T], match: Predicate[T]) -> bool - """ TrueForAll[T](array: Array[T], match: Predicate[T]) -> bool """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: IList, value: object) -> bool - - Determines whether the System.Collections.IList contains a specific value. - - value: The object to locate in the System.Collections.IList. - Returns: true if the System.Object is found in the System.Collections.IList; otherwise, false. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y]x.__getitem__(y) <==> x[y]x.__getitem__(y) <==> x[y]x.__getitem__(y) <==> x[y] """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*y """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(pythonType: type, items: ICollection) -> object - __new__(pythonType: type, items: object) -> object - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __radd__(self, *args): #cannot find CLR method - """ __radd__(data1: Array, data2: Array) -> Array """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: Array) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]=x.__setitem__(i, y) <==> x[i]=x.__setitem__(i, y) <==> x[i]= """ - pass - - IsFixedSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Array has a fixed size. - - Get: IsFixedSize(self: Array) -> bool - """ - - IsReadOnly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Array is read-only. - - Get: IsReadOnly(self: Array) -> bool - """ - - IsSynchronized = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (thread safe). - """ - Gets a value indicating whether access to the System.Array is synchronized (thread safe). - - Get: IsSynchronized(self: Array) -> bool - """ - - Length = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a 32-bit integer that represents the total number of elements in all the dimensions of the System.Array. - - Get: Length(self: Array) -> int - """ - - LongLength = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a 64-bit integer that represents the total number of elements in all the dimensions of the System.Array. - - Get: LongLength(self: Array) -> Int64 - """ - - Rank = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (number of dimensions) of the System.Array. - """ - Gets the rank (number of dimensions) of the System.Array. - - Get: Rank(self: Array) -> int - """ - - SyncRoot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an object that can be used to synchronize access to the System.Array. - - Get: SyncRoot(self: Array) -> object - """ - - - -class ArraySegment(object, IList[T], ICollection[T], IEnumerable[T], IEnumerable, IReadOnlyList[T], IReadOnlyCollection[T]): - # type: (array: Array[T]) - """ - ArraySegment[T](array: Array[T]) - ArraySegment[T](array: Array[T], offset: int, count: int) - """ - def Equals(self, obj): - # type: (self: ArraySegment[T], obj: object) -> bool - """ - Equals(self: ArraySegment[T], obj: object) -> bool - - Determines whether the specified object is equal to the current instance. - - obj: The object to be compared with the current instance. - Returns: true if the specified object is a System.ArraySegment structure and is equal to the current instance; otherwise, false. - Equals(self: ArraySegment[T], obj: ArraySegment[T]) -> bool - - Determines whether the specified System.ArraySegment structure is equal to the current instance. - - obj: The System.ArraySegment structure to be compared with the current instance. - Returns: true if the specified System.ArraySegment structure is equal to the current instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: ArraySegment[T]) -> int - """ - GetHashCode(self: ArraySegment[T]) -> int - - Returns the hash code for the current instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: ICollection[T], item: T) -> bool - - Determines whether the System.Collections.Generic.ICollection contains a specific value. - - item: The object to locate in the System.Collections.Generic.ICollection. - Returns: true if item is found in the System.Collections.Generic.ICollection; otherwise, false. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, array, offset=None, count=None): - """ - __new__[ArraySegment`1]() -> ArraySegment[T] - - __new__(cls: type, array: Array[T]) - __new__(cls: type, array: Array[T], offset: int, count: int) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Array = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the original array containing the range of elements that the array segment delimits. - - Get: Array(self: ArraySegment[T]) -> Array[T] - """ - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of elements in the range delimited by the array segment. - - Get: Count(self: ArraySegment[T]) -> int - """ - - Offset = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the position of the first element in the range delimited by the array segment, relative to the start of the original array. - - Get: Offset(self: ArraySegment[T]) -> int - """ - - - -class ArrayTypeMismatchException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when an attempt is made to store an element of the wrong type within an array. - - ArrayTypeMismatchException() - ArrayTypeMismatchException(message: str) - ArrayTypeMismatchException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class EventArgs(object): - """ - System.EventArgs is the base class for classes containing event data. - - EventArgs() - """ - Empty = None - - -class AssemblyLoadEventArgs(EventArgs): - """ - Provides data for the System.AppDomain.AssemblyLoad event. - - AssemblyLoadEventArgs(loadedAssembly: Assembly) - """ - @staticmethod # known case of __new__ - def __new__(self, loadedAssembly): - """ __new__(cls: type, loadedAssembly: Assembly) """ - pass - - LoadedAssembly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an System.Reflection.Assembly that represents the currently loaded assembly. - - Get: LoadedAssembly(self: AssemblyLoadEventArgs) -> Assembly - """ - - - -class AssemblyLoadEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that handles the System.AppDomain.AssemblyLoad event of an System.AppDomain. - - AssemblyLoadEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, args, callback, object): - # type: (self: AssemblyLoadEventHandler, sender: object, args: AssemblyLoadEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: AssemblyLoadEventHandler, sender: object, args: AssemblyLoadEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: AssemblyLoadEventHandler, result: IAsyncResult) - """ EndInvoke(self: AssemblyLoadEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, args): - # type: (self: AssemblyLoadEventHandler, sender: object, args: AssemblyLoadEventArgs) - """ Invoke(self: AssemblyLoadEventHandler, sender: object, args: AssemblyLoadEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class AsyncCallback(MulticastDelegate, ICloneable, ISerializable): - """ - References a method to be called when a corresponding asynchronous operation completes. - - AsyncCallback(object: object, method: IntPtr) - """ - def BeginInvoke(self, ar, callback, object): - # type: (self: AsyncCallback, ar: IAsyncResult, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: AsyncCallback, ar: IAsyncResult, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: AsyncCallback, result: IAsyncResult) - """ EndInvoke(self: AsyncCallback, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, ar): - # type: (self: AsyncCallback, ar: IAsyncResult) - """ Invoke(self: AsyncCallback, ar: IAsyncResult) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class Attribute(object, _Attribute): - """ Represents the base class for custom attributes. """ - def Equals(self, obj): - # type: (self: Attribute, obj: object) -> bool - """ - Equals(self: Attribute, obj: object) -> bool - - Returns a value that indicates whether this instance is equal to a specified object. - - obj: An System.Object to compare with this instance or null. - Returns: true if obj equals the type and value of this instance; otherwise, false. - """ - pass - - @staticmethod - def GetCustomAttribute(element, attributeType, inherit=None): - # type: (element: MemberInfo, attributeType: Type) -> Attribute - """ - GetCustomAttribute(element: MemberInfo, attributeType: Type) -> Attribute - - Retrieves a custom attribute applied to a member of a type. Parameters specify the member, and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class. - attributeType: The type, or a base type, of the custom attribute to search for. - Returns: A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute. - GetCustomAttribute(element: MemberInfo, attributeType: Type, inherit: bool) -> Attribute - - Retrieves a custom attribute applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member. - - element: An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class. - attributeType: The type, or a base type, of the custom attribute to search for. - inherit: If true, specifies to also search the ancestors of element for custom attributes. - Returns: A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute. - GetCustomAttribute(element: ParameterInfo, attributeType: Type) -> Attribute - - Retrieves a custom attribute applied to a method parameter. Parameters specify the method parameter, and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class. - attributeType: The type, or a base type, of the custom attribute to search for. - Returns: A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute. - GetCustomAttribute(element: ParameterInfo, attributeType: Type, inherit: bool) -> Attribute - - Retrieves a custom attribute applied to a method parameter. Parameters specify the method parameter, the type of the custom attribute to search for, and whether to search ancestors of the method parameter. - - element: An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class. - attributeType: The type, or a base type, of the custom attribute to search for. - inherit: If true, specifies to also search the ancestors of element for custom attributes. - Returns: A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute. - GetCustomAttribute(element: Module, attributeType: Type) -> Attribute - - Retrieves a custom attribute applied to a module. Parameters specify the module, and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.Module class that describes a portable executable file. - attributeType: The type, or a base type, of the custom attribute to search for. - Returns: A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute. - GetCustomAttribute(element: Module, attributeType: Type, inherit: bool) -> Attribute - - Retrieves a custom attribute applied to a module. Parameters specify the module, the type of the custom attribute to search for, and an ignored search option. - - element: An object derived from the System.Reflection.Module class that describes a portable executable file. - attributeType: The type, or a base type, of the custom attribute to search for. - inherit: This parameter is ignored, and does not affect the operation of this method. - Returns: A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute. - GetCustomAttribute(element: Assembly, attributeType: Type) -> Attribute - - Retrieves a custom attribute applied to a specified assembly. Parameters specify the assembly and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules. - attributeType: The type, or a base type, of the custom attribute to search for. - Returns: A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute. - GetCustomAttribute(element: Assembly, attributeType: Type, inherit: bool) -> Attribute - - Retrieves a custom attribute applied to an assembly. Parameters specify the assembly, the type of the custom attribute to search for, and an ignored search option. - - element: An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules. - attributeType: The type, or a base type, of the custom attribute to search for. - inherit: This parameter is ignored, and does not affect the operation of this method. - Returns: A reference to the single custom attribute of type attributeType that is applied to element, or null if there is no such attribute. - """ - pass - - @staticmethod - def GetCustomAttributes(element, *__args): - # type: (element: MemberInfo, type: Type) -> Array[Attribute] - """ - GetCustomAttributes(element: MemberInfo, type: Type) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a member of a type. Parameters specify the member, and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class. - type: The type, or a base type, of the custom attribute to search for. - Returns: An System.Attribute array that contains the custom attributes of type type applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: MemberInfo, type: Type, inherit: bool) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member. - - element: An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class. - type: The type, or a base type, of the custom attribute to search for. - inherit: If true, specifies to also search the ancestors of element for custom attributes. - Returns: An System.Attribute array that contains the custom attributes of type type applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: MemberInfo) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a member of a type. A parameter specifies the member. - - element: An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class. - Returns: An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: MemberInfo, inherit: bool) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member. - - element: An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, or property member of a class. - inherit: If true, specifies to also search the ancestors of element for custom attributes. - Returns: An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: ParameterInfo) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a method parameter. A parameter specifies the method parameter. - - element: An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class. - Returns: An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: ParameterInfo, attributeType: Type) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a method parameter. Parameters specify the method parameter, and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class. - attributeType: The type, or a base type, of the custom attribute to search for. - Returns: An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: ParameterInfo, attributeType: Type, inherit: bool) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a method parameter. Parameters specify the method parameter, the type of the custom attribute to search for, and whether to search ancestors of the method parameter. - - element: An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class. - attributeType: The type, or a base type, of the custom attribute to search for. - inherit: If true, specifies to also search the ancestors of element for custom attributes. - Returns: An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: ParameterInfo, inherit: bool) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a method parameter. Parameters specify the method parameter, and whether to search ancestors of the method parameter. - - element: An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class. - inherit: If true, specifies to also search the ancestors of element for custom attributes. - Returns: An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: Module, attributeType: Type) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a module. Parameters specify the module, and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.Module class that describes a portable executable file. - attributeType: The type, or a base type, of the custom attribute to search for. - Returns: An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: Module) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a module. A parameter specifies the module. - - element: An object derived from the System.Reflection.Module class that describes a portable executable file. - Returns: An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: Module, inherit: bool) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a module. Parameters specify the module, and an ignored search option. - - element: An object derived from the System.Reflection.Module class that describes a portable executable file. - inherit: This parameter is ignored, and does not affect the operation of this method. - Returns: An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: Module, attributeType: Type, inherit: bool) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to a module. Parameters specify the module, the type of the custom attribute to search for, and an ignored search option. - - element: An object derived from the System.Reflection.Module class that describes a portable executable file. - attributeType: The type, or a base type, of the custom attribute to search for. - inherit: This parameter is ignored, and does not affect the operation of this method. - Returns: An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: Assembly, attributeType: Type) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to an assembly. Parameters specify the assembly, and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules. - attributeType: The type, or a base type, of the custom attribute to search for. - Returns: An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: Assembly, attributeType: Type, inherit: bool) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to an assembly. Parameters specify the assembly, the type of the custom attribute to search for, and an ignored search option. - - element: An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules. - attributeType: The type, or a base type, of the custom attribute to search for. - inherit: This parameter is ignored, and does not affect the operation of this method. - Returns: An System.Attribute array that contains the custom attributes of type attributeType applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: Assembly) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to an assembly. A parameter specifies the assembly. - - element: An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules. - Returns: An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist. - GetCustomAttributes(element: Assembly, inherit: bool) -> Array[Attribute] - - Retrieves an array of the custom attributes applied to an assembly. Parameters specify the assembly, and an ignored search option. - - element: An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules. - inherit: This parameter is ignored, and does not affect the operation of this method. - Returns: An System.Attribute array that contains the custom attributes applied to element, or an empty array if no such custom attributes exist. - """ - pass - - def GetHashCode(self): - # type: (self: Attribute) -> int - """ - GetHashCode(self: Attribute) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def IsDefaultAttribute(self): - # type: (self: Attribute) -> bool - """ - IsDefaultAttribute(self: Attribute) -> bool - - When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. - Returns: true if this instance is the default attribute for the class; otherwise, false. - """ - pass - - @staticmethod - def IsDefined(element, attributeType, inherit=None): - # type: (element: MemberInfo, attributeType: Type) -> bool - """ - IsDefined(element: MemberInfo, attributeType: Type) -> bool - - Determines whether any custom attributes are applied to a member of a type. Parameters specify the member, and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, type, or property member of a class. - attributeType: The type, or a base type, of the custom attribute to search for. - Returns: true if a custom attribute of type attributeType is applied to element; otherwise, false. - IsDefined(element: MemberInfo, attributeType: Type, inherit: bool) -> bool - - Determines whether any custom attributes are applied to a member of a type. Parameters specify the member, the type of the custom attribute to search for, and whether to search ancestors of the member. - - element: An object derived from the System.Reflection.MemberInfo class that describes a constructor, event, field, method, type, or property member of a class. - attributeType: The type, or a base type, of the custom attribute to search for. - inherit: If true, specifies to also search the ancestors of element for custom attributes. - Returns: true if a custom attribute of type attributeType is applied to element; otherwise, false. - IsDefined(element: ParameterInfo, attributeType: Type) -> bool - - Determines whether any custom attributes are applied to a method parameter. Parameters specify the method parameter, and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class. - attributeType: The type, or a base type, of the custom attribute to search for. - Returns: true if a custom attribute of type attributeType is applied to element; otherwise, false. - IsDefined(element: ParameterInfo, attributeType: Type, inherit: bool) -> bool - - Determines whether any custom attributes are applied to a method parameter. Parameters specify the method parameter, the type of the custom attribute to search for, and whether to search ancestors of the method parameter. - - element: An object derived from the System.Reflection.ParameterInfo class that describes a parameter of a member of a class. - attributeType: The type, or a base type, of the custom attribute to search for. - inherit: If true, specifies to also search the ancestors of element for custom attributes. - Returns: true if a custom attribute of type attributeType is applied to element; otherwise, false. - IsDefined(element: Module, attributeType: Type) -> bool - - Determines whether any custom attributes of a specified type are applied to a module. Parameters specify the module, and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.Module class that describes a portable executable file. - attributeType: The type, or a base type, of the custom attribute to search for. - Returns: true if a custom attribute of type attributeType is applied to element; otherwise, false. - IsDefined(element: Module, attributeType: Type, inherit: bool) -> bool - - Determines whether any custom attributes are applied to a module. Parameters specify the module, the type of the custom attribute to search for, and an ignored search option. - - element: An object derived from the System.Reflection.Module class that describes a portable executable file. - attributeType: The type, or a base type, of the custom attribute to search for. - inherit: This parameter is ignored, and does not affect the operation of this method. - Returns: true if a custom attribute of type attributeType is applied to element; otherwise, false. - IsDefined(element: Assembly, attributeType: Type) -> bool - - Determines whether any custom attributes are applied to an assembly. Parameters specify the assembly, and the type of the custom attribute to search for. - - element: An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules. - attributeType: The type, or a base type, of the custom attribute to search for. - Returns: true if a custom attribute of type attributeType is applied to element; otherwise, false. - IsDefined(element: Assembly, attributeType: Type, inherit: bool) -> bool - - Determines whether any custom attributes are applied to an assembly. Parameters specify the assembly, the type of the custom attribute to search for, and an ignored search option. - - element: An object derived from the System.Reflection.Assembly class that describes a reusable collection of modules. - attributeType: The type, or a base type, of the custom attribute to search for. - inherit: This parameter is ignored, and does not affect the operation of this method. - Returns: true if a custom attribute of type attributeType is applied to element; otherwise, false. - """ - pass - - def Match(self, obj): - # type: (self: Attribute, obj: object) -> bool - """ - Match(self: Attribute, obj: object) -> bool - - When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. - - obj: An System.Object to compare with this instance of System.Attribute. - Returns: true if this instance equals obj; otherwise, false. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - TypeId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - When implemented in a derived class, gets a unique identifier for this System.Attribute. - - Get: TypeId(self: Attribute) -> object - """ - - - -class AttributeTargets(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies the application elements on which it is valid to apply an attribute. - - enum (flags) AttributeTargets, values: All (32767), Assembly (1), Class (4), Constructor (32), Delegate (4096), Enum (16), Event (512), Field (256), GenericParameter (16384), Interface (1024), Method (64), Module (2), Parameter (2048), Property (128), ReturnValue (8192), Struct (8) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - All = None - Assembly = None - Class = None - Constructor = None - Delegate = None - Enum = None - Event = None - Field = None - GenericParameter = None - Interface = None - Method = None - Module = None - Parameter = None - Property = None - ReturnValue = None - Struct = None - value__ = None - - -class AttributeUsageAttribute(Attribute, _Attribute): - """ - Specifies the usage of another attribute class. This class cannot be inherited. - - AttributeUsageAttribute(validOn: AttributeTargets) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, validOn): - """ __new__(cls: type, validOn: AttributeTargets) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - AllowMultiple = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a Boolean value indicating whether more than one instance of the indicated attribute can be specified for a single program element. - - Get: AllowMultiple(self: AttributeUsageAttribute) -> bool - - Set: AllowMultiple(self: AttributeUsageAttribute) = value - """ - - Inherited = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a Boolean value indicating whether the indicated attribute can be inherited by derived classes and overriding members. - - Get: Inherited(self: AttributeUsageAttribute) -> bool - - Set: Inherited(self: AttributeUsageAttribute) = value - """ - - ValidOn = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a set of values identifying which program elements that the indicated attribute can be applied to. - - Get: ValidOn(self: AttributeUsageAttribute) -> AttributeTargets - """ - - - -class BadImageFormatException(SystemException, ISerializable, _Exception): - # type: (DLL) or an executable program is invalid. - """ - The exception that is thrown when the file image of a dynamic link library (DLL) or an executable program is invalid. - - BadImageFormatException() - BadImageFormatException(message: str) - BadImageFormatException(message: str, inner: Exception) - BadImageFormatException(message: str, fileName: str) - BadImageFormatException(message: str, fileName: str, inner: Exception) - """ - def GetObjectData(self, info, context): - # type: (self: BadImageFormatException, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: BadImageFormatException, info: SerializationInfo, context: StreamingContext) - Sets the System.Runtime.Serialization.SerializationInfo object with the file name, assembly cache log, and additional exception information. - - info: The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown. - context: The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination. - """ - pass - - def ToString(self): - # type: (self: BadImageFormatException) -> str - """ - ToString(self: BadImageFormatException) -> str - - Returns the fully qualified name of this exception and possibly the error message, the name of the inner exception, and the stack trace. - Returns: A string containing the fully qualified name of this exception and possibly the error message, the name of the inner exception, and the stack trace. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, *__args): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, message: str, fileName: str) - __new__(cls: type, message: str, fileName: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - FileName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the name of the file that causes this exception. - - Get: FileName(self: BadImageFormatException) -> str - """ - - FusionLog = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the log file that describes why an assembly load failed. - - Get: FusionLog(self: BadImageFormatException) -> str - """ - - Message = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the error message and the name of the file that caused this exception. - - Get: Message(self: BadImageFormatException) -> str - """ - - - SerializeObjectState = None - - -class Base64FormattingOptions(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies whether relevant erload:System.Convert.ToBase64CharArray and erload:System.Convert.ToBase64String methods insert line breaks in their output. - - enum (flags) Base64FormattingOptions, values: InsertLineBreaks (1), None (0) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - InsertLineBreaks = None - None = None - value__ = None - - -class BitConverter(object): - """ Converts base data types to an array of bytes, and an array of bytes to base data types. """ - @staticmethod - def DoubleToInt64Bits(value): - # type: (value: float) -> Int64 - """ - DoubleToInt64Bits(value: float) -> Int64 - - Converts the specified double-precision floating point number to a 64-bit signed integer. - - value: The number to convert. - Returns: A 64-bit signed integer whose value is equivalent to value. - """ - pass - - @staticmethod - def GetBytes(value): - # type: (value: bool) -> Array[Byte] - """ - GetBytes(value: bool) -> Array[Byte] - - Returns the specified Boolean value as an array of bytes. - - value: A Boolean value. - Returns: An array of bytes with length 1. - GetBytes(value: Char) -> Array[Byte] - - Returns the specified Unicode character value as an array of bytes. - - value: A character to convert. - Returns: An array of bytes with length 2. - GetBytes(value: Int16) -> Array[Byte] - - Returns the specified 16-bit signed integer value as an array of bytes. - - value: The number to convert. - Returns: An array of bytes with length 2. - GetBytes(value: int) -> Array[Byte] - - Returns the specified 32-bit signed integer value as an array of bytes. - - value: The number to convert. - Returns: An array of bytes with length 4. - GetBytes(value: Int64) -> Array[Byte] - - Returns the specified 64-bit signed integer value as an array of bytes. - - value: The number to convert. - Returns: An array of bytes with length 8. - GetBytes(value: UInt16) -> Array[Byte] - - Returns the specified 16-bit unsigned integer value as an array of bytes. - - value: The number to convert. - Returns: An array of bytes with length 2. - GetBytes(value: UInt32) -> Array[Byte] - - Returns the specified 32-bit unsigned integer value as an array of bytes. - - value: The number to convert. - Returns: An array of bytes with length 4. - GetBytes(value: UInt64) -> Array[Byte] - - Returns the specified 64-bit unsigned integer value as an array of bytes. - - value: The number to convert. - Returns: An array of bytes with length 8. - GetBytes(value: Single) -> Array[Byte] - - Returns the specified single-precision floating point value as an array of bytes. - - value: The number to convert. - Returns: An array of bytes with length 4. - GetBytes(value: float) -> Array[Byte] - - Returns the specified double-precision floating point value as an array of bytes. - - value: The number to convert. - Returns: An array of bytes with length 8. - """ - pass - - @staticmethod - def Int64BitsToDouble(value): - # type: (value: Int64) -> float - """ - Int64BitsToDouble(value: Int64) -> float - - Converts the specified 64-bit signed integer to a double-precision floating point number. - - value: The number to convert. - Returns: A double-precision floating point number whose value is equivalent to value. - """ - pass - - @staticmethod - def ToBoolean(value, startIndex): - # type: (value: Array[Byte], startIndex: int) -> bool - """ - ToBoolean(value: Array[Byte], startIndex: int) -> bool - - Returns a Boolean value converted from one byte at a specified position in a byte array. - - value: An array of bytes. - startIndex: The starting position within value. - Returns: true if the byte at startIndex in value is nonzero; otherwise, false. - """ - pass - - @staticmethod - def ToChar(value, startIndex): - # type: (value: Array[Byte], startIndex: int) -> Char - """ - ToChar(value: Array[Byte], startIndex: int) -> Char - - Returns a Unicode character converted from two bytes at a specified position in a byte array. - - value: An array. - startIndex: The starting position within value. - Returns: A character formed by two bytes beginning at startIndex. - """ - pass - - @staticmethod - def ToDouble(value, startIndex): - # type: (value: Array[Byte], startIndex: int) -> float - """ - ToDouble(value: Array[Byte], startIndex: int) -> float - - Returns a double-precision floating point number converted from eight bytes at a specified position in a byte array. - - value: An array of bytes. - startIndex: The starting position within value. - Returns: A double precision floating point number formed by eight bytes beginning at startIndex. - """ - pass - - @staticmethod - def ToInt16(value, startIndex): - # type: (value: Array[Byte], startIndex: int) -> Int16 - """ - ToInt16(value: Array[Byte], startIndex: int) -> Int16 - - Returns a 16-bit signed integer converted from two bytes at a specified position in a byte array. - - value: An array of bytes. - startIndex: The starting position within value. - Returns: A 16-bit signed integer formed by two bytes beginning at startIndex. - """ - pass - - @staticmethod - def ToInt32(value, startIndex): - # type: (value: Array[Byte], startIndex: int) -> int - """ - ToInt32(value: Array[Byte], startIndex: int) -> int - - Returns a 32-bit signed integer converted from four bytes at a specified position in a byte array. - - value: An array of bytes. - startIndex: The starting position within value. - Returns: A 32-bit signed integer formed by four bytes beginning at startIndex. - """ - pass - - @staticmethod - def ToInt64(value, startIndex): - # type: (value: Array[Byte], startIndex: int) -> Int64 - """ - ToInt64(value: Array[Byte], startIndex: int) -> Int64 - - Returns a 64-bit signed integer converted from eight bytes at a specified position in a byte array. - - value: An array of bytes. - startIndex: The starting position within value. - Returns: A 64-bit signed integer formed by eight bytes beginning at startIndex. - """ - pass - - @staticmethod - def ToSingle(value, startIndex): - # type: (value: Array[Byte], startIndex: int) -> Single - """ - ToSingle(value: Array[Byte], startIndex: int) -> Single - - Returns a single-precision floating point number converted from four bytes at a specified position in a byte array. - - value: An array of bytes. - startIndex: The starting position within value. - Returns: A single-precision floating point number formed by four bytes beginning at startIndex. - """ - pass - - @staticmethod - def ToString(value=None, startIndex=None, length=None): - # type: (value: Array[Byte], startIndex: int, length: int) -> str - """ - ToString(value: Array[Byte], startIndex: int, length: int) -> str - - Converts the numeric value of each element of a specified subarray of bytes to its equivalent hexadecimal string representation. - - value: An array of bytes. - startIndex: The starting position within value. - length: The number of array elements in value to convert. - Returns: A string of hexadecimal pairs separated by hyphens, where each pair represents the corresponding element in a subarray of value; for example, "7F-2C-4A-00". - ToString(value: Array[Byte]) -> str - - Converts the numeric value of each element of a specified array of bytes to its equivalent hexadecimal string representation. - - value: An array of bytes. - Returns: A string of hexadecimal pairs separated by hyphens, where each pair represents the corresponding element in value; for example, "7F-2C-4A-00". - ToString(value: Array[Byte], startIndex: int) -> str - - Converts the numeric value of each element of a specified subarray of bytes to its equivalent hexadecimal string representation. - - value: An array of bytes. - startIndex: The starting position within value. - Returns: A string of hexadecimal pairs separated by hyphens, where each pair represents the corresponding element in a subarray of value; for example, "7F-2C-4A-00". - """ - pass - - @staticmethod - def ToUInt16(value, startIndex): - # type: (value: Array[Byte], startIndex: int) -> UInt16 - """ - ToUInt16(value: Array[Byte], startIndex: int) -> UInt16 - - Returns a 16-bit unsigned integer converted from two bytes at a specified position in a byte array. - - value: The array of bytes. - startIndex: The starting position within value. - Returns: A 16-bit unsigned integer formed by two bytes beginning at startIndex. - """ - pass - - @staticmethod - def ToUInt32(value, startIndex): - # type: (value: Array[Byte], startIndex: int) -> UInt32 - """ - ToUInt32(value: Array[Byte], startIndex: int) -> UInt32 - - Returns a 32-bit unsigned integer converted from four bytes at a specified position in a byte array. - - value: An array of bytes. - startIndex: The starting position within value. - Returns: A 32-bit unsigned integer formed by four bytes beginning at startIndex. - """ - pass - - @staticmethod - def ToUInt64(value, startIndex): - # type: (value: Array[Byte], startIndex: int) -> UInt64 - """ - ToUInt64(value: Array[Byte], startIndex: int) -> UInt64 - - Returns a 64-bit unsigned integer converted from eight bytes at a specified position in a byte array. - - value: An array of bytes. - startIndex: The starting position within value. - Returns: A 64-bit unsigned integer formed by the eight bytes beginning at startIndex. - """ - pass - - IsLittleEndian = True - __all__ = [ - 'DoubleToInt64Bits', - 'GetBytes', - 'Int64BitsToDouble', - 'IsLittleEndian', - 'ToBoolean', - 'ToChar', - 'ToDouble', - 'ToInt16', - 'ToInt32', - 'ToInt64', - 'ToSingle', - 'ToString', - 'ToUInt16', - 'ToUInt32', - 'ToUInt64', - ] - - -class Int32(object): - """ Represents a 32-bit signed integer. """ - def bit_length(self, *args): #cannot find CLR method - # type: (value: int) -> int - """ bit_length(value: int) -> int """ - pass - - def conjugate(self, *args): #cannot find CLR method - # type: (x: int) -> int - """ conjugate(x: int) -> int """ - pass - - def __abs__(self, *args): #cannot find CLR method - """ x.__abs__() <==> abs(x) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __and__(self, *args): #cannot find CLR method - """ __and__(x: int, y: int) -> int """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __coerce__(self, *args): #cannot find CLR method - """ __coerce__(x: int, o: object) -> object """ - pass - - def __divmod__(self, *args): #cannot find CLR method - """ - __divmod__(x: int, y: int) -> tuple - __divmod__(x: int, y: object) -> object - """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/y """ - pass - - def __float__(self, *args): #cannot find CLR method - """ __float__(self: int) -> float """ - pass - - def __floordiv__(self, *args): #cannot find CLR method - """ x.__floordiv__(y) <==> x//y """ - pass - - def __getnewargs__(self, *args): #cannot find CLR method - """ __getnewargs__(self: int) -> object """ - pass - - def __hex__(self, *args): #cannot find CLR method - """ __hex__(x: int) -> str """ - pass - - def __index__(self, *args): #cannot find CLR method - """ __index__(x: int) -> int """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(self: int) -> int """ - pass - - def __invert__(self, *args): #cannot find CLR method - """ __invert__(x: int) -> int """ - pass - - def __long__(self, *args): #cannot find CLR method - """ __long__(self: int) -> long """ - pass - - def __lshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x< x< x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*y """ - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(o: object) -> object - __new__(cls: type, o: Extensible[float]) -> object - __new__(cls: type, s: str, base: int) -> object - __new__(cls: type, s: IList[Byte]) -> object - __new__(cls: type, x: object) -> object - __new__(cls: type) -> object - """ - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(x: int) -> bool """ - pass - - def __oct__(self, *args): #cannot find CLR method - """ __oct__(x: int) -> str """ - pass - - def __or__(self, *args): #cannot find CLR method - """ __or__(x: int, y: int) -> int """ - pass - - def __pos__(self, *args): #cannot find CLR method - """ __pos__(x: int) -> int """ - pass - - def __pow__(self, *args): #cannot find CLR method - """ x.__pow__(y[, z]) <==> pow(x, y[, z])x.__pow__(y[, z]) <==> pow(x, y[, z])x.__pow__(y[, z]) <==> pow(x, y[, z])x.__pow__(y[, z]) <==> pow(x, y[, z]) """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ __radd__(x: int, y: int) -> object """ - pass - - def __rand__(self, *args): #cannot find CLR method - """ __rand__(x: int, y: int) -> int """ - pass - - def __rdivmod__(self, *args): #cannot find CLR method - """ __rdivmod__(x: int, y: int) -> object """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ __rdiv__(x: int, y: int) -> object """ - pass - - def __rfloordiv__(self, *args): #cannot find CLR method - """ __rfloordiv__(x: int, y: int) -> object """ - pass - - def __rlshift__(self, *args): #cannot find CLR method - """ __rlshift__(x: int, y: int) -> object """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ __rmod__(x: int, y: int) -> int """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ __rmul__(x: int, y: int) -> object """ - pass - - def __ror__(self, *args): #cannot find CLR method - """ __ror__(x: int, y: int) -> int """ - pass - - def __rpow__(self, *args): #cannot find CLR method - """ - __rpow__(x: int, power: long, qmod: long) -> object - __rpow__(x: int, power: float, qmod: float) -> object - __rpow__(x: int, power: int, qmod: Nullable[int]) -> object - __rpow__(x: int, power: int) -> object - """ - pass - - def __rrshift__(self, *args): #cannot find CLR method - """ __rrshift__(x: int, y: int) -> int """ - pass - - def __rshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x>>yx.__rshift__(y) <==> x>>y """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ __rsub__(x: int, y: int) -> object """ - pass - - def __rtruediv__(self, *args): #cannot find CLR method - """ __rtruediv__(x: int, y: int) -> float """ - pass - - def __rxor__(self, *args): #cannot find CLR method - """ __rxor__(x: int, y: int) -> int """ - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - def __truediv__(self, *args): #cannot find CLR method - """ x.__truediv__(y) <==> x/y """ - pass - - def __trunc__(self, *args): #cannot find CLR method - """ __trunc__(x: int) -> int """ - pass - - def __xor__(self, *args): #cannot find CLR method - """ __xor__(x: int, y: int) -> int """ - pass - - denominator = None - imag = None - numerator = None - real = None - - -class Boolean(int): - """ Represents a Boolean value. """ - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: object) -> object - __new__(cls: object, o: object) -> bool - """ - pass - - -class Buffer(object): - """ Manipulates arrays of primitive types. """ - @staticmethod - def BlockCopy(src, srcOffset, dst, dstOffset, count): - # type: (src: Array, srcOffset: int, dst: Array, dstOffset: int, count: int) - """ - BlockCopy(src: Array, srcOffset: int, dst: Array, dstOffset: int, count: int) - Copies a specified number of bytes from a source array starting at a particular offset to a destination array starting at a particular offset. - - src: The source buffer. - srcOffset: The zero-based byte offset into src. - dst: The destination buffer. - dstOffset: The zero-based byte offset into dst. - count: The number of bytes to copy. - """ - pass - - @staticmethod - def ByteLength(array): - # type: (array: Array) -> int - """ - ByteLength(array: Array) -> int - - Returns the number of bytes in the specified array. - - array: An array. - Returns: The number of bytes in the array. - """ - pass - - @staticmethod - def GetByte(array, index): - # type: (array: Array, index: int) -> Byte - """ - GetByte(array: Array, index: int) -> Byte - - Retrieves the byte at a specified location in a specified array. - - array: An array. - index: A location in the array. - Returns: Returns the index byte in the array. - """ - pass - - @staticmethod - def MemoryCopy(source, destination, destinationSizeInBytes, sourceBytesToCopy): - # type: (source: Void*, destination: Void*, destinationSizeInBytes: Int64, sourceBytesToCopy: Int64)MemoryCopy(source: Void*, destination: Void*, destinationSizeInBytes: UInt64, sourceBytesToCopy: UInt64) - """ MemoryCopy(source: Void*, destination: Void*, destinationSizeInBytes: Int64, sourceBytesToCopy: Int64)MemoryCopy(source: Void*, destination: Void*, destinationSizeInBytes: UInt64, sourceBytesToCopy: UInt64) """ - pass - - @staticmethod - def SetByte(array, index, value): - # type: (array: Array, index: int, value: Byte) - """ - SetByte(array: Array, index: int, value: Byte) - Assigns a specified value to a byte at a particular location in a specified array. - - array: An array. - index: A location in the array. - value: A value to assign. - """ - pass - - __all__ = [ - 'BlockCopy', - 'ByteLength', - 'GetByte', - 'MemoryCopy', - 'SetByte', - ] - - -class Byte(object, IComparable, IFormattable, IConvertible, IComparable[Byte], IEquatable[Byte]): - """ Represents an 8-bit unsigned integer. """ - def bit_length(self, *args): #cannot find CLR method - # type: (value: Byte) -> int - """ bit_length(value: Byte) -> int """ - pass - - def CompareTo(self, value): - # type: (self: Byte, value: object) -> int - """ - CompareTo(self: Byte, value: object) -> int - - Compares this instance to a specified object and returns an indication of their relative values. - - value: An object to compare, or null. - Returns: A signed integer that indicates the relative order of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.-or- - value is null. - - CompareTo(self: Byte, value: Byte) -> int - - Compares this instance to a specified 8-bit unsigned integer and returns an indication of their relative values. - - value: An 8-bit unsigned integer to compare. - Returns: A signed integer that indicates the relative order of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value. - """ - pass - - def conjugate(self, *args): #cannot find CLR method - # type: (x: Byte) -> Byte - """ conjugate(x: Byte) -> Byte """ - pass - - def Equals(self, obj): - # type: (self: Byte, obj: object) -> bool - """ - Equals(self: Byte, obj: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - obj: An object to compare with this instance, or null. - Returns: true if obj is an instance of System.Byte and equals the value of this instance; otherwise, false. - Equals(self: Byte, obj: Byte) -> bool - - Returns a value indicating whether this instance and a specified System.Byte object represent the same value. - - obj: An object to compare to this instance. - Returns: true if obj is equal to this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: Byte) -> int - """ - GetHashCode(self: Byte) -> int - - Returns the hash code for this instance. - Returns: A hash code for the current System.Byte. - """ - pass - - def GetTypeCode(self): - # type: (self: Byte) -> TypeCode - """ - GetTypeCode(self: Byte) -> TypeCode - - Returns the System.TypeCode for value type System.Byte. - Returns: The enumerated constant, System.TypeCode.Byte. - """ - pass - - @staticmethod - def Parse(s, *__args): - # type: (s: str) -> Byte - """ - Parse(s: str) -> Byte - - Converts the string representation of a number to its System.Byte equivalent. - - s: A string that contains a number to convert. The string is interpreted using the System.Globalization.NumberStyles.Integer style. - Returns: A byte value that is equivalent to the number contained in s. - Parse(s: str, style: NumberStyles) -> Byte - - Converts the string representation of a number in a specified style to its System.Byte equivalent. - - s: A string that contains a number to convert. The string is interpreted using the style specified by style. - style: A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - Returns: A byte value that is equivalent to the number contained in s. - Parse(s: str, provider: IFormatProvider) -> Byte - - Converts the string representation of a number in a specified culture-specific format to its System.Byte equivalent. - - s: A string that contains a number to convert. The string is interpreted using the System.Globalization.NumberStyles.Integer style. - provider: An object that supplies culture-specific parsing information about s. If provider is null, the thread current culture is used. - Returns: A byte value that is equivalent to the number contained in s. - Parse(s: str, style: NumberStyles, provider: IFormatProvider) -> Byte - - Converts the string representation of a number in a specified style and culture-specific format to its System.Byte equivalent. - - s: A string that contains a number to convert. The string is interpreted using the style specified by style. - style: A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific information about the format of s. If provider is null, the thread current culture is used. - Returns: A byte value that is equivalent to the number contained in s. - """ - pass - - def ToString(self, *__args): - # type: (self: Byte) -> str - """ - ToString(self: Byte) -> str - - Converts the value of the current System.Byte object to its equivalent string representation. - Returns: The string representation of the value of this object, which consists of a sequence of digits that range from 0 to 9 with no leading zeroes. - ToString(self: Byte, format: str) -> str - - Converts the value of the current System.Byte object to its equivalent string representation using the specified format. - - format: A numeric format string. - Returns: The string representation of the current System.Byte object, formatted as specified by the format parameter. - ToString(self: Byte, provider: IFormatProvider) -> str - - Converts the numeric value of the current System.Byte object to its equivalent string representation using the specified culture-specific formatting information. - - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this object in the format specified by the provider parameter. - ToString(self: Byte, format: str, provider: IFormatProvider) -> str - - Converts the value of the current System.Byte object to its equivalent string representation using the specified format and culture-specific formatting information. - - format: A standard or custom numeric format string. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the current System.Byte object, formatted as specified by the format and provider parameters. - """ - pass - - @staticmethod - def TryParse(s, *__args): - # type: (s: str) -> (bool, Byte) - """ - TryParse(s: str) -> (bool, Byte) - - Tries to convert the string representation of a number to its System.Byte equivalent, and returns a value that indicates whether the conversion succeeded. - - s: A string that contains a number to convert. The string is interpreted using the System.Globalization.NumberStyles.Integer style. - Returns: true if s was converted successfully; otherwise, false. - TryParse(s: str, style: NumberStyles, provider: IFormatProvider) -> (bool, Byte) - - Converts the string representation of a number in a specified style and culture-specific format to its System.Byte equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string containing a number to convert. The string is interpreted using the style specified by style. - style: A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific formatting information about s. If provider is null, the thread current culture is used. - Returns: true if s was converted successfully; otherwise, false. - """ - pass - - def __abs__(self, *args): #cannot find CLR method - """ x.__abs__() <==> abs(x) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+yx.__add__(y) <==> x+y """ - pass - - def __and__(self, *args): #cannot find CLR method - """ - __and__(x: Byte, y: Byte) -> Byte - __and__(x: Byte, y: SByte) -> Int16 - """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y)x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/yx.__div__(y) <==> x/y """ - pass - - def __float__(self, *args): #cannot find CLR method - """ __float__(x: Byte) -> float """ - pass - - def __floordiv__(self, *args): #cannot find CLR method - """ x.__floordiv__(y) <==> x//yx.__floordiv__(y) <==> x//y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __hex__(self, *args): #cannot find CLR method - """ __hex__(value: Byte) -> str """ - pass - - def __index__(self, *args): #cannot find CLR method - """ __index__(x: Byte) -> int """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(x: Byte) -> int """ - pass - - def __invert__(self, *args): #cannot find CLR method - """ __invert__(x: Byte) -> object """ - pass - - def __lshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x< x< x%yx.__mod__(y) <==> x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*yx.__mul__(y) <==> x*y """ - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) -> object - __new__(cls: type, value: object) -> object - """ - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(x: Byte) -> bool """ - pass - - def __or__(self, *args): #cannot find CLR method - """ - __or__(x: Byte, y: Byte) -> Byte - __or__(x: Byte, y: SByte) -> Int16 - """ - pass - - def __pos__(self, *args): #cannot find CLR method - """ __pos__(x: Byte) -> Byte """ - pass - - def __pow__(self, *args): #cannot find CLR method - """ x.__pow__(y[, z]) <==> pow(x, y[, z])x.__pow__(y[, z]) <==> pow(x, y[, z]) """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ - __radd__(x: Byte, y: Byte) -> object - __radd__(x: SByte, y: Byte) -> object - """ - pass - - def __rand__(self, *args): #cannot find CLR method - """ - __rand__(x: Byte, y: Byte) -> Byte - __rand__(x: SByte, y: Byte) -> Int16 - """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ - __rdiv__(x: Byte, y: Byte) -> object - __rdiv__(x: SByte, y: Byte) -> object - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(x: Byte) -> str """ - pass - - def __rfloordiv__(self, *args): #cannot find CLR method - """ - __rfloordiv__(x: Byte, y: Byte) -> Byte - __rfloordiv__(x: SByte, y: Byte) -> object - """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ - __rmod__(x: Byte, y: Byte) -> Byte - __rmod__(x: SByte, y: Byte) -> Int16 - """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ - __rmul__(x: Byte, y: Byte) -> object - __rmul__(x: SByte, y: Byte) -> object - """ - pass - - def __ror__(self, *args): #cannot find CLR method - """ - __ror__(x: Byte, y: Byte) -> Byte - __ror__(x: SByte, y: Byte) -> Int16 - """ - pass - - def __rpow__(self, *args): #cannot find CLR method - """ - __rpow__(x: Byte, y: Byte) -> object - __rpow__(x: SByte, y: Byte) -> object - """ - pass - - def __rshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x>>yx.__rshift__(y) <==> x>>y """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ - __rsub__(x: Byte, y: Byte) -> object - __rsub__(x: SByte, y: Byte) -> object - """ - pass - - def __rtruediv__(self, *args): #cannot find CLR method - """ - __rtruediv__(x: Byte, y: Byte) -> float - __rtruediv__(x: SByte, y: Byte) -> float - """ - pass - - def __rxor__(self, *args): #cannot find CLR method - """ - __rxor__(x: Byte, y: Byte) -> Byte - __rxor__(x: SByte, y: Byte) -> Int16 - """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-yx.__sub__(y) <==> x-y """ - pass - - def __truediv__(self, *args): #cannot find CLR method - """ x.__truediv__(y) <==> x/yx.__truediv__(y) <==> x/y """ - pass - - def __trunc__(self, *args): #cannot find CLR method - """ __trunc__(x: Byte) -> Byte """ - pass - - def __xor__(self, *args): #cannot find CLR method - """ - __xor__(x: Byte, y: Byte) -> Byte - __xor__(x: Byte, y: SByte) -> Int16 - """ - pass - - denominator = None - imag = None - MaxValue = None - MinValue = None - numerator = None - real = None - - -class CannotUnloadAppDomainException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when an attempt to unload an application domain fails. - - CannotUnloadAppDomainException() - CannotUnloadAppDomainException(message: str) - CannotUnloadAppDomainException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class Char(object, IComparable, IConvertible, IComparable[Char], IEquatable[Char]): - """ Represents a character as a UTF-16 code unit. """ - def CompareTo(self, value): - # type: (self: Char, value: object) -> int - """ - CompareTo(self: Char, value: object) -> int - - Compares this instance to a specified object and indicates whether this instance precedes, follows, or appears in the same position in the sort order as the specified System.Object. - - value: An object to compare this instance to, or null. - Returns: A signed number indicating the position of this instance in the sort order in relation to the value parameter.Return Value Description Less than zero This instance precedes value. Zero This instance has the same position in the sort order as value. - Greater than zero This instance follows value.-or- value is null. - - CompareTo(self: Char, value: Char) -> int - - Compares this instance to a specified System.Char object and indicates whether this instance precedes, follows, or appears in the same position in the sort order as the specified System.Char object. - - value: A System.Char object to compare. - Returns: A signed number indicating the position of this instance in the sort order in relation to the value parameter.Return Value Description Less than zero This instance precedes value. Zero This instance has the same position in the sort order as value. - Greater than zero This instance follows value. - """ - pass - - @staticmethod - def ConvertFromUtf32(utf32): - # type: (utf32: int) -> str - """ - ConvertFromUtf32(utf32: int) -> str - - Converts the specified Unicode code point into a UTF-16 encoded string. - - utf32: A 21-bit Unicode code point. - Returns: A string consisting of one System.Char object or a surrogate pair of System.Char objects equivalent to the code point specified by the utf32 parameter. - """ - pass - - @staticmethod - def ConvertToUtf32(*__args): - # type: (highSurrogate: Char, lowSurrogate: Char) -> int - """ - ConvertToUtf32(highSurrogate: Char, lowSurrogate: Char) -> int - - Converts the value of a UTF-16 encoded surrogate pair into a Unicode code point. - - highSurrogate: A high surrogate code unit (that is, a code unit ranging from U+D800 through U+DBFF). - lowSurrogate: A low surrogate code unit (that is, a code unit ranging from U+DC00 through U+DFFF). - Returns: The 21-bit Unicode code point represented by the highSurrogate and lowSurrogate parameters. - ConvertToUtf32(s: str, index: int) -> int - - Converts the value of a UTF-16 encoded character or surrogate pair at a specified position in a string into a Unicode code point. - - s: A string that contains a character or surrogate pair. - index: The index position of the character or surrogate pair in s. - Returns: The 21-bit Unicode code point represented by the character or surrogate pair at the position in the s parameter specified by the index parameter. - """ - pass - - def Equals(self, obj): - # type: (self: Char, obj: object) -> bool - """ - Equals(self: Char, obj: object) -> bool - - Returns a value that indicates whether this instance is equal to a specified object. - - obj: An object to compare with this instance or null. - Returns: true if obj is an instance of System.Char and equals the value of this instance; otherwise, false. - Equals(self: Char, obj: Char) -> bool - - Returns a value that indicates whether this instance is equal to the specified System.Char object. - - obj: An object to compare to this instance. - Returns: true if the obj parameter equals the value of this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: Char) -> int - """ - GetHashCode(self: Char) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - @staticmethod - def GetNumericValue(*__args): - # type: (c: Char) -> float - """ - GetNumericValue(c: Char) -> float - - Converts the specified numeric Unicode character to a double-precision floating point number. - - c: The Unicode character to convert. - Returns: The numeric value of c if that character represents a number; otherwise, -1.0. - GetNumericValue(s: str, index: int) -> float - - Converts the numeric Unicode character at the specified position in a specified string to a double-precision floating point number. - - s: A System.String. - index: The character position in s. - Returns: The numeric value of the character at position index in s if that character represents a number; otherwise, -1. - """ - pass - - def GetTypeCode(self): - # type: (self: Char) -> TypeCode - """ - GetTypeCode(self: Char) -> TypeCode - - Returns the System.TypeCode for value type System.Char. - Returns: The enumerated constant, System.TypeCode.Char. - """ - pass - - @staticmethod - def GetUnicodeCategory(*__args): - # type: (c: Char) -> UnicodeCategory - """ - GetUnicodeCategory(c: Char) -> UnicodeCategory - - Categorizes a specified Unicode character into a group identified by one of the System.Globalization.UnicodeCategory values. - - c: The Unicode character to categorize. - Returns: A System.Globalization.UnicodeCategory value that identifies the group that contains c. - GetUnicodeCategory(s: str, index: int) -> UnicodeCategory - - Categorizes the character at the specified position in a specified string into a group identified by one of the System.Globalization.UnicodeCategory values. - - s: A System.String. - index: The character position in s. - Returns: A System.Globalization.UnicodeCategory enumerated constant that identifies the group that contains the character at position index in s. - """ - pass - - @staticmethod - def IsControl(*__args): - # type: (c: Char) -> bool - """ - IsControl(c: Char) -> bool - - Indicates whether the specified Unicode character is categorized as a control character. - - c: The Unicode character to evaluate. - Returns: true if c is a control character; otherwise, false. - IsControl(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string is categorized as a control character. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is a control character; otherwise, false. - """ - pass - - @staticmethod - def IsDigit(*__args): - # type: (c: Char) -> bool - """ - IsDigit(c: Char) -> bool - - Indicates whether the specified Unicode character is categorized as a decimal digit. - - c: The Unicode character to evaluate. - Returns: true if c is a decimal digit; otherwise, false. - IsDigit(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string is categorized as a decimal digit. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is a decimal digit; otherwise, false. - """ - pass - - @staticmethod - def IsHighSurrogate(*__args): - # type: (c: Char) -> bool - """ - IsHighSurrogate(c: Char) -> bool - - Indicates whether the specified System.Char object is a high surrogate. - - c: The Unicode character to evaluate. - Returns: true if the numeric value of the c parameter ranges from U+D800 through U+DBFF; otherwise, false. - IsHighSurrogate(s: str, index: int) -> bool - - Indicates whether the System.Char object at the specified position in a string is a high surrogate. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the numeric value of the specified character in the s parameter ranges from U+D800 through U+DBFF; otherwise, false. - """ - pass - - @staticmethod - def IsLetter(*__args): - # type: (c: Char) -> bool - """ - IsLetter(c: Char) -> bool - - Indicates whether the specified Unicode character is categorized as a Unicode letter. - - c: The Unicode character to evaluate. - Returns: true if c is a letter; otherwise, false. - IsLetter(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string is categorized as a Unicode letter. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is a letter; otherwise, false. - """ - pass - - @staticmethod - def IsLetterOrDigit(*__args): - # type: (c: Char) -> bool - """ - IsLetterOrDigit(c: Char) -> bool - - Indicates whether the specified Unicode character is categorized as a letter or a decimal digit. - - c: The Unicode character to evaluate. - Returns: true if c is a letter or a decimal digit; otherwise, false. - IsLetterOrDigit(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string is categorized as a letter or a decimal digit. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is a letter or a decimal digit; otherwise, false. - """ - pass - - @staticmethod - def IsLower(*__args): - # type: (c: Char) -> bool - """ - IsLower(c: Char) -> bool - - Indicates whether the specified Unicode character is categorized as a lowercase letter. - - c: The Unicode character to evaluate. - Returns: true if c is a lowercase letter; otherwise, false. - IsLower(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string is categorized as a lowercase letter. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is a lowercase letter; otherwise, false. - """ - pass - - @staticmethod - def IsLowSurrogate(*__args): - # type: (c: Char) -> bool - """ - IsLowSurrogate(c: Char) -> bool - - Indicates whether the specified System.Char object is a low surrogate. - - c: The character to evaluate. - Returns: true if the numeric value of the c parameter ranges from U+DC00 through U+DFFF; otherwise, false. - IsLowSurrogate(s: str, index: int) -> bool - - Indicates whether the System.Char object at the specified position in a string is a low surrogate. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the numeric value of the specified character in the s parameter ranges from U+DC00 through U+DFFF; otherwise, false. - """ - pass - - @staticmethod - def IsNumber(*__args): - # type: (c: Char) -> bool - """ - IsNumber(c: Char) -> bool - - Indicates whether the specified Unicode character is categorized as a number. - - c: The Unicode character to evaluate. - Returns: true if c is a number; otherwise, false. - IsNumber(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string is categorized as a number. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is a number; otherwise, false. - """ - pass - - @staticmethod - def IsPunctuation(*__args): - # type: (c: Char) -> bool - """ - IsPunctuation(c: Char) -> bool - - Indicates whether the specified Unicode character is categorized as a punctuation mark. - - c: The Unicode character to evaluate. - Returns: true if c is a punctuation mark; otherwise, false. - IsPunctuation(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string is categorized as a punctuation mark. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is a punctuation mark; otherwise, false. - """ - pass - - @staticmethod - def IsSeparator(*__args): - # type: (c: Char) -> bool - """ - IsSeparator(c: Char) -> bool - - Indicates whether the specified Unicode character is categorized as a separator character. - - c: The Unicode character to evaluate. - Returns: true if c is a separator character; otherwise, false. - IsSeparator(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string is categorized as a separator character. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is a separator character; otherwise, false. - """ - pass - - @staticmethod - def IsSurrogate(*__args): - # type: (c: Char) -> bool - """ - IsSurrogate(c: Char) -> bool - - Indicates whether the specified character has a surrogate code unit. - - c: The Unicode character to evaluate. - Returns: true if c is either a high surrogate or a low surrogate; otherwise, false. - IsSurrogate(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string has a surrogate code unit. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is a either a high surrogate or a low surrogate; otherwise, false. - """ - pass - - @staticmethod - def IsSurrogatePair(*__args): - # type: (s: str, index: int) -> bool - """ - IsSurrogatePair(s: str, index: int) -> bool - - Indicates whether two adjacent System.Char objects at a specified position in a string form a surrogate pair. - - s: A string. - index: The starting position of the pair of characters to evaluate within s. - Returns: true if the s parameter includes adjacent characters at positions index and index + 1, and the numeric value of the character at position index ranges from U+D800 through U+DBFF, and the numeric value of the character at position index+1 ranges from - U+DC00 through U+DFFF; otherwise, false. - - IsSurrogatePair(highSurrogate: Char, lowSurrogate: Char) -> bool - - Indicates whether the two specified System.Char objects form a surrogate pair. - - highSurrogate: The character to evaluate as the high surrogate of a surrogate pair. - lowSurrogate: The character to evaluate as the low surrogate of a surrogate pair. - Returns: true if the numeric value of the highSurrogate parameter ranges from U+D800 through U+DBFF, and the numeric value of the lowSurrogate parameter ranges from U+DC00 through U+DFFF; otherwise, false. - """ - pass - - @staticmethod - def IsSymbol(*__args): - # type: (c: Char) -> bool - """ - IsSymbol(c: Char) -> bool - - Indicates whether the specified Unicode character is categorized as a symbol character. - - c: The Unicode character to evaluate. - Returns: true if c is a symbol character; otherwise, false. - IsSymbol(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string is categorized as a symbol character. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is a symbol character; otherwise, false. - """ - pass - - @staticmethod - def IsUpper(*__args): - # type: (c: Char) -> bool - """ - IsUpper(c: Char) -> bool - - Indicates whether the specified Unicode character is categorized as an uppercase letter. - - c: The Unicode character to evaluate. - Returns: true if c is an uppercase letter; otherwise, false. - IsUpper(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string is categorized as an uppercase letter. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is an uppercase letter; otherwise, false. - """ - pass - - @staticmethod - def IsWhiteSpace(*__args): - # type: (c: Char) -> bool - """ - IsWhiteSpace(c: Char) -> bool - - Indicates whether the specified Unicode character is categorized as white space. - - c: The Unicode character to evaluate. - Returns: true if c is white space; otherwise, false. - IsWhiteSpace(s: str, index: int) -> bool - - Indicates whether the character at the specified position in a specified string is categorized as white space. - - s: A string. - index: The position of the character to evaluate in s. - Returns: true if the character at position index in s is white space; otherwise, false. - """ - pass - - @staticmethod - def Parse(s): - # type: (s: str) -> Char - """ - Parse(s: str) -> Char - - Converts the value of the specified string to its equivalent Unicode character. - - s: A string that contains a single character, or null. - Returns: A Unicode character equivalent to the sole character in s. - """ - pass - - @staticmethod - def ToLower(c, culture=None): - # type: (c: Char, culture: CultureInfo) -> Char - """ - ToLower(c: Char, culture: CultureInfo) -> Char - - Converts the value of a specified Unicode character to its lowercase equivalent using specified culture-specific formatting information. - - c: The Unicode character to convert. - culture: An object that supplies culture-specific casing rules. - Returns: The lowercase equivalent of c, modified according to culture, or the unchanged value of c, if c is already lowercase or not alphabetic. - ToLower(c: Char) -> Char - - Converts the value of a Unicode character to its lowercase equivalent. - - c: The Unicode character to convert. - Returns: The lowercase equivalent of c, or the unchanged value of c, if c is already lowercase or not alphabetic. - """ - pass - - @staticmethod - def ToLowerInvariant(c): - # type: (c: Char) -> Char - """ - ToLowerInvariant(c: Char) -> Char - - Converts the value of a Unicode character to its lowercase equivalent using the casing rules of the invariant culture. - - c: The Unicode character to convert. - Returns: The lowercase equivalent of the c parameter, or the unchanged value of c, if c is already lowercase or not alphabetic. - """ - pass - - def ToString(self, *__args): - # type: (self: Char) -> str - """ - ToString(self: Char) -> str - - Converts the value of this instance to its equivalent string representation. - Returns: The string representation of the value of this instance. - ToString(self: Char, provider: IFormatProvider) -> str - - Converts the value of this instance to its equivalent string representation using the specified culture-specific format information. - - provider: (Reserved) An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance as specified by provider. - ToString(c: Char) -> str - - Converts the specified Unicode character to its equivalent string representation. - - c: The Unicode character to convert. - Returns: The string representation of the value of c. - """ - pass - - @staticmethod - def ToUpper(c, culture=None): - # type: (c: Char, culture: CultureInfo) -> Char - """ - ToUpper(c: Char, culture: CultureInfo) -> Char - - Converts the value of a specified Unicode character to its uppercase equivalent using specified culture-specific formatting information. - - c: The Unicode character to convert. - culture: An object that supplies culture-specific casing rules. - Returns: The uppercase equivalent of c, modified according to culture, or the unchanged value of c if c is already uppercase, has no uppercase equivalent, or is not alphabetic. - ToUpper(c: Char) -> Char - - Converts the value of a Unicode character to its uppercase equivalent. - - c: The Unicode character to convert. - Returns: The uppercase equivalent of c, or the unchanged value of c if c is already uppercase, has no uppercase equivalent, or is not alphabetic. - """ - pass - - @staticmethod - def ToUpperInvariant(c): - # type: (c: Char) -> Char - """ - ToUpperInvariant(c: Char) -> Char - - Converts the value of a Unicode character to its uppercase equivalent using the casing rules of the invariant culture. - - c: The Unicode character to convert. - Returns: The uppercase equivalent of the c parameter, or the unchanged value of c, if c is already uppercase or not alphabetic. - """ - pass - - @staticmethod - def TryParse(s, result): - # type: (s: str) -> (bool, Char) - """ - TryParse(s: str) -> (bool, Char) - - Converts the value of the specified string to its equivalent Unicode character. A return code indicates whether the conversion succeeded or failed. - - s: A string that contains a single character, or null. - Returns: true if the s parameter was converted successfully; otherwise, false. - """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(self: Char, other: Char) -> bool - __contains__(self: Char, other: str) -> bool - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __index__(self, *args): #cannot find CLR method - """ __index__(self: Char) -> int """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: Char) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - MaxValue = None - MinValue = None - - -class CharEnumerator(object, IEnumerator, ICloneable, IEnumerator[Char], IDisposable): - """ Supports iterating over a System.String object and reading its individual characters. This class cannot be inherited. """ - def Clone(self): - # type: (self: CharEnumerator) -> object - """ - Clone(self: CharEnumerator) -> object - - Creates a copy of the current System.CharEnumerator object. - Returns: An System.Object that is a copy of the current System.CharEnumerator object. - """ - pass - - def Dispose(self): - # type: (self: CharEnumerator) - """ - Dispose(self: CharEnumerator) - Releases all resources used by the current instance of the System.CharEnumerator class. - """ - pass - - def MoveNext(self): - # type: (self: CharEnumerator) -> bool - """ - MoveNext(self: CharEnumerator) -> bool - - Increments the internal index of the current System.CharEnumerator object to the next character of the enumerated string. - Returns: true if the index is successfully incremented and within the enumerated string; otherwise, false. - """ - pass - - def next(self, *args): #cannot find CLR method - # type: (self: object) -> object - """ next(self: object) -> object """ - pass - - def Reset(self): - # type: (self: CharEnumerator) - """ - Reset(self: CharEnumerator) - Initializes the index to a position logically before the first character of the enumerated string. - """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[Char](enumerator: IEnumerator[Char], value: Char) -> bool """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerator) -> object """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Current = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the currently referenced character in the string enumerated by this System.CharEnumerator object. - - Get: Current(self: CharEnumerator) -> Char - """ - - - -class CLSCompliantAttribute(Attribute, _Attribute): - # type: (CLS). This class cannot be inherited. - """ - Indicates whether a program element is compliant with the Common Language Specification (CLS). This class cannot be inherited. - - CLSCompliantAttribute(isCompliant: bool) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, isCompliant): - """ __new__(cls: type, isCompliant: bool) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - IsCompliant = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the Boolean value indicating whether the indicated program element is CLS-compliant. - - Get: IsCompliant(self: CLSCompliantAttribute) -> bool - """ - - - -class Comparison(MulticastDelegate, ICloneable, ISerializable): - # type: (object: object, method: IntPtr) - """ Comparison[T](object: object, method: IntPtr) """ - def BeginInvoke(self, x, y, callback, object): - # type: (self: Comparison[T], x: T, y: T, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: Comparison[T], x: T, y: T, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: Comparison[T], result: IAsyncResult) -> int - """ EndInvoke(self: Comparison[T], result: IAsyncResult) -> int """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, x, y): - # type: (self: Comparison[T], x: T, y: T) -> int - """ Invoke(self: Comparison[T], x: T, y: T) -> int """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class Console(object): - """ Represents the standard input, output, and error streams for console applications. This class cannot be inherited. """ - @staticmethod - def Beep(frequency=None, duration=None): - # type: () - """ - Beep() - Plays the sound of a beep through the console speaker. - Beep(frequency: int, duration: int) - Plays the sound of a beep of a specified frequency and duration through the console speaker. - - frequency: The frequency of the beep, ranging from 37 to 32767 hertz. - duration: The duration of the beep measured in milliseconds. - """ - pass - - @staticmethod - def Clear(): - # type: () - """ - Clear() - Clears the console buffer and corresponding console window of display information. - """ - pass - - @staticmethod - def MoveBufferArea(sourceLeft, sourceTop, sourceWidth, sourceHeight, targetLeft, targetTop, sourceChar=None, sourceForeColor=None, sourceBackColor=None): - # type: (sourceLeft: int, sourceTop: int, sourceWidth: int, sourceHeight: int, targetLeft: int, targetTop: int) - """ - MoveBufferArea(sourceLeft: int, sourceTop: int, sourceWidth: int, sourceHeight: int, targetLeft: int, targetTop: int) - Copies a specified source area of the screen buffer to a specified destination area. - - sourceLeft: The leftmost column of the source area. - sourceTop: The topmost row of the source area. - sourceWidth: The number of columns in the source area. - sourceHeight: The number of rows in the source area. - targetLeft: The leftmost column of the destination area. - targetTop: The topmost row of the destination area. - MoveBufferArea(sourceLeft: int, sourceTop: int, sourceWidth: int, sourceHeight: int, targetLeft: int, targetTop: int, sourceChar: Char, sourceForeColor: ConsoleColor, sourceBackColor: ConsoleColor) - Copies a specified source area of the screen buffer to a specified destination area. - - sourceLeft: The leftmost column of the source area. - sourceTop: The topmost row of the source area. - sourceWidth: The number of columns in the source area. - sourceHeight: The number of rows in the source area. - targetLeft: The leftmost column of the destination area. - targetTop: The topmost row of the destination area. - sourceChar: The character used to fill the source area. - sourceForeColor: The foreground color used to fill the source area. - sourceBackColor: The background color used to fill the source area. - """ - pass - - @staticmethod - def OpenStandardError(bufferSize=None): - # type: () -> Stream - """ - OpenStandardError() -> Stream - - Acquires the standard error stream. - Returns: The standard error stream. - OpenStandardError(bufferSize: int) -> Stream - - Acquires the standard error stream, which is set to a specified buffer size. - - bufferSize: The internal stream buffer size. - Returns: The standard error stream. - """ - pass - - @staticmethod - def OpenStandardInput(bufferSize=None): - # type: () -> Stream - """ - OpenStandardInput() -> Stream - - Acquires the standard input stream. - Returns: The standard input stream. - OpenStandardInput(bufferSize: int) -> Stream - - Acquires the standard input stream, which is set to a specified buffer size. - - bufferSize: The internal stream buffer size. - Returns: The standard input stream. - """ - pass - - @staticmethod - def OpenStandardOutput(bufferSize=None): - # type: () -> Stream - """ - OpenStandardOutput() -> Stream - - Acquires the standard output stream. - Returns: The standard output stream. - OpenStandardOutput(bufferSize: int) -> Stream - - Acquires the standard output stream, which is set to a specified buffer size. - - bufferSize: The internal stream buffer size. - Returns: The standard output stream. - """ - pass - - @staticmethod - def Read(): - # type: () -> int - """ - Read() -> int - - Reads the next character from the standard input stream. - Returns: The next character from the input stream, or negative one (-1) if there are currently no more characters to be read. - """ - pass - - @staticmethod - def ReadKey(intercept=None): - # type: () -> ConsoleKeyInfo - """ - ReadKey() -> ConsoleKeyInfo - - Obtains the next character or function key pressed by the user. The pressed key is displayed in the console window. - Returns: A System.ConsoleKeyInfo object that describes the System.ConsoleKey constant and Unicode character, if any, that correspond to the pressed console key. The System.ConsoleKeyInfo object also describes, in a bitwise combination of - System.ConsoleModifiers values, whether one or more SHIFT, ALT, or CTRL modifier keys was pressed simultaneously with the console key. - - ReadKey(intercept: bool) -> ConsoleKeyInfo - - Obtains the next character or function key pressed by the user. The pressed key is optionally displayed in the console window. - - intercept: Determines whether to display the pressed key in the console window. true to not display the pressed key; otherwise, false. - Returns: A System.ConsoleKeyInfo object that describes the System.ConsoleKey constant and Unicode character, if any, that correspond to the pressed console key. The System.ConsoleKeyInfo object also describes, in a bitwise combination of - System.ConsoleModifiers values, whether one or more SHIFT, ALT, or CTRL modifier keys was pressed simultaneously with the console key. - """ - pass - - @staticmethod - def ReadLine(): - # type: () -> str - """ - ReadLine() -> str - - Reads the next line of characters from the standard input stream. - Returns: The next line of characters from the input stream, or null if no more lines are available. - """ - pass - - @staticmethod - def ResetColor(): - # type: () - """ - ResetColor() - Sets the foreground and background console colors to their defaults. - """ - pass - - @staticmethod - def SetBufferSize(width, height): - # type: (width: int, height: int) - """ - SetBufferSize(width: int, height: int) - Sets the height and width of the screen buffer area to the specified values. - - width: The width of the buffer area measured in columns. - height: The height of the buffer area measured in rows. - """ - pass - - @staticmethod - def SetCursorPosition(left, top): - # type: (left: int, top: int) - """ - SetCursorPosition(left: int, top: int) - Sets the position of the cursor. - - left: The column position of the cursor. - top: The row position of the cursor. - """ - pass - - @staticmethod - def SetError(newError): - # type: (newError: TextWriter) - """ - SetError(newError: TextWriter) - Sets the System.Console.Error property to the specified System.IO.TextWriter object. - - newError: A stream that is the new standard error output. - """ - pass - - @staticmethod - def SetIn(newIn): - # type: (newIn: TextReader) - """ - SetIn(newIn: TextReader) - Sets the System.Console.In property to the specified System.IO.TextReader object. - - newIn: A stream that is the new standard input. - """ - pass - - @staticmethod - def SetOut(newOut): - # type: (newOut: TextWriter) - """ - SetOut(newOut: TextWriter) - Sets the System.Console.Out property to the specified System.IO.TextWriter object. - - newOut: A stream that is the new standard output. - """ - pass - - @staticmethod - def SetWindowPosition(left, top): - # type: (left: int, top: int) - """ - SetWindowPosition(left: int, top: int) - Sets the position of the console window relative to the screen buffer. - - left: The column position of the upper left corner of the console window. - top: The row position of the upper left corner of the console window. - """ - pass - - @staticmethod - def SetWindowSize(width, height): - # type: (width: int, height: int) - """ - SetWindowSize(width: int, height: int) - Sets the height and width of the console window to the specified values. - - width: The width of the console window measured in columns. - height: The height of the console window measured in rows. - """ - pass - - @staticmethod - def Write(*__args): - # type: (format: str, arg0: object) - """ - Write(format: str, arg0: object) - Writes the text representation of the specified object to the standard output stream using the specified format information. - - format: A composite format string (see Remarks). - arg0: An object to write using format. - Write(value: UInt64) - Writes the text representation of the specified 64-bit unsigned integer value to the standard output stream. - - value: The value to write. - Write(value: Int64) - Writes the text representation of the specified 64-bit signed integer value to the standard output stream. - - value: The value to write. - Write(value: UInt32) - Writes the text representation of the specified 32-bit unsigned integer value to the standard output stream. - - value: The value to write. - Write(value: int) - Writes the text representation of the specified 32-bit signed integer value to the standard output stream. - - value: The value to write. - Write(value: Single) - Writes the text representation of the specified single-precision floating-point value to the standard output stream. - - value: The value to write. - Write(value: Decimal) - Writes the text representation of the specified System.Decimal value to the standard output stream. - - value: The value to write. - Write(value: float) - Writes the text representation of the specified double-precision floating-point value to the standard output stream. - - value: The value to write. - Write(buffer: Array[Char], index: int, count: int) - Writes the specified subarray of Unicode characters to the standard output stream. - - buffer: An array of Unicode characters. - index: The starting position in buffer. - count: The number of characters to write. - Write(buffer: Array[Char]) - Writes the specified array of Unicode characters to the standard output stream. - - buffer: A Unicode character array. - Write(value: Char) - Writes the specified Unicode character value to the standard output stream. - - value: The value to write. - Write(value: bool) - Writes the text representation of the specified Boolean value to the standard output stream. - - value: The value to write. - Write(format: str, *arg: Array[object]) - Writes the text representation of the specified array of objects to the standard output stream using the specified format information. - - format: A composite format string (see Remarks). - arg: An array of objects to write using format. - Write(format: str, arg0: object, arg1: object, arg2: object, arg3: object) - Writes the text representation of the specified objects and variable-length parameter list to the standard output stream using the specified format information. - - format: A composite format string (see Remarks). - arg0: The first object to write using format. - arg1: The second object to write using format. - arg2: The third object to write using format. - arg3: The fourth object to write using format. - Write(format: str, arg0: object, arg1: object, arg2: object) - Writes the text representation of the specified objects to the standard output stream using the specified format information. - - format: A composite format string (see Remarks). - arg0: The first object to write using format. - arg1: The second object to write using format. - arg2: The third object to write using format. - Write(format: str, arg0: object, arg1: object) - Writes the text representation of the specified objects to the standard output stream using the specified format information. - - format: A composite format string (see Remarks). - arg0: The first object to write using format. - arg1: The second object to write using format. - Write(value: object) - Writes the text representation of the specified object to the standard output stream. - - value: The value to write, or null. - Write(value: str) - Writes the specified string value to the standard output stream. - - value: The value to write. - """ - pass - - @staticmethod - def WriteLine(*__args): - # type: () - """ - WriteLine() - Writes the current line terminator to the standard output stream. - WriteLine(format: str, arg0: object, arg1: object, arg2: object) - Writes the text representation of the specified objects, followed by the current line terminator, to the standard output stream using the specified format information. - - format: A composite format string (see Remarks). - arg0: The first object to write using format. - arg1: The second object to write using format. - arg2: The third object to write using format. - WriteLine(format: str, arg0: object, arg1: object) - Writes the text representation of the specified objects, followed by the current line terminator, to the standard output stream using the specified format information. - - format: A composite format string (see Remarks). - arg0: The first object to write using format. - arg1: The second object to write using format. - WriteLine(format: str, arg0: object) - Writes the text representation of the specified object, followed by the current line terminator, to the standard output stream using the specified format information. - - format: A composite format string (see Remarks). - arg0: An object to write using format. - WriteLine(value: str) - Writes the specified string value, followed by the current line terminator, to the standard output stream. - - value: The value to write. - WriteLine(value: object) - Writes the text representation of the specified object, followed by the current line terminator, to the standard output stream. - - value: The value to write. - WriteLine(value: UInt64) - Writes the text representation of the specified 64-bit unsigned integer value, followed by the current line terminator, to the standard output stream. - - value: The value to write. - WriteLine(value: Int64) - Writes the text representation of the specified 64-bit signed integer value, followed by the current line terminator, to the standard output stream. - - value: The value to write. - WriteLine(format: str, arg0: object, arg1: object, arg2: object, arg3: object) - Writes the text representation of the specified objects and variable-length parameter list, followed by the current line terminator, to the standard output stream using the specified format information. - - format: A composite format string (see Remarks). - arg0: The first object to write using format. - arg1: The second object to write using format. - arg2: The third object to write using format. - arg3: The fourth object to write using format. - WriteLine(value: UInt32) - Writes the text representation of the specified 32-bit unsigned integer value, followed by the current line terminator, to the standard output stream. - - value: The value to write. - WriteLine(value: Single) - Writes the text representation of the specified single-precision floating-point value, followed by the current line terminator, to the standard output stream. - - value: The value to write. - WriteLine(value: float) - Writes the text representation of the specified double-precision floating-point value, followed by the current line terminator, to the standard output stream. - - value: The value to write. - WriteLine(value: Decimal) - Writes the text representation of the specified System.Decimal value, followed by the current line terminator, to the standard output stream. - - value: The value to write. - WriteLine(buffer: Array[Char], index: int, count: int) - Writes the specified subarray of Unicode characters, followed by the current line terminator, to the standard output stream. - - buffer: An array of Unicode characters. - index: The starting position in buffer. - count: The number of characters to write. - WriteLine(buffer: Array[Char]) - Writes the specified array of Unicode characters, followed by the current line terminator, to the standard output stream. - - buffer: A Unicode character array. - WriteLine(value: Char) - Writes the specified Unicode character, followed by the current line terminator, value to the standard output stream. - - value: The value to write. - WriteLine(value: bool) - Writes the text representation of the specified Boolean value, followed by the current line terminator, to the standard output stream. - - value: The value to write. - WriteLine(value: int) - Writes the text representation of the specified 32-bit signed integer value, followed by the current line terminator, to the standard output stream. - - value: The value to write. - WriteLine(format: str, *arg: Array[object]) - Writes the text representation of the specified array of objects, followed by the current line terminator, to the standard output stream using the specified format information. - - format: A composite format string (see Remarks). - arg: An array of objects to write using format. - """ - pass - - BackgroundColor = None - BufferHeight = 3000 - BufferWidth = 282 - CancelKeyPress = None - CapsLock = False - CursorLeft = 0 - CursorSize = 25 - CursorTop = 2463 - CursorVisible = True - Error = None - ForegroundColor = None - In = None - InputEncoding = None - IsErrorRedirected = False - IsInputRedirected = False - IsOutputRedirected = False - KeyAvailable = False - LargestWindowHeight = 427 - LargestWindowWidth = 1257 - NumberLock = True - Out = None - OutputEncoding = None - Title = ' ' - TreatControlCAsInput = False - WindowHeight = 32 - WindowLeft = 0 - WindowTop = 2432 - WindowWidth = 282 - __all__ = [ - 'Beep', - 'CancelKeyPress', - 'Clear', - 'MoveBufferArea', - 'OpenStandardError', - 'OpenStandardInput', - 'OpenStandardOutput', - 'Read', - 'ReadKey', - 'ReadLine', - 'ResetColor', - 'SetBufferSize', - 'SetCursorPosition', - 'SetError', - 'SetIn', - 'SetOut', - 'SetWindowPosition', - 'SetWindowSize', - 'Write', - 'WriteLine', - ] - - -class ConsoleCancelEventArgs(EventArgs): - """ Provides data for the System.Console.CancelKeyPress event. This class cannot be inherited. """ - Cancel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (CTRL+C) terminates the current process. - """ - Gets or sets a value indicating whether simultaneously pressing the System.ConsoleModifiers.Control modifier key and System.ConsoleKey.C console key (CTRL+C) terminates the current process. - - Get: Cancel(self: ConsoleCancelEventArgs) -> bool - - Set: Cancel(self: ConsoleCancelEventArgs) = value - """ - - SpecialKey = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the combination of modifier and console keys that interrupted the current process. - - Get: SpecialKey(self: ConsoleCancelEventArgs) -> ConsoleSpecialKey - """ - - - -class ConsoleCancelEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the System.Console.CancelKeyPress event of a System.Console. - - ConsoleCancelEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: ConsoleCancelEventHandler, sender: object, e: ConsoleCancelEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: ConsoleCancelEventHandler, sender: object, e: ConsoleCancelEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: ConsoleCancelEventHandler, result: IAsyncResult) - """ EndInvoke(self: ConsoleCancelEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: ConsoleCancelEventHandler, sender: object, e: ConsoleCancelEventArgs) - """ Invoke(self: ConsoleCancelEventHandler, sender: object, e: ConsoleCancelEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class ConsoleColor(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies constants that define foreground and background colors for the console. - - enum ConsoleColor, values: Black (0), Blue (9), Cyan (11), DarkBlue (1), DarkCyan (3), DarkGray (8), DarkGreen (2), DarkMagenta (5), DarkRed (4), DarkYellow (6), Gray (7), Green (10), Magenta (13), Red (12), White (15), Yellow (14) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Black = None - Blue = None - Cyan = None - DarkBlue = None - DarkCyan = None - DarkGray = None - DarkGreen = None - DarkMagenta = None - DarkRed = None - DarkYellow = None - Gray = None - Green = None - Magenta = None - Red = None - value__ = None - White = None - Yellow = None - - -class ConsoleKey(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies the standard keys on a console. - - enum ConsoleKey, values: A (65), Add (107), Applications (93), Attention (246), B (66), Backspace (8), BrowserBack (166), BrowserFavorites (171), BrowserForward (167), BrowserHome (172), BrowserRefresh (168), BrowserSearch (170), BrowserStop (169), C (67), Clear (12), CrSel (247), D (68), D0 (48), D1 (49), D2 (50), D3 (51), D4 (52), D5 (53), D6 (54), D7 (55), D8 (56), D9 (57), Decimal (110), Delete (46), Divide (111), DownArrow (40), E (69), End (35), Enter (13), EraseEndOfFile (249), Escape (27), Execute (43), ExSel (248), F (70), F1 (112), F10 (121), F11 (122), F12 (123), F13 (124), F14 (125), F15 (126), F16 (127), F17 (128), F18 (129), F19 (130), F2 (113), F20 (131), F21 (132), F22 (133), F23 (134), F24 (135), F3 (114), F4 (115), F5 (116), F6 (117), F7 (118), F8 (119), F9 (120), G (71), H (72), Help (47), Home (36), I (73), Insert (45), J (74), K (75), L (76), LaunchApp1 (182), LaunchApp2 (183), LaunchMail (180), LaunchMediaSelect (181), LeftArrow (37), LeftWindows (91), M (77), MediaNext (176), MediaPlay (179), MediaPrevious (177), MediaStop (178), Multiply (106), N (78), NoName (252), NumPad0 (96), NumPad1 (97), NumPad2 (98), NumPad3 (99), NumPad4 (100), NumPad5 (101), NumPad6 (102), NumPad7 (103), NumPad8 (104), NumPad9 (105), O (79), Oem1 (186), Oem102 (226), Oem2 (191), Oem3 (192), Oem4 (219), Oem5 (220), Oem6 (221), Oem7 (222), Oem8 (223), OemClear (254), OemComma (188), OemMinus (189), OemPeriod (190), OemPlus (187), P (80), Pa1 (253), Packet (231), PageDown (34), PageUp (33), Pause (19), Play (250), Print (42), PrintScreen (44), Process (229), Q (81), R (82), RightArrow (39), RightWindows (92), S (83), Select (41), Separator (108), Sleep (95), Spacebar (32), Subtract (109), T (84), Tab (9), U (85), UpArrow (38), V (86), VolumeDown (174), VolumeMute (173), VolumeUp (175), W (87), X (88), Y (89), Z (90), Zoom (251) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - A = None - Add = None - Applications = None - Attention = None - B = None - Backspace = None - BrowserBack = None - BrowserFavorites = None - BrowserForward = None - BrowserHome = None - BrowserRefresh = None - BrowserSearch = None - BrowserStop = None - C = None - Clear = None - CrSel = None - D = None - D0 = None - D1 = None - D2 = None - D3 = None - D4 = None - D5 = None - D6 = None - D7 = None - D8 = None - D9 = None - Decimal = None - Delete = None - Divide = None - DownArrow = None - E = None - End = None - Enter = None - EraseEndOfFile = None - Escape = None - Execute = None - ExSel = None - F = None - F1 = None - F10 = None - F11 = None - F12 = None - F13 = None - F14 = None - F15 = None - F16 = None - F17 = None - F18 = None - F19 = None - F2 = None - F20 = None - F21 = None - F22 = None - F23 = None - F24 = None - F3 = None - F4 = None - F5 = None - F6 = None - F7 = None - F8 = None - F9 = None - G = None - H = None - Help = None - Home = None - I = None - Insert = None - J = None - K = None - L = None - LaunchApp1 = None - LaunchApp2 = None - LaunchMail = None - LaunchMediaSelect = None - LeftArrow = None - LeftWindows = None - M = None - MediaNext = None - MediaPlay = None - MediaPrevious = None - MediaStop = None - Multiply = None - N = None - NoName = None - NumPad0 = None - NumPad1 = None - NumPad2 = None - NumPad3 = None - NumPad4 = None - NumPad5 = None - NumPad6 = None - NumPad7 = None - NumPad8 = None - NumPad9 = None - O = None - Oem1 = None - Oem102 = None - Oem2 = None - Oem3 = None - Oem4 = None - Oem5 = None - Oem6 = None - Oem7 = None - Oem8 = None - OemClear = None - OemComma = None - OemMinus = None - OemPeriod = None - OemPlus = None - P = None - Pa1 = None - Packet = None - PageDown = None - PageUp = None - Pause = None - Play = None - Print = None - PrintScreen = None - Process = None - Q = None - R = None - RightArrow = None - RightWindows = None - S = None - Select = None - Separator = None - Sleep = None - Spacebar = None - Subtract = None - T = None - Tab = None - U = None - UpArrow = None - V = None - value__ = None - VolumeDown = None - VolumeMute = None - VolumeUp = None - W = None - X = None - Y = None - Z = None - Zoom = None - - -class ConsoleKeyInfo(object): - """ - Describes the console key that was pressed, including the character represented by the console key and the state of the SHIFT, ALT, and CTRL modifier keys. - - ConsoleKeyInfo(keyChar: Char, key: ConsoleKey, shift: bool, alt: bool, control: bool) - """ - def Equals(self, *__args): - # type: (self: ConsoleKeyInfo, value: object) -> bool - """ - Equals(self: ConsoleKeyInfo, value: object) -> bool - - Gets a value indicating whether the specified object is equal to the current System.ConsoleKeyInfo object. - - value: An object to compare to the current System.ConsoleKeyInfo object. - Returns: true if value is a System.ConsoleKeyInfo object and is equal to the current System.ConsoleKeyInfo object; otherwise, false. - Equals(self: ConsoleKeyInfo, obj: ConsoleKeyInfo) -> bool - - Gets a value indicating whether the specified System.ConsoleKeyInfo object is equal to the current System.ConsoleKeyInfo object. - - obj: An object to compare to the current System.ConsoleKeyInfo object. - Returns: true if obj is equal to the current System.ConsoleKeyInfo object; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: ConsoleKeyInfo) -> int - """ - GetHashCode(self: ConsoleKeyInfo) -> int - - Returns the hash code for the current System.ConsoleKeyInfo object. - Returns: A 32-bit signed integer hash code. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - @staticmethod # known case of __new__ - def __new__(self, keyChar, key, shift, alt, control): - """ - __new__[ConsoleKeyInfo]() -> ConsoleKeyInfo - - __new__(cls: type, keyChar: Char, key: ConsoleKey, shift: bool, alt: bool, control: bool) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - Key = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the console key represented by the current System.ConsoleKeyInfo object. - - Get: Key(self: ConsoleKeyInfo) -> ConsoleKey - """ - - KeyChar = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the Unicode character represented by the current System.ConsoleKeyInfo object. - - Get: KeyChar(self: ConsoleKeyInfo) -> Char - """ - - Modifiers = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a bitwise combination of System.ConsoleModifiers values that specifies one or more modifier keys pressed simultaneously with the console key. - - Get: Modifiers(self: ConsoleKeyInfo) -> ConsoleModifiers - """ - - - -class ConsoleModifiers(Enum, IComparable, IFormattable, IConvertible): - """ - Represents the SHIFT, ALT, and CTRL modifier keys on a keyboard. - - enum (flags) ConsoleModifiers, values: Alt (1), Control (4), Shift (2) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Alt = None - Control = None - Shift = None - value__ = None - - -class ConsoleSpecialKey(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies combinations of modifier and console keys that can interrupt the current process. - - enum ConsoleSpecialKey, values: ControlBreak (1), ControlC (0) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ControlBreak = None - ControlC = None - value__ = None - - -class ContextBoundObject(MarshalByRefObject): - """ Defines the base class for all context-bound classes. """ - -class ContextMarshalException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when an attempt to marshal an object across a context boundary fails. - - ContextMarshalException() - ContextMarshalException(message: str) - ContextMarshalException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class ContextStaticAttribute(Attribute, _Attribute): - """ - Indicates that the value of a static field is unique for a particular context. - - ContextStaticAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class Convert(object): - """ Converts a base data type to another base data type. """ - @staticmethod - def ChangeType(value, *__args): - # type: (value: object, typeCode: TypeCode) -> object - """ - ChangeType(value: object, typeCode: TypeCode) -> object - - Returns an object of the specified type whose value is equivalent to the specified object. - - value: An object that implements the System.IConvertible interface. - typeCode: The type of object to return. - Returns: An object whose underlying type is typeCode and whose value is equivalent to value.-or-A null reference (Nothing in Visual Basic), if value is null and typeCode is System.TypeCode.Empty, System.TypeCode.String, or System.TypeCode.Object. - ChangeType(value: object, typeCode: TypeCode, provider: IFormatProvider) -> object - - Returns an object of the specified type whose value is equivalent to the specified object. A parameter supplies culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - typeCode: The type of object to return. - provider: An object that supplies culture-specific formatting information. - Returns: An object whose underlying type is typeCode and whose value is equivalent to value.-or- A null reference (Nothing in Visual Basic), if value is null and typeCode is System.TypeCode.Empty, System.TypeCode.String, or System.TypeCode.Object. - ChangeType(value: object, conversionType: Type) -> object - - Returns an object of the specified type and whose value is equivalent to the specified object. - - value: An object that implements the System.IConvertible interface. - conversionType: The type of object to return. - Returns: An object whose type is conversionType and whose value is equivalent to value.-or-A null reference (Nothing in Visual Basic), if value is null and conversionType is not a value type. - ChangeType(value: object, conversionType: Type, provider: IFormatProvider) -> object - - Returns an object of the specified type whose value is equivalent to the specified object. A parameter supplies culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - conversionType: The type of object to return. - provider: An object that supplies culture-specific formatting information. - Returns: An object whose type is conversionType and whose value is equivalent to value.-or- value, if the System.Type of value and conversionType are equal.-or- A null reference (Nothing in Visual Basic), if value is null and conversionType is not a value type. - """ - pass - - @staticmethod - def FromBase64CharArray(inArray, offset, length): - # type: (inArray: Array[Char], offset: int, length: int) -> Array[Byte] - """ - FromBase64CharArray(inArray: Array[Char], offset: int, length: int) -> Array[Byte] - - Converts a subset of a Unicode character array, which encodes binary data as base-64 digits, to an equivalent 8-bit unsigned integer array. Parameters specify the subset in the input array and the number of elements to convert. - - inArray: A Unicode character array. - offset: A position within inArray. - length: The number of elements in inArray to convert. - Returns: An array of 8-bit unsigned integers equivalent to length elements at position offset in inArray. - """ - pass - - @staticmethod - def FromBase64String(s): - # type: (s: str) -> Array[Byte] - """ - FromBase64String(s: str) -> Array[Byte] - - Converts the specified string, which encodes binary data as base-64 digits, to an equivalent 8-bit unsigned integer array. - - s: The string to convert. - Returns: An array of 8-bit unsigned integers that is equivalent to s. - """ - pass - - @staticmethod - def GetTypeCode(value): - # type: (value: object) -> TypeCode - """ - GetTypeCode(value: object) -> TypeCode - - Returns the System.TypeCode for the specified object. - - value: An object that implements the System.IConvertible interface. - Returns: The System.TypeCode for value, or System.TypeCode.Empty if value is null. - """ - pass - - @staticmethod - def IsDBNull(value): - # type: (value: object) -> bool - """ - IsDBNull(value: object) -> bool - - Returns an indication whether the specified object is of type System.DBNull. - - value: An object. - Returns: true if value is of type System.DBNull; otherwise, false. - """ - pass - - @staticmethod - def ToBase64CharArray(inArray, offsetIn, length, outArray, offsetOut, options=None): - # type: (inArray: Array[Byte], offsetIn: int, length: int, outArray: Array[Char], offsetOut: int) -> int - """ - ToBase64CharArray(inArray: Array[Byte], offsetIn: int, length: int, outArray: Array[Char], offsetOut: int) -> int - - Converts a subset of an 8-bit unsigned integer array to an equivalent subset of a Unicode character array encoded with base-64 digits. Parameters specify the subsets as offsets in the input and output arrays, and the number of elements in the input - array to convert. - - - inArray: An input array of 8-bit unsigned integers. - offsetIn: A position within inArray. - length: The number of elements of inArray to convert. - outArray: An output array of Unicode characters. - offsetOut: A position within outArray. - Returns: A 32-bit signed integer containing the number of bytes in outArray. - ToBase64CharArray(inArray: Array[Byte], offsetIn: int, length: int, outArray: Array[Char], offsetOut: int, options: Base64FormattingOptions) -> int - - Converts a subset of an 8-bit unsigned integer array to an equivalent subset of a Unicode character array encoded with base-64 digits. Parameters specify the subsets as offsets in the input and output arrays, the number of elements in the input array - to convert, and whether line breaks are inserted in the output array. - - - inArray: An input array of 8-bit unsigned integers. - offsetIn: A position within inArray. - length: The number of elements of inArray to convert. - outArray: An output array of Unicode characters. - offsetOut: A position within outArray. - options: System.Base64FormattingOptions.InsertLineBreaks to insert a line break every 76 characters, or System.Base64FormattingOptions.None to not insert line breaks. - Returns: A 32-bit signed integer containing the number of bytes in outArray. - """ - pass - - @staticmethod - def ToBase64String(inArray, *__args): - # type: (inArray: Array[Byte]) -> str - """ - ToBase64String(inArray: Array[Byte]) -> str - - Converts an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits. - - inArray: An array of 8-bit unsigned integers. - Returns: The string representation, in base 64, of the contents of inArray. - ToBase64String(inArray: Array[Byte], options: Base64FormattingOptions) -> str - - Converts an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits. A parameter specifies whether to insert line breaks in the return value. - - inArray: An array of 8-bit unsigned integers. - options: System.Base64FormattingOptions.InsertLineBreaks to insert a line break every 76 characters, or System.Base64FormattingOptions.None to not insert line breaks. - Returns: The string representation in base 64 of the elements in inArray. - ToBase64String(inArray: Array[Byte], offset: int, length: int) -> str - - Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits. Parameters specify the subset as an offset in the input array, and the number of elements in the array to convert. - - inArray: An array of 8-bit unsigned integers. - offset: An offset in inArray. - length: The number of elements of inArray to convert. - Returns: The string representation in base 64 of length elements of inArray, starting at position offset. - ToBase64String(inArray: Array[Byte], offset: int, length: int, options: Base64FormattingOptions) -> str - - Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64 digits. Parameters specify the subset as an offset in the input array, the number of elements in the array to convert, and - whether to insert line breaks in the return value. - - - inArray: An array of 8-bit unsigned integers. - offset: An offset in inArray. - length: The number of elements of inArray to convert. - options: System.Base64FormattingOptions.InsertLineBreaks to insert a line break every 76 characters, or System.Base64FormattingOptions.None to not insert line breaks. - Returns: The string representation in base 64 of length elements of inArray, starting at position offset. - """ - pass - - @staticmethod - def ToBoolean(value, provider=None): - # type: (value: object) -> bool - """ - ToBoolean(value: object) -> bool - - Converts the value of a specified object to an equivalent Boolean value. - - value: An object that implements the System.IConvertible interface, or null. - Returns: true or false, which reflects the value returned by invoking the System.IConvertible.ToBoolean(System.IFormatProvider) method for the underlying type of value. If value is null, the method returns false. - ToBoolean(value: float) -> bool - - Converts the value of the specified double-precision floating-point number to an equivalent Boolean value. - - value: The double-precision floating-point number to convert. - Returns: true if value is not zero; otherwise, false. - ToBoolean(value: Single) -> bool - - Converts the value of the specified single-precision floating-point number to an equivalent Boolean value. - - value: The single-precision floating-point number to convert. - Returns: true if value is not zero; otherwise, false. - ToBoolean(value: str, provider: IFormatProvider) -> bool - - Converts the specified string representation of a logical value to its Boolean equivalent, using the specified culture-specific formatting information. - - value: A string that contains the value of either System.Boolean.TrueString or System.Boolean.FalseString. - provider: An object that supplies culture-specific formatting information. This parameter is ignored. - Returns: true if value equals System.Boolean.TrueString, or false if value equals System.Boolean.FalseString or null. - ToBoolean(value: str) -> bool - - Converts the specified string representation of a logical value to its Boolean equivalent. - - value: A string that contains the value of either System.Boolean.TrueString or System.Boolean.FalseString. - Returns: true if value equals System.Boolean.TrueString, or false if value equals System.Boolean.FalseString or null. - ToBoolean(value: UInt64) -> bool - - Converts the value of the specified 64-bit unsigned integer to an equivalent Boolean value. - - value: The 64-bit unsigned integer to convert. - Returns: true if value is not zero; otherwise, false. - ToBoolean(value: Int64) -> bool - - Converts the value of the specified 64-bit signed integer to an equivalent Boolean value. - - value: The 64-bit signed integer to convert. - Returns: true if value is not zero; otherwise, false. - ToBoolean(value: UInt32) -> bool - - Converts the value of the specified 32-bit unsigned integer to an equivalent Boolean value. - - value: The 32-bit unsigned integer to convert. - Returns: true if value is not zero; otherwise, false. - ToBoolean(value: int) -> bool - - Converts the value of the specified 32-bit signed integer to an equivalent Boolean value. - - value: The 32-bit signed integer to convert. - Returns: true if value is not zero; otherwise, false. - ToBoolean(value: UInt16) -> bool - - Converts the value of the specified 16-bit unsigned integer to an equivalent Boolean value. - - value: The 16-bit unsigned integer to convert. - Returns: true if value is not zero; otherwise, false. - ToBoolean(value: Int16) -> bool - - Converts the value of the specified 16-bit signed integer to an equivalent Boolean value. - - value: The 16-bit signed integer to convert. - Returns: true if value is not zero; otherwise, false. - ToBoolean(value: Byte) -> bool - - Converts the value of the specified 8-bit unsigned integer to an equivalent Boolean value. - - value: The 8-bit unsigned integer to convert. - Returns: true if value is not zero; otherwise, false. - ToBoolean(value: Char) -> bool - - Calling this method always throws System.InvalidCastException. - - value: The Unicode character to convert. - Returns: This conversion is not supported. No value is returned. - ToBoolean(value: SByte) -> bool - - Converts the value of the specified 8-bit signed integer to an equivalent Boolean value. - - value: The 8-bit signed integer to convert. - Returns: true if value is not zero; otherwise, false. - ToBoolean(value: bool) -> bool - - Returns the specified Boolean value; no actual conversion is performed. - - value: The Boolean value to return. - Returns: value is returned unchanged. - ToBoolean(value: object, provider: IFormatProvider) -> bool - - Converts the value of the specified object to an equivalent Boolean value, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface, or null. - provider: An object that supplies culture-specific formatting information. - Returns: true or false, which reflects the value returned by invoking the System.IConvertible.ToBoolean(System.IFormatProvider) method for the underlying type of value. If value is null, the method returns false. - ToBoolean(value: Decimal) -> bool - - Converts the value of the specified decimal number to an equivalent Boolean value. - - value: The number to convert. - Returns: true if value is not zero; otherwise, false. - ToBoolean(value: DateTime) -> bool - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - """ - pass - - @staticmethod - def ToByte(value, *__args): - # type: (value: object) -> Byte - """ - ToByte(value: object) -> Byte - - Converts the value of the specified object to an 8-bit unsigned integer. - - value: An object that implements the System.IConvertible interface, or null. - Returns: An 8-bit unsigned integer that is equivalent to value, or zero if value is null. - ToByte(value: str, provider: IFormatProvider) -> Byte - - Converts the specified string representation of a number to an equivalent 8-bit unsigned integer, using specified culture-specific formatting information. - - value: A string that contains the number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: An 8-bit unsigned integer that is equivalent to value, or zero if value is null. - ToByte(value: str) -> Byte - - Converts the specified string representation of a number to an equivalent 8-bit unsigned integer. - - value: A string that contains the number to convert. - Returns: An 8-bit unsigned integer that is equivalent to value, or zero if value is null. - ToByte(value: Decimal) -> Byte - - Converts the value of the specified decimal number to an equivalent 8-bit unsigned integer. - - value: The number to convert. - Returns: value, rounded to the nearest 8-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToByte(value: float) -> Byte - - Converts the value of the specified double-precision floating-point number to an equivalent 8-bit unsigned integer. - - value: The double-precision floating-point number to convert. - Returns: value, rounded to the nearest 8-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToByte(value: Single) -> Byte - - Converts the value of the specified single-precision floating-point number to an equivalent 8-bit unsigned integer. - - value: A single-precision floating-point number. - Returns: value, rounded to the nearest 8-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToByte(value: UInt64) -> Byte - - Converts the value of the specified 64-bit unsigned integer to an equivalent 8-bit unsigned integer. - - value: The 64-bit unsigned integer to convert. - Returns: An 8-bit unsigned integer that is equivalent to value. - ToByte(value: Int64) -> Byte - - Converts the value of the specified 64-bit signed integer to an equivalent 8-bit unsigned integer. - - value: The 64-bit signed integer to convert. - Returns: An 8-bit unsigned integer that is equivalent to value. - ToByte(value: DateTime) -> Byte - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - ToByte(value: UInt32) -> Byte - - Converts the value of the specified 32-bit unsigned integer to an equivalent 8-bit unsigned integer. - - value: The 32-bit unsigned integer to convert. - Returns: An 8-bit unsigned integer that is equivalent to value. - ToByte(value: UInt16) -> Byte - - Converts the value of the specified 16-bit unsigned integer to an equivalent 8-bit unsigned integer. - - value: The 16-bit unsigned integer to convert. - Returns: An 8-bit unsigned integer that is equivalent to value. - ToByte(value: Int16) -> Byte - - Converts the value of the specified 16-bit signed integer to an equivalent 8-bit unsigned integer. - - value: The 16-bit signed integer to convert. - Returns: An 8-bit unsigned integer that is equivalent to value. - ToByte(value: SByte) -> Byte - - Converts the value of the specified 8-bit signed integer to an equivalent 8-bit unsigned integer. - - value: The 8-bit signed integer to be converted. - Returns: An 8-bit unsigned integer that is equivalent to value. - ToByte(value: Char) -> Byte - - Converts the value of the specified Unicode character to the equivalent 8-bit unsigned integer. - - value: The Unicode character to convert. - Returns: An 8-bit unsigned integer that is equivalent to value. - ToByte(value: Byte) -> Byte - - Returns the specified 8-bit unsigned integer; no actual conversion is performed. - - value: The 8-bit unsigned integer to return. - Returns: value is returned unchanged. - ToByte(value: bool) -> Byte - - Converts the specified Boolean value to the equivalent 8-bit unsigned integer. - - value: The Boolean value to convert. - Returns: The number 1 if value is true; otherwise, 0. - ToByte(value: object, provider: IFormatProvider) -> Byte - - Converts the value of the specified object to an 8-bit unsigned integer, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: An 8-bit unsigned integer that is equivalent to value, or zero if value is null. - ToByte(value: int) -> Byte - - Converts the value of the specified 32-bit signed integer to an equivalent 8-bit unsigned integer. - - value: The 32-bit signed integer to convert. - Returns: An 8-bit unsigned integer that is equivalent to value. - ToByte(value: str, fromBase: int) -> Byte - - Converts the string representation of a number in a specified base to an equivalent 8-bit unsigned integer. - - value: A string that contains the number to convert. - fromBase: The base of the number in value, which must be 2, 8, 10, or 16. - Returns: An 8-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null. - """ - pass - - @staticmethod - def ToChar(value, provider=None): - # type: (value: object) -> Char - """ - ToChar(value: object) -> Char - - Converts the value of the specified object to a Unicode character. - - value: An object that implements the System.IConvertible interface. - Returns: A Unicode character that is equivalent to value, or System.Char.MinValue if value is null. - ToChar(value: float) -> Char - - Calling this method always throws System.InvalidCastException. - - value: The double-precision floating-point number to convert. - Returns: This conversion is not supported. No value is returned. - ToChar(value: Single) -> Char - - Calling this method always throws System.InvalidCastException. - - value: The single-precision floating-point number to convert. - Returns: This conversion is not supported. No value is returned. - ToChar(value: str, provider: IFormatProvider) -> Char - - Converts the first character of a specified string to a Unicode character, using specified culture-specific formatting information. - - value: A string of length 1 or null. - provider: An object that supplies culture-specific formatting information. This parameter is ignored. - Returns: A Unicode character that is equivalent to the first and only character in value. - ToChar(value: str) -> Char - - Converts the first character of a specified string to a Unicode character. - - value: A string of length 1. - Returns: A Unicode character that is equivalent to the first and only character in value. - ToChar(value: UInt64) -> Char - - Converts the value of the specified 64-bit unsigned integer to its equivalent Unicode character. - - value: The 64-bit unsigned integer to convert. - Returns: A Unicode character that is equivalent to value. - ToChar(value: Int64) -> Char - - Converts the value of the specified 64-bit signed integer to its equivalent Unicode character. - - value: The 64-bit signed integer to convert. - Returns: A Unicode character that is equivalent to value. - ToChar(value: UInt32) -> Char - - Converts the value of the specified 32-bit unsigned integer to its equivalent Unicode character. - - value: The 32-bit unsigned integer to convert. - Returns: A Unicode character that is equivalent to value. - ToChar(value: int) -> Char - - Converts the value of the specified 32-bit signed integer to its equivalent Unicode character. - - value: The 32-bit signed integer to convert. - Returns: A Unicode character that is equivalent to value. - ToChar(value: UInt16) -> Char - - Converts the value of the specified 16-bit unsigned integer to its equivalent Unicode character. - - value: The 16-bit unsigned integer to convert. - Returns: A Unicode character that is equivalent to value. - ToChar(value: Int16) -> Char - - Converts the value of the specified 16-bit signed integer to its equivalent Unicode character. - - value: The 16-bit signed integer to convert. - Returns: A Unicode character that is equivalent to value. - ToChar(value: Byte) -> Char - - Converts the value of the specified 8-bit unsigned integer to its equivalent Unicode character. - - value: The 8-bit unsigned integer to convert. - Returns: A Unicode character that is equivalent to value. - ToChar(value: SByte) -> Char - - Converts the value of the specified 8-bit signed integer to its equivalent Unicode character. - - value: The 8-bit signed integer to convert. - Returns: A Unicode character that is equivalent to value. - ToChar(value: Char) -> Char - - Returns the specified Unicode character value; no actual conversion is performed. - - value: The Unicode character to return. - Returns: value is returned unchanged. - ToChar(value: bool) -> Char - - Calling this method always throws System.InvalidCastException. - - value: The Boolean value to convert. - Returns: This conversion is not supported. No value is returned. - ToChar(value: object, provider: IFormatProvider) -> Char - - Converts the value of the specified object to its equivalent Unicode character, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: A Unicode character that is equivalent to value, or System.Char.MinValue if value is null. - ToChar(value: Decimal) -> Char - - Calling this method always throws System.InvalidCastException. - - value: The decimal number to convert. - Returns: This conversion is not supported. No value is returned. - ToChar(value: DateTime) -> Char - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - """ - pass - - @staticmethod - def ToDateTime(value, provider=None): - # type: (value: DateTime) -> DateTime - """ - ToDateTime(value: DateTime) -> DateTime - - Returns the specified System.DateTime object; no actual conversion is performed. - - value: A date and time value. - Returns: value is returned unchanged. - ToDateTime(value: Single) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The single-precision floating-point value to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: Char) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The Unicode character to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: bool) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The Boolean value to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: UInt64) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The 64-bit unsigned integer to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: Int64) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The 64-bit signed integer to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: UInt32) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The 32-bit unsigned integer to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: int) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The 32-bit signed integer to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: UInt16) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The 16-bit unsigned integer to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: Int16) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The 16-bit signed integer to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: Byte) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The 8-bit unsigned integer to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: SByte) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The 8-bit signed integer to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: str, provider: IFormatProvider) -> DateTime - - Converts the specified string representation of a number to an equivalent date and time, using the specified culture-specific formatting information. - - value: A string that contains a date and time to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The date and time equivalent of the value of value, or the date and time equivalent of System.DateTime.MinValue if value is null. - ToDateTime(value: str) -> DateTime - - Converts the specified string representation of a date and time to an equivalent date and time value. - - value: The string representation of a date and time. - Returns: The date and time equivalent of the value of value, or the date and time equivalent of System.DateTime.MinValue if value is null. - ToDateTime(value: object, provider: IFormatProvider) -> DateTime - - Converts the value of the specified object to a System.DateTime object, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: The date and time equivalent of the value of value, or the date and time equivalent of System.DateTime.MinValue if value is null. - ToDateTime(value: object) -> DateTime - - Converts the value of the specified object to a System.DateTime object. - - value: An object that implements the System.IConvertible interface, or null. - Returns: The date and time equivalent of the value of value, or a date and time equivalent of System.DateTime.MinValue if value is null. - ToDateTime(value: float) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The double-precision floating-point value to convert. - Returns: This conversion is not supported. No value is returned. - ToDateTime(value: Decimal) -> DateTime - - Calling this method always throws System.InvalidCastException. - - value: The number to convert. - Returns: This conversion is not supported. No value is returned. - """ - pass - - @staticmethod - def ToDecimal(value, provider=None): - # type: (value: object) -> Decimal - """ - ToDecimal(value: object) -> Decimal - - Converts the value of the specified object to an equivalent decimal number. - - value: An object that implements the System.IConvertible interface, or null. - Returns: A decimal number that is equivalent to value, or 0 (zero) if value is null. - ToDecimal(value: Decimal) -> Decimal - - Returns the specified decimal number; no actual conversion is performed. - - value: A decimal number. - Returns: value is returned unchanged. - ToDecimal(value: str, provider: IFormatProvider) -> Decimal - - Converts the specified string representation of a number to an equivalent decimal number, using the specified culture-specific formatting information. - - value: A string that contains a number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: A decimal number that is equivalent to the number in value, or 0 (zero) if value is null. - ToDecimal(value: str) -> Decimal - - Converts the specified string representation of a number to an equivalent decimal number. - - value: A string that contains a number to convert. - Returns: A decimal number that is equivalent to the number in value, or 0 (zero) if value is null. - ToDecimal(value: float) -> Decimal - - Converts the value of the specified double-precision floating-point number to an equivalent decimal number. - - value: The double-precision floating-point number to convert. - Returns: A decimal number that is equivalent to value. - ToDecimal(value: Single) -> Decimal - - Converts the value of the specified single-precision floating-point number to the equivalent decimal number. - - value: The single-precision floating-point number to convert. - Returns: A decimal number that is equivalent to value. - ToDecimal(value: UInt64) -> Decimal - - Converts the value of the specified 64-bit unsigned integer to an equivalent decimal number. - - value: The 64-bit unsigned integer to convert. - Returns: A decimal number that is equivalent to value. - ToDecimal(value: Int64) -> Decimal - - Converts the value of the specified 64-bit signed integer to an equivalent decimal number. - - value: The 64-bit signed integer to convert. - Returns: A decimal number that is equivalent to value. - ToDecimal(value: UInt32) -> Decimal - - Converts the value of the specified 32-bit unsigned integer to an equivalent decimal number. - - value: The 32-bit unsigned integer to convert. - Returns: A decimal number that is equivalent to value. - ToDecimal(value: int) -> Decimal - - Converts the value of the specified 32-bit signed integer to an equivalent decimal number. - - value: The 32-bit signed integer to convert. - Returns: A decimal number that is equivalent to value. - ToDecimal(value: UInt16) -> Decimal - - Converts the value of the specified 16-bit unsigned integer to an equivalent decimal number. - - value: The 16-bit unsigned integer to convert. - Returns: The decimal number that is equivalent to value. - ToDecimal(value: Int16) -> Decimal - - Converts the value of the specified 16-bit signed integer to an equivalent decimal number. - - value: The 16-bit signed integer to convert. - Returns: A decimal number that is equivalent to value. - ToDecimal(value: Char) -> Decimal - - Calling this method always throws System.InvalidCastException. - - value: The Unicode character to convert. - Returns: This conversion is not supported. No value is returned. - ToDecimal(value: Byte) -> Decimal - - Converts the value of the specified 8-bit unsigned integer to the equivalent decimal number. - - value: The 8-bit unsigned integer to convert. - Returns: The decimal number that is equivalent to value. - ToDecimal(value: SByte) -> Decimal - - Converts the value of the specified 8-bit signed integer to the equivalent decimal number. - - value: The 8-bit signed integer to convert. - Returns: A decimal number that is equivalent to value. - ToDecimal(value: object, provider: IFormatProvider) -> Decimal - - Converts the value of the specified object to an equivalent decimal number, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: A decimal number that is equivalent to value, or 0 (zero) if value is null. - ToDecimal(value: bool) -> Decimal - - Converts the specified Boolean value to the equivalent decimal number. - - value: The Boolean value to convert. - Returns: The number 1 if value is true; otherwise, 0. - ToDecimal(value: DateTime) -> Decimal - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - """ - pass - - @staticmethod - def ToDouble(value, provider=None): - # type: (value: object) -> float - """ - ToDouble(value: object) -> float - - Converts the value of the specified object to a double-precision floating-point number. - - value: An object that implements the System.IConvertible interface, or null. - Returns: A double-precision floating-point number that is equivalent to value, or zero if value is null. - ToDouble(value: str, provider: IFormatProvider) -> float - - Converts the specified string representation of a number to an equivalent double-precision floating-point number, using the specified culture-specific formatting information. - - value: A string that contains the number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: A double-precision floating-point number that is equivalent to the number in value, or 0 (zero) if value is null. - ToDouble(value: str) -> float - - Converts the specified string representation of a number to an equivalent double-precision floating-point number. - - value: A string that contains the number to convert. - Returns: A double-precision floating-point number that is equivalent to the number in value, or 0 (zero) if value is null. - ToDouble(value: Decimal) -> float - - Converts the value of the specified decimal number to an equivalent double-precision floating-point number. - - value: The decimal number to convert. - Returns: A double-precision floating-point number that is equivalent to value. - ToDouble(value: float) -> float - - Returns the specified double-precision floating-point number; no actual conversion is performed. - - value: The double-precision floating-point number to return. - Returns: value is returned unchanged. - ToDouble(value: Single) -> float - - Converts the value of the specified single-precision floating-point number to an equivalent double-precision floating-point number. - - value: The single-precision floating-point number. - Returns: A double-precision floating-point number that is equivalent to value. - ToDouble(value: UInt64) -> float - - Converts the value of the specified 64-bit unsigned integer to an equivalent double-precision floating-point number. - - value: The 64-bit unsigned integer to convert. - Returns: A double-precision floating-point number that is equivalent to value. - ToDouble(value: Int64) -> float - - Converts the value of the specified 64-bit signed integer to an equivalent double-precision floating-point number. - - value: The 64-bit signed integer to convert. - Returns: A double-precision floating-point number that is equivalent to value. - ToDouble(value: UInt32) -> float - - Converts the value of the specified 32-bit unsigned integer to an equivalent double-precision floating-point number. - - value: The 32-bit unsigned integer to convert. - Returns: A double-precision floating-point number that is equivalent to value. - ToDouble(value: int) -> float - - Converts the value of the specified 32-bit signed integer to an equivalent double-precision floating-point number. - - value: The 32-bit signed integer to convert. - Returns: A double-precision floating-point number that is equivalent to value. - ToDouble(value: UInt16) -> float - - Converts the value of the specified 16-bit unsigned integer to the equivalent double-precision floating-point number. - - value: The 16-bit unsigned integer to convert. - Returns: A double-precision floating-point number that is equivalent to value. - ToDouble(value: Char) -> float - - Calling this method always throws System.InvalidCastException. - - value: The Unicode character to convert. - Returns: This conversion is not supported. No value is returned. - ToDouble(value: Int16) -> float - - Converts the value of the specified 16-bit signed integer to an equivalent double-precision floating-point number. - - value: The 16-bit signed integer to convert. - Returns: A double-precision floating-point number equivalent to value. - ToDouble(value: Byte) -> float - - Converts the value of the specified 8-bit unsigned integer to the equivalent double-precision floating-point number. - - value: The 8-bit unsigned integer to convert. - Returns: The double-precision floating-point number that is equivalent to value. - ToDouble(value: SByte) -> float - - Converts the value of the specified 8-bit signed integer to the equivalent double-precision floating-point number. - - value: The 8-bit signed integer to convert. - Returns: The 8-bit signed integer that is equivalent to value. - ToDouble(value: object, provider: IFormatProvider) -> float - - Converts the value of the specified object to an double-precision floating-point number, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: A double-precision floating-point number that is equivalent to value, or zero if value is null. - ToDouble(value: bool) -> float - - Converts the specified Boolean value to the equivalent double-precision floating-point number. - - value: The Boolean value to convert. - Returns: The number 1 if value is true; otherwise, 0. - ToDouble(value: DateTime) -> float - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - """ - pass - - @staticmethod - def ToInt16(value, *__args): - # type: (value: object) -> Int16 - """ - ToInt16(value: object) -> Int16 - - Converts the value of the specified object to a 16-bit signed integer. - - value: An object that implements the System.IConvertible interface, or null. - Returns: A 16-bit signed integer that is equivalent to value, or zero if value is null. - ToInt16(value: str, provider: IFormatProvider) -> Int16 - - Converts the specified string representation of a number to an equivalent 16-bit signed integer, using the specified culture-specific formatting information. - - value: A string that contains the number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: A 16-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToInt16(value: str) -> Int16 - - Converts the specified string representation of a number to an equivalent 16-bit signed integer. - - value: A string that contains the number to convert. - Returns: A 16-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToInt16(value: Decimal) -> Int16 - - Converts the value of the specified decimal number to an equivalent 16-bit signed integer. - - value: The decimal number to convert. - Returns: value, rounded to the nearest 16-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToInt16(value: float) -> Int16 - - Converts the value of the specified double-precision floating-point number to an equivalent 16-bit signed integer. - - value: The double-precision floating-point number to convert. - Returns: value, rounded to the nearest 16-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToInt16(value: Single) -> Int16 - - Converts the value of the specified single-precision floating-point number to an equivalent 16-bit signed integer. - - value: The single-precision floating-point number to convert. - Returns: value, rounded to the nearest 16-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToInt16(value: UInt64) -> Int16 - - Converts the value of the specified 64-bit unsigned integer to an equivalent 16-bit signed integer. - - value: The 64-bit unsigned integer to convert. - Returns: A 16-bit signed integer that is equivalent to value. - ToInt16(value: Int64) -> Int16 - - Converts the value of the specified 64-bit signed integer to an equivalent 16-bit signed integer. - - value: The 64-bit signed integer to convert. - Returns: A 16-bit signed integer that is equivalent to value. - ToInt16(value: DateTime) -> Int16 - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - ToInt16(value: Int16) -> Int16 - - Returns the specified 16-bit signed integer; no actual conversion is performed. - - value: The 16-bit signed integer to return. - Returns: value is returned unchanged. - ToInt16(value: int) -> Int16 - - Converts the value of the specified 32-bit signed integer to an equivalent 16-bit signed integer. - - value: The 32-bit signed integer to convert. - Returns: The 16-bit signed integer equivalent of value. - ToInt16(value: UInt16) -> Int16 - - Converts the value of the specified 16-bit unsigned integer to the equivalent 16-bit signed integer. - - value: The 16-bit unsigned integer to convert. - Returns: A 16-bit signed integer that is equivalent to value. - ToInt16(value: Byte) -> Int16 - - Converts the value of the specified 8-bit unsigned integer to the equivalent 16-bit signed integer. - - value: The 8-bit unsigned integer to convert. - Returns: A 16-bit signed integer that is equivalent to value. - ToInt16(value: SByte) -> Int16 - - Converts the value of the specified 8-bit signed integer to the equivalent 16-bit signed integer. - - value: The 8-bit signed integer to convert. - Returns: A 8-bit signed integer that is equivalent to value. - ToInt16(value: Char) -> Int16 - - Converts the value of the specified Unicode character to the equivalent 16-bit signed integer. - - value: The Unicode character to convert. - Returns: A 16-bit signed integer that is equivalent to value. - ToInt16(value: bool) -> Int16 - - Converts the specified Boolean value to the equivalent 16-bit signed integer. - - value: The Boolean value to convert. - Returns: The number 1 if value is true; otherwise, 0. - ToInt16(value: object, provider: IFormatProvider) -> Int16 - - Converts the value of the specified object to a 16-bit signed integer, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: A 16-bit signed integer that is equivalent to value, or zero if value is null. - ToInt16(value: UInt32) -> Int16 - - Converts the value of the specified 32-bit unsigned integer to an equivalent 16-bit signed integer. - - value: The 32-bit unsigned integer to convert. - Returns: A 16-bit signed integer that is equivalent to value. - ToInt16(value: str, fromBase: int) -> Int16 - - Converts the string representation of a number in a specified base to an equivalent 16-bit signed integer. - - value: A string that contains the number to convert. - fromBase: The base of the number in value, which must be 2, 8, 10, or 16. - Returns: A 16-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - """ - pass - - @staticmethod - def ToInt32(value, *__args): - # type: (value: object) -> int - """ - ToInt32(value: object) -> int - - Converts the value of the specified object to a 32-bit signed integer. - - value: An object that implements the System.IConvertible interface, or null. - Returns: A 32-bit signed integer equivalent to value, or zero if value is null. - ToInt32(value: str, provider: IFormatProvider) -> int - - Converts the specified string representation of a number to an equivalent 32-bit signed integer, using the specified culture-specific formatting information. - - value: A string that contains the number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: A 32-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToInt32(value: str) -> int - - Converts the specified string representation of a number to an equivalent 32-bit signed integer. - - value: A string that contains the number to convert. - Returns: A 32-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToInt32(value: Decimal) -> int - - Converts the value of the specified decimal number to an equivalent 32-bit signed integer. - - value: The decimal number to convert. - Returns: value, rounded to the nearest 32-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToInt32(value: float) -> int - - Converts the value of the specified double-precision floating-point number to an equivalent 32-bit signed integer. - - value: The double-precision floating-point number to convert. - Returns: value, rounded to the nearest 32-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToInt32(value: Single) -> int - - Converts the value of the specified single-precision floating-point number to an equivalent 32-bit signed integer. - - value: The single-precision floating-point number to convert. - Returns: value, rounded to the nearest 32-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToInt32(value: UInt64) -> int - - Converts the value of the specified 64-bit unsigned integer to an equivalent 32-bit signed integer. - - value: The 64-bit unsigned integer to convert. - Returns: A 32-bit signed integer that is equivalent to value. - ToInt32(value: Int64) -> int - - Converts the value of the specified 64-bit signed integer to an equivalent 32-bit signed integer. - - value: The 64-bit signed integer to convert. - Returns: A 32-bit signed integer that is equivalent to value. - ToInt32(value: DateTime) -> int - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - ToInt32(value: int) -> int - - Returns the specified 32-bit signed integer; no actual conversion is performed. - - value: The 32-bit signed integer to return. - Returns: value is returned unchanged. - ToInt32(value: UInt16) -> int - - Converts the value of the specified 16-bit unsigned integer to the equivalent 32-bit signed integer. - - value: The 16-bit unsigned integer to convert. - Returns: A 32-bit signed integer that is equivalent to value. - ToInt32(value: Int16) -> int - - Converts the value of the specified 16-bit signed integer to an equivalent 32-bit signed integer. - - value: The 16-bit signed integer to convert. - Returns: A 32-bit signed integer that is equivalent to value. - ToInt32(value: Byte) -> int - - Converts the value of the specified 8-bit unsigned integer to the equivalent 32-bit signed integer. - - value: The 8-bit unsigned integer to convert. - Returns: A 32-bit signed integer that is equivalent to value. - ToInt32(value: SByte) -> int - - Converts the value of the specified 8-bit signed integer to the equivalent 32-bit signed integer. - - value: The 8-bit signed integer to convert. - Returns: A 8-bit signed integer that is equivalent to value. - ToInt32(value: Char) -> int - - Converts the value of the specified Unicode character to the equivalent 32-bit signed integer. - - value: The Unicode character to convert. - Returns: A 32-bit signed integer that is equivalent to value. - ToInt32(value: bool) -> int - - Converts the specified Boolean value to the equivalent 32-bit signed integer. - - value: The Boolean value to convert. - Returns: The number 1 if value is true; otherwise, 0. - ToInt32(value: object, provider: IFormatProvider) -> int - - Converts the value of the specified object to a 32-bit signed integer, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: A 32-bit signed integer that is equivalent to value, or zero if value is null. - ToInt32(value: UInt32) -> int - - Converts the value of the specified 32-bit unsigned integer to an equivalent 32-bit signed integer. - - value: The 32-bit unsigned integer to convert. - Returns: A 32-bit signed integer that is equivalent to value. - ToInt32(value: str, fromBase: int) -> int - - Converts the string representation of a number in a specified base to an equivalent 32-bit signed integer. - - value: A string that contains the number to convert. - fromBase: The base of the number in value, which must be 2, 8, 10, or 16. - Returns: A 32-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - """ - pass - - @staticmethod - def ToInt64(value, *__args): - # type: (value: object) -> Int64 - """ - ToInt64(value: object) -> Int64 - - Converts the value of the specified object to a 64-bit signed integer. - - value: An object that implements the System.IConvertible interface, or null. - Returns: A 64-bit signed integer that is equivalent to value, or zero if value is null. - ToInt64(value: str, provider: IFormatProvider) -> Int64 - - Converts the specified string representation of a number to an equivalent 64-bit signed integer, using the specified culture-specific formatting information. - - value: A string that contains the number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: A 64-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToInt64(value: str) -> Int64 - - Converts the specified string representation of a number to an equivalent 64-bit signed integer. - - value: A string that contains a number to convert. - Returns: A 64-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToInt64(value: Decimal) -> Int64 - - Converts the value of the specified decimal number to an equivalent 64-bit signed integer. - - value: The decimal number to convert. - Returns: value, rounded to the nearest 64-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToInt64(value: float) -> Int64 - - Converts the value of the specified double-precision floating-point number to an equivalent 64-bit signed integer. - - value: The double-precision floating-point number to convert. - Returns: value, rounded to the nearest 64-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToInt64(value: Single) -> Int64 - - Converts the value of the specified single-precision floating-point number to an equivalent 64-bit signed integer. - - value: The single-precision floating-point number to convert. - Returns: value, rounded to the nearest 64-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToInt64(value: Int64) -> Int64 - - Returns the specified 64-bit signed integer; no actual conversion is performed. - - value: A 64-bit signed integer. - Returns: value is returned unchanged. - ToInt64(value: UInt64) -> Int64 - - Converts the value of the specified 64-bit unsigned integer to an equivalent 64-bit signed integer. - - value: The 64-bit unsigned integer to convert. - Returns: A 64-bit signed integer that is equivalent to value. - ToInt64(value: DateTime) -> Int64 - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - ToInt64(value: UInt32) -> Int64 - - Converts the value of the specified 32-bit unsigned integer to an equivalent 64-bit signed integer. - - value: The 32-bit unsigned integer to convert. - Returns: A 64-bit signed integer that is equivalent to value. - ToInt64(value: UInt16) -> Int64 - - Converts the value of the specified 16-bit unsigned integer to the equivalent 64-bit signed integer. - - value: The 16-bit unsigned integer to convert. - Returns: A 64-bit signed integer that is equivalent to value. - ToInt64(value: Int16) -> Int64 - - Converts the value of the specified 16-bit signed integer to an equivalent 64-bit signed integer. - - value: The 16-bit signed integer to convert. - Returns: A 64-bit signed integer that is equivalent to value. - ToInt64(value: Byte) -> Int64 - - Converts the value of the specified 8-bit unsigned integer to the equivalent 64-bit signed integer. - - value: The 8-bit unsigned integer to convert. - Returns: A 64-bit signed integer that is equivalent to value. - ToInt64(value: SByte) -> Int64 - - Converts the value of the specified 8-bit signed integer to the equivalent 64-bit signed integer. - - value: The 8-bit signed integer to convert. - Returns: A 64-bit signed integer that is equivalent to value. - ToInt64(value: Char) -> Int64 - - Converts the value of the specified Unicode character to the equivalent 64-bit signed integer. - - value: The Unicode character to convert. - Returns: A 64-bit signed integer that is equivalent to value. - ToInt64(value: bool) -> Int64 - - Converts the specified Boolean value to the equivalent 64-bit signed integer. - - value: The Boolean value to convert. - Returns: The number 1 if value is true; otherwise, 0. - ToInt64(value: object, provider: IFormatProvider) -> Int64 - - Converts the value of the specified object to a 64-bit signed integer, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: A 64-bit signed integer that is equivalent to value, or zero if value is null. - ToInt64(value: int) -> Int64 - - Converts the value of the specified 32-bit signed integer to an equivalent 64-bit signed integer. - - value: The 32-bit signed integer to convert. - Returns: A 64-bit signed integer that is equivalent to value. - ToInt64(value: str, fromBase: int) -> Int64 - - Converts the string representation of a number in a specified base to an equivalent 64-bit signed integer. - - value: A string that contains the number to convert. - fromBase: The base of the number in value, which must be 2, 8, 10, or 16. - Returns: A 64-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - """ - pass - - @staticmethod - def ToSByte(value, *__args): - # type: (value: object) -> SByte - """ - ToSByte(value: object) -> SByte - - Converts the value of the specified object to an 8-bit signed integer. - - value: An object that implements the System.IConvertible interface, or null. - Returns: An 8-bit signed integer that is equivalent to value, or zero if value is null. - ToSByte(value: str, provider: IFormatProvider) -> SByte - - Converts the specified string representation of a number to an equivalent 8-bit signed integer, using the specified culture-specific formatting information. - - value: A string that contains the number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: An 8-bit signed integer that is equivalent to value. - ToSByte(value: str) -> SByte - - Converts the specified string representation of a number to an equivalent 8-bit signed integer. - - value: A string that contains the number to convert. - Returns: An 8-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToSByte(value: Decimal) -> SByte - - Converts the value of the specified decimal number to an equivalent 8-bit signed integer. - - value: The decimal number to convert. - Returns: value, rounded to the nearest 8-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToSByte(value: float) -> SByte - - Converts the value of the specified double-precision floating-point number to an equivalent 8-bit signed integer. - - value: The double-precision floating-point number to convert. - Returns: value, rounded to the nearest 8-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToSByte(value: Single) -> SByte - - Converts the value of the specified single-precision floating-point number to an equivalent 8-bit signed integer. - - value: The single-precision floating-point number to convert. - Returns: value, rounded to the nearest 8-bit signed integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToSByte(value: UInt64) -> SByte - - Converts the value of the specified 64-bit unsigned integer to an equivalent 8-bit signed integer. - - value: The 64-bit unsigned integer to convert. - Returns: An 8-bit signed integer that is equivalent to value. - ToSByte(value: Int64) -> SByte - - Converts the value of the specified 64-bit signed integer to an equivalent 8-bit signed integer. - - value: The 64-bit signed integer to convert. - Returns: An 8-bit signed integer that is equivalent to value. - ToSByte(value: DateTime) -> SByte - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - ToSByte(value: UInt32) -> SByte - - Converts the value of the specified 32-bit unsigned integer to an equivalent 8-bit signed integer. - - value: The 32-bit unsigned integer to convert. - Returns: An 8-bit signed integer that is equivalent to value. - ToSByte(value: UInt16) -> SByte - - Converts the value of the specified 16-bit unsigned integer to the equivalent 8-bit signed integer. - - value: The 16-bit unsigned integer to convert. - Returns: An 8-bit signed integer that is equivalent to value. - ToSByte(value: Int16) -> SByte - - Converts the value of the specified 16-bit signed integer to the equivalent 8-bit signed integer. - - value: The 16-bit signed integer to convert. - Returns: An 8-bit signed integer that is equivalent to value. - ToSByte(value: Byte) -> SByte - - Converts the value of the specified 8-bit unsigned integer to the equivalent 8-bit signed integer. - - value: The 8-bit unsigned integer to convert. - Returns: An 8-bit signed integer that is equivalent to value. - ToSByte(value: Char) -> SByte - - Converts the value of the specified Unicode character to the equivalent 8-bit signed integer. - - value: The Unicode character to convert. - Returns: An 8-bit signed integer that is equivalent to value. - ToSByte(value: SByte) -> SByte - - Returns the specified 8-bit signed integer; no actual conversion is performed. - - value: The 8-bit signed integer to return. - Returns: value is returned unchanged. - ToSByte(value: bool) -> SByte - - Converts the specified Boolean value to the equivalent 8-bit signed integer. - - value: The Boolean value to convert. - Returns: The number 1 if value is true; otherwise, 0. - ToSByte(value: object, provider: IFormatProvider) -> SByte - - Converts the value of the specified object to an 8-bit signed integer, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: An 8-bit signed integer that is equivalent to value, or zero if value is null. - ToSByte(value: int) -> SByte - - Converts the value of the specified 32-bit signed integer to an equivalent 8-bit signed integer. - - value: The 32-bit signed integer to convert. - Returns: An 8-bit signed integer that is equivalent to value. - ToSByte(value: str, fromBase: int) -> SByte - - Converts the string representation of a number in a specified base to an equivalent 8-bit signed integer. - - value: A string that contains the number to convert. - fromBase: The base of the number in value, which must be 2, 8, 10, or 16. - Returns: An 8-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - """ - pass - - @staticmethod - def ToSingle(value, provider=None): - # type: (value: object) -> Single - """ - ToSingle(value: object) -> Single - - Converts the value of the specified object to a single-precision floating-point number. - - value: An object that implements the System.IConvertible interface, or null. - Returns: A single-precision floating-point number that is equivalent to value, or zero if value is null. - ToSingle(value: str, provider: IFormatProvider) -> Single - - Converts the specified string representation of a number to an equivalent single-precision floating-point number, using the specified culture-specific formatting information. - - value: A string that contains the number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: A single-precision floating-point number that is equivalent to the number in value, or 0 (zero) if value is null. - ToSingle(value: str) -> Single - - Converts the specified string representation of a number to an equivalent single-precision floating-point number. - - value: A string that contains the number to convert. - Returns: A single-precision floating-point number that is equivalent to the number in value, or 0 (zero) if value is null. - ToSingle(value: Decimal) -> Single - - Converts the value of the specified decimal number to an equivalent single-precision floating-point number. - - value: The decimal number to convert. - Returns: A single-precision floating-point number that is equivalent to value.value is rounded using rounding to nearest. For example, when rounded to two decimals, the value 2.345 becomes 2.34 and the value 2.355 becomes 2.36. - ToSingle(value: float) -> Single - - Converts the value of the specified double-precision floating-point number to an equivalent single-precision floating-point number. - - value: The double-precision floating-point number to convert. - Returns: A single-precision floating-point number that is equivalent to value.value is rounded using rounding to nearest. For example, when rounded to two decimals, the value 2.345 becomes 2.34 and the value 2.355 becomes 2.36. - ToSingle(value: Single) -> Single - - Returns the specified single-precision floating-point number; no actual conversion is performed. - - value: The single-precision floating-point number to return. - Returns: value is returned unchanged. - ToSingle(value: UInt64) -> Single - - Converts the value of the specified 64-bit unsigned integer to an equivalent single-precision floating-point number. - - value: The 64-bit unsigned integer to convert. - Returns: A single-precision floating-point number that is equivalent to value. - ToSingle(value: Int64) -> Single - - Converts the value of the specified 64-bit signed integer to an equivalent single-precision floating-point number. - - value: The 64-bit signed integer to convert. - Returns: A single-precision floating-point number that is equivalent to value. - ToSingle(value: UInt32) -> Single - - Converts the value of the specified 32-bit unsigned integer to an equivalent single-precision floating-point number. - - value: The 32-bit unsigned integer to convert. - Returns: A single-precision floating-point number that is equivalent to value. - ToSingle(value: int) -> Single - - Converts the value of the specified 32-bit signed integer to an equivalent single-precision floating-point number. - - value: The 32-bit signed integer to convert. - Returns: A single-precision floating-point number that is equivalent to value. - ToSingle(value: UInt16) -> Single - - Converts the value of the specified 16-bit unsigned integer to the equivalent single-precision floating-point number. - - value: The 16-bit unsigned integer to convert. - Returns: A single-precision floating-point number that is equivalent to value. - ToSingle(value: Int16) -> Single - - Converts the value of the specified 16-bit signed integer to an equivalent single-precision floating-point number. - - value: The 16-bit signed integer to convert. - Returns: A single-precision floating-point number that is equivalent to value. - ToSingle(value: Char) -> Single - - Calling this method always throws System.InvalidCastException. - - value: The Unicode character to convert. - Returns: This conversion is not supported. No value is returned. - ToSingle(value: Byte) -> Single - - Converts the value of the specified 8-bit unsigned integer to the equivalent single-precision floating-point number. - - value: The 8-bit unsigned integer to convert. - Returns: A single-precision floating-point number that is equivalent to value. - ToSingle(value: SByte) -> Single - - Converts the value of the specified 8-bit signed integer to the equivalent single-precision floating-point number. - - value: The 8-bit signed integer to convert. - Returns: An 8-bit signed integer that is equivalent to value. - ToSingle(value: object, provider: IFormatProvider) -> Single - - Converts the value of the specified object to an single-precision floating-point number, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: A single-precision floating-point number that is equivalent to value, or zero if value is null. - ToSingle(value: bool) -> Single - - Converts the specified Boolean value to the equivalent single-precision floating-point number. - - value: The Boolean value to convert. - Returns: The number 1 if value is true; otherwise, 0. - ToSingle(value: DateTime) -> Single - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - """ - pass - - @staticmethod - def ToString(value=None, *__args): - # type: (value: object) -> str - """ - ToString(value: object) -> str - - Converts the value of the specified object to its equivalent string representation. - - value: An object that supplies the value to convert, or null. - Returns: The string representation of value, or System.String.Empty if value is null. - ToString(value: UInt64) -> str - - Converts the value of the specified 64-bit unsigned integer to its equivalent string representation. - - value: The 64-bit unsigned integer to convert. - Returns: The string representation of value. - ToString(value: UInt64, provider: IFormatProvider) -> str - - Converts the value of the specified 64-bit unsigned integer to its equivalent string representation, using the specified culture-specific formatting information. - - value: The 64-bit unsigned integer to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: Single) -> str - - Converts the value of the specified single-precision floating-point number to its equivalent string representation. - - value: The single-precision floating-point number to convert. - Returns: The string representation of value. - ToString(value: Single, provider: IFormatProvider) -> str - - Converts the value of the specified single-precision floating-point number to its equivalent string representation, using the specified culture-specific formatting information. - - value: The single-precision floating-point number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: float) -> str - - Converts the value of the specified double-precision floating-point number to its equivalent string representation. - - value: The double-precision floating-point number to convert. - Returns: The string representation of value. - ToString(value: float, provider: IFormatProvider) -> str - - Converts the value of the specified double-precision floating-point number to its equivalent string representation. - - value: The double-precision floating-point number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: Int64, provider: IFormatProvider) -> str - - Converts the value of the specified 64-bit signed integer to its equivalent string representation, using the specified culture-specific formatting information. - - value: The 64-bit signed integer to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: Decimal) -> str - - Converts the value of the specified decimal number to its equivalent string representation. - - value: The decimal number to convert. - Returns: The string representation of value. - ToString(value: DateTime) -> str - - Converts the value of the specified System.DateTime to its equivalent string representation. - - value: The date and time value to convert. - Returns: The string representation of value. - ToString(value: DateTime, provider: IFormatProvider) -> str - - Converts the value of the specified System.DateTime to its equivalent string representation, using the specified culture-specific formatting information. - - value: The date and time value to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: str) -> str - - Returns the specified string instance; no actual conversion is performed. - - value: The string to return. - Returns: value is returned unchanged. - ToString(value: str, provider: IFormatProvider) -> str - - Returns the specified string instance; no actual conversion is performed. - - value: The string to return. - provider: An object that supplies culture-specific formatting information. This parameter is ignored. - Returns: value is returned unchanged. - ToString(value: Byte, toBase: int) -> str - - Converts the value of an 8-bit unsigned integer to its equivalent string representation in a specified base. - - value: The 8-bit unsigned integer to convert. - toBase: The base of the return value, which must be 2, 8, 10, or 16. - Returns: The string representation of value in base toBase. - ToString(value: Int16, toBase: int) -> str - - Converts the value of a 16-bit signed integer to its equivalent string representation in a specified base. - - value: The 16-bit signed integer to convert. - toBase: The base of the return value, which must be 2, 8, 10, or 16. - Returns: The string representation of value in base toBase. - ToString(value: Decimal, provider: IFormatProvider) -> str - - Converts the value of the specified decimal number to its equivalent string representation, using the specified culture-specific formatting information. - - value: The decimal number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: Int64) -> str - - Converts the value of the specified 64-bit signed integer to its equivalent string representation. - - value: The 64-bit signed integer to convert. - Returns: The string representation of value. - ToString(value: UInt32, provider: IFormatProvider) -> str - - Converts the value of the specified 32-bit unsigned integer to its equivalent string representation, using the specified culture-specific formatting information. - - value: The 32-bit unsigned integer to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: UInt32) -> str - - Converts the value of the specified 32-bit unsigned integer to its equivalent string representation. - - value: The 32-bit unsigned integer to convert. - Returns: The string representation of value. - ToString(value: object, provider: IFormatProvider) -> str - - Converts the value of the specified object to its equivalent string representation using the specified culture-specific formatting information. - - value: An object that supplies the value to convert, or null. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value, or System.String.Empty if value is null. - ToString(value: bool) -> str - - Converts the specified Boolean value to its equivalent string representation. - - value: The Boolean value to convert. - Returns: The string representation of value. - ToString(value: bool, provider: IFormatProvider) -> str - - Converts the specified Boolean value to its equivalent string representation. - - value: The Boolean value to convert. - provider: An instance of an object. This parameter is ignored. - Returns: The string representation of value. - ToString(value: Char) -> str - - Converts the value of the specified Unicode character to its equivalent string representation. - - value: The Unicode character to convert. - Returns: The string representation of value. - ToString(value: Char, provider: IFormatProvider) -> str - - Converts the value of the specified Unicode character to its equivalent string representation, using the specified culture-specific formatting information. - - value: The Unicode character to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: SByte) -> str - - Converts the value of the specified 8-bit signed integer to its equivalent string representation. - - value: The 8-bit signed integer to convert. - Returns: The string representation of value. - ToString(value: SByte, provider: IFormatProvider) -> str - - Converts the value of the specified 8-bit signed integer to its equivalent string representation, using the specified culture-specific formatting information. - - value: The 8-bit signed integer to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: Byte) -> str - - Converts the value of the specified 8-bit unsigned integer to its equivalent string representation. - - value: The 8-bit unsigned integer to convert. - Returns: The string representation of value. - ToString(value: Byte, provider: IFormatProvider) -> str - - Converts the value of the specified 8-bit unsigned integer to its equivalent string representation, using the specified culture-specific formatting information. - - value: The 8-bit unsigned integer to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: Int16) -> str - - Converts the value of the specified 16-bit signed integer to its equivalent string representation. - - value: The 16-bit signed integer to convert. - Returns: The string representation of value. - ToString(value: Int16, provider: IFormatProvider) -> str - - Converts the value of the specified 16-bit signed integer to its equivalent string representation, using the specified culture-specific formatting information. - - value: The 16-bit signed integer to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: UInt16) -> str - - Converts the value of the specified 16-bit unsigned integer to its equivalent string representation. - - value: The 16-bit unsigned integer to convert. - Returns: The string representation of value. - ToString(value: UInt16, provider: IFormatProvider) -> str - - Converts the value of the specified 16-bit unsigned integer to its equivalent string representation, using the specified culture-specific formatting information. - - value: The 16-bit unsigned integer to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: int) -> str - - Converts the value of the specified 32-bit signed integer to its equivalent string representation. - - value: The 32-bit signed integer to convert. - Returns: The string representation of value. - ToString(value: int, provider: IFormatProvider) -> str - - Converts the value of the specified 32-bit signed integer to its equivalent string representation, using the specified culture-specific formatting information. - - value: The 32-bit signed integer to convert. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of value. - ToString(value: int, toBase: int) -> str - - Converts the value of a 32-bit signed integer to its equivalent string representation in a specified base. - - value: The 32-bit signed integer to convert. - toBase: The base of the return value, which must be 2, 8, 10, or 16. - Returns: The string representation of value in base toBase. - ToString(value: Int64, toBase: int) -> str - - Converts the value of a 64-bit signed integer to its equivalent string representation in a specified base. - - value: The 64-bit signed integer to convert. - toBase: The base of the return value, which must be 2, 8, 10, or 16. - Returns: The string representation of value in base toBase. - """ - pass - - @staticmethod - def ToUInt16(value, *__args): - # type: (value: object) -> UInt16 - """ - ToUInt16(value: object) -> UInt16 - - Converts the value of the specified object to a 16-bit unsigned integer. - - value: An object that implements the System.IConvertible interface, or null. - Returns: A 16-bit unsigned integer that is equivalent to value, or zero if value is null. - ToUInt16(value: str, provider: IFormatProvider) -> UInt16 - - Converts the specified string representation of a number to an equivalent 16-bit unsigned integer, using the specified culture-specific formatting information. - - value: A string that contains the number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: A 16-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToUInt16(value: str) -> UInt16 - - Converts the specified string representation of a number to an equivalent 16-bit unsigned integer. - - value: A string that contains the number to convert. - Returns: A 16-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToUInt16(value: Decimal) -> UInt16 - - Converts the value of the specified decimal number to an equivalent 16-bit unsigned integer. - - value: The decimal number to convert. - Returns: value, rounded to the nearest 16-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToUInt16(value: float) -> UInt16 - - Converts the value of the specified double-precision floating-point number to an equivalent 16-bit unsigned integer. - - value: The double-precision floating-point number to convert. - Returns: value, rounded to the nearest 16-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToUInt16(value: Single) -> UInt16 - - Converts the value of the specified single-precision floating-point number to an equivalent 16-bit unsigned integer. - - value: The single-precision floating-point number to convert. - Returns: value, rounded to the nearest 16-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToUInt16(value: UInt64) -> UInt16 - - Converts the value of the specified 64-bit unsigned integer to an equivalent 16-bit unsigned integer. - - value: The 64-bit unsigned integer to convert. - Returns: A 16-bit unsigned integer that is equivalent to value. - ToUInt16(value: Int64) -> UInt16 - - Converts the value of the specified 64-bit signed integer to an equivalent 16-bit unsigned integer. - - value: The 64-bit signed integer to convert. - Returns: A 16-bit unsigned integer that is equivalent to value. - ToUInt16(value: DateTime) -> UInt16 - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - ToUInt16(value: UInt32) -> UInt16 - - Converts the value of the specified 32-bit unsigned integer to an equivalent 16-bit unsigned integer. - - value: The 32-bit unsigned integer to convert. - Returns: A 16-bit unsigned integer that is equivalent to value. - ToUInt16(value: int) -> UInt16 - - Converts the value of the specified 32-bit signed integer to an equivalent 16-bit unsigned integer. - - value: The 32-bit signed integer to convert. - Returns: A 16-bit unsigned integer that is equivalent to value. - ToUInt16(value: Int16) -> UInt16 - - Converts the value of the specified 16-bit signed integer to the equivalent 16-bit unsigned integer. - - value: The 16-bit signed integer to convert. - Returns: A 16-bit unsigned integer that is equivalent to value. - ToUInt16(value: Byte) -> UInt16 - - Converts the value of the specified 8-bit unsigned integer to the equivalent 16-bit unsigned integer. - - value: The 8-bit unsigned integer to convert. - Returns: A 16-bit unsigned integer that is equivalent to value. - ToUInt16(value: SByte) -> UInt16 - - Converts the value of the specified 8-bit signed integer to the equivalent 16-bit unsigned integer. - - value: The 8-bit signed integer to convert. - Returns: A 16-bit unsigned integer that is equivalent to value. - ToUInt16(value: Char) -> UInt16 - - Converts the value of the specified Unicode character to the equivalent 16-bit unsigned integer. - - value: The Unicode character to convert. - Returns: The 16-bit unsigned integer equivalent to value. - ToUInt16(value: bool) -> UInt16 - - Converts the specified Boolean value to the equivalent 16-bit unsigned integer. - - value: The Boolean value to convert. - Returns: The number 1 if value is true; otherwise, 0. - ToUInt16(value: object, provider: IFormatProvider) -> UInt16 - - Converts the value of the specified object to a 16-bit unsigned integer, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: A 16-bit unsigned integer that is equivalent to value, or zero if value is null. - ToUInt16(value: UInt16) -> UInt16 - - Returns the specified 16-bit unsigned integer; no actual conversion is performed. - - value: The 16-bit unsigned integer to return. - Returns: value is returned unchanged. - ToUInt16(value: str, fromBase: int) -> UInt16 - - Converts the string representation of a number in a specified base to an equivalent 16-bit unsigned integer. - - value: A string that contains the number to convert. - fromBase: The base of the number in value, which must be 2, 8, 10, or 16. - Returns: A 16-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null. - """ - pass - - @staticmethod - def ToUInt32(value, *__args): - # type: (value: object) -> UInt32 - """ - ToUInt32(value: object) -> UInt32 - - Converts the value of the specified object to a 32-bit unsigned integer. - - value: An object that implements the System.IConvertible interface, or null. - Returns: A 32-bit unsigned integer that is equivalent to value, or 0 (zero) if value is null. - ToUInt32(value: str, provider: IFormatProvider) -> UInt32 - - Converts the specified string representation of a number to an equivalent 32-bit unsigned integer, using the specified culture-specific formatting information. - - value: A string that contains the number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: A 32-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToUInt32(value: str) -> UInt32 - - Converts the specified string representation of a number to an equivalent 32-bit unsigned integer. - - value: A string that contains the number to convert. - Returns: A 32-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToUInt32(value: Decimal) -> UInt32 - - Converts the value of the specified decimal number to an equivalent 32-bit unsigned integer. - - value: The decimal number to convert. - Returns: value, rounded to the nearest 32-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToUInt32(value: float) -> UInt32 - - Converts the value of the specified double-precision floating-point number to an equivalent 32-bit unsigned integer. - - value: The double-precision floating-point number to convert. - Returns: value, rounded to the nearest 32-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToUInt32(value: Single) -> UInt32 - - Converts the value of the specified single-precision floating-point number to an equivalent 32-bit unsigned integer. - - value: The single-precision floating-point number to convert. - Returns: value, rounded to the nearest 32-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToUInt32(value: UInt64) -> UInt32 - - Converts the value of the specified 64-bit unsigned integer to an equivalent 32-bit unsigned integer. - - value: The 64-bit unsigned integer to convert. - Returns: A 32-bit unsigned integer that is equivalent to value. - ToUInt32(value: Int64) -> UInt32 - - Converts the value of the specified 64-bit signed integer to an equivalent 32-bit unsigned integer. - - value: The 64-bit signed integer to convert. - Returns: A 32-bit unsigned integer that is equivalent to value. - ToUInt32(value: DateTime) -> UInt32 - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - ToUInt32(value: UInt32) -> UInt32 - - Returns the specified 32-bit unsigned integer; no actual conversion is performed. - - value: The 32-bit unsigned integer to return. - Returns: value is returned unchanged. - ToUInt32(value: UInt16) -> UInt32 - - Converts the value of the specified 16-bit unsigned integer to the equivalent 32-bit unsigned integer. - - value: The 16-bit unsigned integer to convert. - Returns: A 32-bit unsigned integer that is equivalent to value. - ToUInt32(value: Int16) -> UInt32 - - Converts the value of the specified 16-bit signed integer to the equivalent 32-bit unsigned integer. - - value: The 16-bit signed integer to convert. - Returns: A 32-bit unsigned integer that is equivalent to value. - ToUInt32(value: Byte) -> UInt32 - - Converts the value of the specified 8-bit unsigned integer to the equivalent 32-bit unsigned integer. - - value: The 8-bit unsigned integer to convert. - Returns: A 32-bit unsigned integer that is equivalent to value. - ToUInt32(value: SByte) -> UInt32 - - Converts the value of the specified 8-bit signed integer to the equivalent 32-bit unsigned integer. - - value: The 8-bit signed integer to convert. - Returns: A 32-bit unsigned integer that is equivalent to value. - ToUInt32(value: Char) -> UInt32 - - Converts the value of the specified Unicode character to the equivalent 32-bit unsigned integer. - - value: The Unicode character to convert. - Returns: A 32-bit unsigned integer that is equivalent to value. - ToUInt32(value: bool) -> UInt32 - - Converts the specified Boolean value to the equivalent 32-bit unsigned integer. - - value: The Boolean value to convert. - Returns: The number 1 if value is true; otherwise, 0. - ToUInt32(value: object, provider: IFormatProvider) -> UInt32 - - Converts the value of the specified object to a 32-bit unsigned integer, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: A 32-bit unsigned integer that is equivalent to value, or zero if value is null. - ToUInt32(value: int) -> UInt32 - - Converts the value of the specified 32-bit signed integer to an equivalent 32-bit unsigned integer. - - value: The 32-bit signed integer to convert. - Returns: A 32-bit unsigned integer that is equivalent to value. - ToUInt32(value: str, fromBase: int) -> UInt32 - - Converts the string representation of a number in a specified base to an equivalent 32-bit unsigned integer. - - value: A string that contains the number to convert. - fromBase: The base of the number in value, which must be 2, 8, 10, or 16. - Returns: A 32-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null. - """ - pass - - @staticmethod - def ToUInt64(value, *__args): - # type: (value: object) -> UInt64 - """ - ToUInt64(value: object) -> UInt64 - - Converts the value of the specified object to a 64-bit unsigned integer. - - value: An object that implements the System.IConvertible interface, or null. - Returns: A 64-bit unsigned integer that is equivalent to value, or zero if value is null. - ToUInt64(value: str, provider: IFormatProvider) -> UInt64 - - Converts the specified string representation of a number to an equivalent 64-bit unsigned integer, using the specified culture-specific formatting information. - - value: A string that contains the number to convert. - provider: An object that supplies culture-specific formatting information. - Returns: A 64-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToUInt64(value: str) -> UInt64 - - Converts the specified string representation of a number to an equivalent 64-bit unsigned integer. - - value: A string that contains the number to convert. - Returns: A 64-bit signed integer that is equivalent to the number in value, or 0 (zero) if value is null. - ToUInt64(value: Decimal) -> UInt64 - - Converts the value of the specified decimal number to an equivalent 64-bit unsigned integer. - - value: The decimal number to convert. - Returns: value, rounded to the nearest 64-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToUInt64(value: float) -> UInt64 - - Converts the value of the specified double-precision floating-point number to an equivalent 64-bit unsigned integer. - - value: The double-precision floating-point number to convert. - Returns: value, rounded to the nearest 64-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToUInt64(value: Single) -> UInt64 - - Converts the value of the specified single-precision floating-point number to an equivalent 64-bit unsigned integer. - - value: The single-precision floating-point number to convert. - Returns: value, rounded to the nearest 64-bit unsigned integer. If value is halfway between two whole numbers, the even number is returned; that is, 4.5 is converted to 4, and 5.5 is converted to 6. - ToUInt64(value: UInt64) -> UInt64 - - Returns the specified 64-bit unsigned integer; no actual conversion is performed. - - value: The 64-bit unsigned integer to return. - Returns: value is returned unchanged. - ToUInt64(value: Int64) -> UInt64 - - Converts the value of the specified 64-bit signed integer to an equivalent 64-bit unsigned integer. - - value: The 64-bit signed integer to convert. - Returns: A 64-bit unsigned integer that is equivalent to value. - ToUInt64(value: DateTime) -> UInt64 - - Calling this method always throws System.InvalidCastException. - - value: The date and time value to convert. - Returns: This conversion is not supported. No value is returned. - ToUInt64(value: UInt32) -> UInt64 - - Converts the value of the specified 32-bit unsigned integer to an equivalent 64-bit unsigned integer. - - value: The 32-bit unsigned integer to convert. - Returns: A 64-bit unsigned integer that is equivalent to value. - ToUInt64(value: UInt16) -> UInt64 - - Converts the value of the specified 16-bit unsigned integer to the equivalent 64-bit unsigned integer. - - value: The 16-bit unsigned integer to convert. - Returns: A 64-bit unsigned integer that is equivalent to value. - ToUInt64(value: Int16) -> UInt64 - - Converts the value of the specified 16-bit signed integer to the equivalent 64-bit unsigned integer. - - value: The 16-bit signed integer to convert. - Returns: A 64-bit unsigned integer that is equivalent to value. - ToUInt64(value: Byte) -> UInt64 - - Converts the value of the specified 8-bit unsigned integer to the equivalent 64-bit unsigned integer. - - value: The 8-bit unsigned integer to convert. - Returns: A 64-bit signed integer that is equivalent to value. - ToUInt64(value: SByte) -> UInt64 - - Converts the value of the specified 8-bit signed integer to the equivalent 64-bit unsigned integer. - - value: The 8-bit signed integer to convert. - Returns: A 64-bit unsigned integer that is equivalent to value. - ToUInt64(value: Char) -> UInt64 - - Converts the value of the specified Unicode character to the equivalent 64-bit unsigned integer. - - value: The Unicode character to convert. - Returns: A 64-bit unsigned integer that is equivalent to value. - ToUInt64(value: bool) -> UInt64 - - Converts the specified Boolean value to the equivalent 64-bit unsigned integer. - - value: The Boolean value to convert. - Returns: The number 1 if value is true; otherwise, 0. - ToUInt64(value: object, provider: IFormatProvider) -> UInt64 - - Converts the value of the specified object to a 64-bit unsigned integer, using the specified culture-specific formatting information. - - value: An object that implements the System.IConvertible interface. - provider: An object that supplies culture-specific formatting information. - Returns: A 64-bit unsigned integer that is equivalent to value, or zero if value is null. - ToUInt64(value: int) -> UInt64 - - Converts the value of the specified 32-bit signed integer to an equivalent 64-bit unsigned integer. - - value: The 32-bit signed integer to convert. - Returns: A 64-bit unsigned integer that is equivalent to value. - ToUInt64(value: str, fromBase: int) -> UInt64 - - Converts the string representation of a number in a specified base to an equivalent 64-bit unsigned integer. - - value: A string that contains the number to convert. - fromBase: The base of the number in value, which must be 2, 8, 10, or 16. - Returns: A 64-bit unsigned integer that is equivalent to the number in value, or 0 (zero) if value is null. - """ - pass - - DBNull = None - __all__ = [ - 'ChangeType', - 'DBNull', - 'FromBase64CharArray', - 'FromBase64String', - 'GetTypeCode', - 'IsDBNull', - 'ToBase64CharArray', - 'ToBase64String', - 'ToBoolean', - 'ToByte', - 'ToChar', - 'ToDateTime', - 'ToDecimal', - 'ToDouble', - 'ToInt16', - 'ToInt32', - 'ToInt64', - 'ToSByte', - 'ToSingle', - 'ToString', - 'ToUInt16', - 'ToUInt32', - 'ToUInt64', - ] - - -class Converter(MulticastDelegate, ICloneable, ISerializable): - # type: (object: object, method: IntPtr) - """ Converter[TInput, TOutput](object: object, method: IntPtr) """ - def BeginInvoke(self, input, callback, object): - # type: (self: Converter[TInput, TOutput], input: TInput, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: Converter[TInput, TOutput], input: TInput, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: Converter[TInput, TOutput], result: IAsyncResult) -> TOutput - """ EndInvoke(self: Converter[TInput, TOutput], result: IAsyncResult) -> TOutput """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, input): - # type: (self: Converter[TInput, TOutput], input: TInput) -> TOutput - """ Invoke(self: Converter[TInput, TOutput], input: TInput) -> TOutput """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class CrossAppDomainDelegate(MulticastDelegate, ICloneable, ISerializable): - # type: (System.CrossAppDomainDelegate) for cross-application domain calls. - """ - Used by System.AppDomain.DoCallBack(System.CrossAppDomainDelegate) for cross-application domain calls. - - CrossAppDomainDelegate(object: object, method: IntPtr) - """ - def BeginInvoke(self, callback, object): - # type: (self: CrossAppDomainDelegate, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: CrossAppDomainDelegate, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: CrossAppDomainDelegate, result: IAsyncResult) - """ EndInvoke(self: CrossAppDomainDelegate, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self): - # type: (self: CrossAppDomainDelegate) - """ Invoke(self: CrossAppDomainDelegate) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class DataMisalignedException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when a unit of data is read from or written to an address that is not a multiple of the data size. This class cannot be inherited. - - DataMisalignedException() - DataMisalignedException(message: str) - DataMisalignedException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class DateTime(object, IComparable, IFormattable, IConvertible, ISerializable, IComparable[DateTime], IEquatable[DateTime]): - """ - Represents an instant in time, typically expressed as a date and time of day. - - DateTime(ticks: Int64) - DateTime(ticks: Int64, kind: DateTimeKind) - DateTime(year: int, month: int, day: int) - DateTime(year: int, month: int, day: int, calendar: Calendar) - DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) - DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) - DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Calendar) - DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int) - DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, kind: DateTimeKind) - DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, calendar: Calendar) - DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, calendar: Calendar, kind: DateTimeKind) - """ - def Add(self, value): - # type: (self: DateTime, value: TimeSpan) -> DateTime - """ - Add(self: DateTime, value: TimeSpan) -> DateTime - - Returns a new System.DateTime that adds the value of the specified System.TimeSpan to the value of this instance. - - value: A positive or negative time interval. - Returns: An object whose value is the sum of the date and time represented by this instance and the time interval represented by value. - """ - pass - - def AddDays(self, value): - # type: (self: DateTime, value: float) -> DateTime - """ - AddDays(self: DateTime, value: float) -> DateTime - - Returns a new System.DateTime that adds the specified number of days to the value of this instance. - - value: A number of whole and fractional days. The value parameter can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by this instance and the number of days represented by value. - """ - pass - - def AddHours(self, value): - # type: (self: DateTime, value: float) -> DateTime - """ - AddHours(self: DateTime, value: float) -> DateTime - - Returns a new System.DateTime that adds the specified number of hours to the value of this instance. - - value: A number of whole and fractional hours. The value parameter can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by this instance and the number of hours represented by value. - """ - pass - - def AddMilliseconds(self, value): - # type: (self: DateTime, value: float) -> DateTime - """ - AddMilliseconds(self: DateTime, value: float) -> DateTime - - Returns a new System.DateTime that adds the specified number of milliseconds to the value of this instance. - - value: A number of whole and fractional milliseconds. The value parameter can be negative or positive. Note that this value is rounded to the nearest integer. - Returns: An object whose value is the sum of the date and time represented by this instance and the number of milliseconds represented by value. - """ - pass - - def AddMinutes(self, value): - # type: (self: DateTime, value: float) -> DateTime - """ - AddMinutes(self: DateTime, value: float) -> DateTime - - Returns a new System.DateTime that adds the specified number of minutes to the value of this instance. - - value: A number of whole and fractional minutes. The value parameter can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by this instance and the number of minutes represented by value. - """ - pass - - def AddMonths(self, months): - # type: (self: DateTime, months: int) -> DateTime - """ - AddMonths(self: DateTime, months: int) -> DateTime - - Returns a new System.DateTime that adds the specified number of months to the value of this instance. - - months: A number of months. The months parameter can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by this instance and months. - """ - pass - - def AddSeconds(self, value): - # type: (self: DateTime, value: float) -> DateTime - """ - AddSeconds(self: DateTime, value: float) -> DateTime - - Returns a new System.DateTime that adds the specified number of seconds to the value of this instance. - - value: A number of whole and fractional seconds. The value parameter can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by this instance and the number of seconds represented by value. - """ - pass - - def AddTicks(self, value): - # type: (self: DateTime, value: Int64) -> DateTime - """ - AddTicks(self: DateTime, value: Int64) -> DateTime - - Returns a new System.DateTime that adds the specified number of ticks to the value of this instance. - - value: A number of 100-nanosecond ticks. The value parameter can be positive or negative. - Returns: An object whose value is the sum of the date and time represented by this instance and the time represented by value. - """ - pass - - def AddYears(self, value): - # type: (self: DateTime, value: int) -> DateTime - """ - AddYears(self: DateTime, value: int) -> DateTime - - Returns a new System.DateTime that adds the specified number of years to the value of this instance. - - value: A number of years. The value parameter can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by this instance and the number of years represented by value. - """ - pass - - @staticmethod - def Compare(t1, t2): - # type: (t1: DateTime, t2: DateTime) -> int - """ - Compare(t1: DateTime, t2: DateTime) -> int - - Compares two instances of System.DateTime and returns an integer that indicates whether the first instance is earlier than, the same as, or later than the second instance. - - t1: The first object to compare. - t2: The second object to compare. - Returns: A signed number indicating the relative values of t1 and t2.Value Type Condition Less than zero t1 is earlier than t2. Zero t1 is the same as t2. Greater than zero t1 is later than t2. - """ - pass - - def CompareTo(self, value): - # type: (self: DateTime, value: object) -> int - """ - CompareTo(self: DateTime, value: object) -> int - - Compares the value of this instance to a specified object that contains a specified System.DateTime value, and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified System.DateTime value. - - value: A boxed object to compare, or null. - Returns: A signed number indicating the relative values of this instance and value.Value Description Less than zero This instance is earlier than value. Zero This instance is the same as value. Greater than zero This instance is later than value, or value is - null. - - CompareTo(self: DateTime, value: DateTime) -> int - - Compares the value of this instance to a specified System.DateTime value and returns an integer that indicates whether this instance is earlier than, the same as, or later than the specified System.DateTime value. - - value: The object to compare to the current instance. - Returns: A signed number indicating the relative values of this instance and the value parameter.Value Description Less than zero This instance is earlier than value. Zero This instance is the same as value. Greater than zero This instance is later than value. - """ - pass - - @staticmethod - def DaysInMonth(year, month): - # type: (year: int, month: int) -> int - """ - DaysInMonth(year: int, month: int) -> int - - Returns the number of days in the specified month and year. - - year: The year. - month: The month (a number ranging from 1 to 12). - Returns: The number of days in month for the specified year.For example, if month equals 2 for February, the return value is 28 or 29 depending upon whether year is a leap year. - """ - pass - - def Equals(self, *__args): - # type: (self: DateTime, value: object) -> bool - """ - Equals(self: DateTime, value: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - value: The object to compare to this instance. - Returns: true if value is an instance of System.DateTime and equals the value of this instance; otherwise, false. - Equals(self: DateTime, value: DateTime) -> bool - - Returns a value indicating whether the value of this instance is equal to the value of the specified System.DateTime instance. - - value: The object to compare to this instance. - Returns: true if the value parameter equals the value of this instance; otherwise, false. - Equals(t1: DateTime, t2: DateTime) -> bool - - Returns a value indicating whether two System.DateTime instances have the same date and time value. - - t1: The first object to compare. - t2: The second object to compare. - Returns: true if the two values are equal; otherwise, false. - """ - pass - - @staticmethod - def FromBinary(dateData): - # type: (dateData: Int64) -> DateTime - """ - FromBinary(dateData: Int64) -> DateTime - - Deserializes a 64-bit binary value and recreates an original serialized System.DateTime object. - - dateData: A 64-bit signed integer that encodes the System.DateTime.Kind property in a 2-bit field and the System.DateTime.Ticks property in a 62-bit field. - Returns: An object that is equivalent to the System.DateTime object that was serialized by the System.DateTime.ToBinary method. - """ - pass - - @staticmethod - def FromFileTime(fileTime): - # type: (fileTime: Int64) -> DateTime - """ - FromFileTime(fileTime: Int64) -> DateTime - - Converts the specified Windows file time to an equivalent local time. - - fileTime: A Windows file time expressed in ticks. - Returns: An object that represents the local time equivalent of the date and time represented by the fileTime parameter. - """ - pass - - @staticmethod - def FromFileTimeUtc(fileTime): - # type: (fileTime: Int64) -> DateTime - """ - FromFileTimeUtc(fileTime: Int64) -> DateTime - - Converts the specified Windows file time to an equivalent UTC time. - - fileTime: A Windows file time expressed in ticks. - Returns: An object that represents the UTC time equivalent of the date and time represented by the fileTime parameter. - """ - pass - - @staticmethod - def FromOADate(d): - # type: (d: float) -> DateTime - """ - FromOADate(d: float) -> DateTime - - Returns a System.DateTime equivalent to the specified OLE Automation Date. - - d: An OLE Automation Date value. - Returns: An object that represents the same date and time as d. - """ - pass - - def GetDateTimeFormats(self, *__args): - # type: (self: DateTime) -> Array[str] - """ - GetDateTimeFormats(self: DateTime) -> Array[str] - - Converts the value of this instance to all the string representations supported by the standard date and time format specifiers. - Returns: A string array where each element is the representation of the value of this instance formatted with one of the standard date and time format specifiers. - GetDateTimeFormats(self: DateTime, provider: IFormatProvider) -> Array[str] - - Converts the value of this instance to all the string representations supported by the standard date and time format specifiers and the specified culture-specific formatting information. - - provider: An object that supplies culture-specific formatting information about this instance. - Returns: A string array where each element is the representation of the value of this instance formatted with one of the standard date and time format specifiers. - GetDateTimeFormats(self: DateTime, format: Char) -> Array[str] - - Converts the value of this instance to all the string representations supported by the specified standard date and time format specifier. - - format: A standard date and time format string (see Remarks). - Returns: A string array where each element is the representation of the value of this instance formatted with the format standard date and time format specifier. - GetDateTimeFormats(self: DateTime, format: Char, provider: IFormatProvider) -> Array[str] - - Converts the value of this instance to all the string representations supported by the specified standard date and time format specifier and culture-specific formatting information. - - format: A date and time format string (see Remarks). - provider: An object that supplies culture-specific formatting information about this instance. - Returns: A string array where each element is the representation of the value of this instance formatted with one of the standard date and time format specifiers. - """ - pass - - def GetHashCode(self): - # type: (self: DateTime) -> int - """ - GetHashCode(self: DateTime) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetTypeCode(self): - # type: (self: DateTime) -> TypeCode - """ - GetTypeCode(self: DateTime) -> TypeCode - - Returns the System.TypeCode for value type System.DateTime. - Returns: The enumerated constant, System.TypeCode.DateTime. - """ - pass - - def IsDaylightSavingTime(self): - # type: (self: DateTime) -> bool - """ - IsDaylightSavingTime(self: DateTime) -> bool - - Indicates whether this instance of System.DateTime is within the daylight saving time range for the current time zone. - Returns: true if System.DateTime.Kind is System.DateTimeKind.Local or System.DateTimeKind.Unspecified and the value of this instance of System.DateTime is within the daylight saving time range for the current time zone. false if System.DateTime.Kind is - System.DateTimeKind.Utc. - """ - pass - - @staticmethod - def IsLeapYear(year): - # type: (year: int) -> bool - """ - IsLeapYear(year: int) -> bool - - Returns an indication whether the specified year is a leap year. - - year: A 4-digit year. - Returns: true if year is a leap year; otherwise, false. - """ - pass - - @staticmethod - def Parse(s, provider=None, styles=None): - # type: (s: str) -> DateTime - """ - Parse(s: str) -> DateTime - - Converts the specified string representation of a date and time to its System.DateTime equivalent. - - s: A string containing a date and time to convert. - Returns: An object that is equivalent to the date and time contained in s. - Parse(s: str, provider: IFormatProvider) -> DateTime - - Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified culture-specific format information. - - s: A string containing a date and time to convert. - provider: An object that supplies culture-specific format information about s. - Returns: An object that is equivalent to the date and time contained in s as specified by provider. - Parse(s: str, provider: IFormatProvider, styles: DateTimeStyles) -> DateTime - - Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified culture-specific format information and formatting style. - - s: A string containing a date and time to convert. - provider: An object that supplies culture-specific formatting information about s. - styles: A bitwise combination of the enumeration values that indicates the style elements that can be present in s for the parse operation to succeed and that defines how to interpret the parsed date in relation to the current time zone or the current date. A - typical value to specify is System.Globalization.DateTimeStyles.None. - - Returns: An object that is equivalent to the date and time contained in s, as specified by provider and styles. - """ - pass - - @staticmethod - def ParseExact(s, *__args): - # type: (s: str, format: str, provider: IFormatProvider) -> DateTime - """ - ParseExact(s: str, format: str, provider: IFormatProvider) -> DateTime - - Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified format and culture-specific format information. The format of the string representation must match the specified format exactly. - - s: A string that contains a date and time to convert. - format: A format specifier that defines the required format of s. - provider: An object that supplies culture-specific format information about s. - Returns: An object that is equivalent to the date and time contained in s, as specified by format and provider. - ParseExact(s: str, format: str, provider: IFormatProvider, style: DateTimeStyles) -> DateTime - - Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format - exactly or an exception is thrown. - - - s: A string containing a date and time to convert. - format: A format specifier that defines the required format of s. - provider: An object that supplies culture-specific formatting information about s. - style: A bitwise combination of the enumeration values that provides additional information about s, about style elements that may be present in s, or about the conversion from s to a System.DateTime value. A typical value to specify is - System.Globalization.DateTimeStyles.None. - - Returns: An object that is equivalent to the date and time contained in s, as specified by format, provider, and style. - ParseExact(s: str, formats: Array[str], provider: IFormatProvider, style: DateTimeStyles) -> DateTime - - Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match at least one of - the specified formats exactly or an exception is thrown. - - - s: A string containing one or more dates and times to convert. - formats: An array of allowable formats of s. - provider: An object that supplies culture-specific format information about s. - style: A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.DateTimeStyles.None. - Returns: An object that is equivalent to the date and time contained in s, as specified by formats, provider, and style. - """ - pass - - @staticmethod - def SpecifyKind(value, kind): - # type: (value: DateTime, kind: DateTimeKind) -> DateTime - """ - SpecifyKind(value: DateTime, kind: DateTimeKind) -> DateTime - - Creates a new System.DateTime object that has the same number of ticks as the specified System.DateTime, but is designated as either local time, Coordinated Universal Time (UTC), or neither, as indicated by the specified System.DateTimeKind value. - - value: A date and time. - kind: One of the enumeration values that indicates whether the new object represents local time, UTC, or neither. - Returns: A new object that has the same number of ticks as the object represented by the value parameter and the System.DateTimeKind value specified by the kind parameter. - """ - pass - - def Subtract(self, value): - # type: (self: DateTime, value: DateTime) -> TimeSpan - """ - Subtract(self: DateTime, value: DateTime) -> TimeSpan - - Subtracts the specified date and time from this instance. - - value: The date and time value to subtract. - Returns: A time interval that is equal to the date and time represented by this instance minus the date and time represented by value. - Subtract(self: DateTime, value: TimeSpan) -> DateTime - - Subtracts the specified duration from this instance. - - value: The time interval to subtract. - Returns: An object that is equal to the date and time represented by this instance minus the time interval represented by value. - """ - pass - - def ToBinary(self): - # type: (self: DateTime) -> Int64 - """ - ToBinary(self: DateTime) -> Int64 - - Serializes the current System.DateTime object to a 64-bit binary value that subsequently can be used to recreate the System.DateTime object. - Returns: A 64-bit signed integer that encodes the System.DateTime.Kind and System.DateTime.Ticks properties. - """ - pass - - def ToFileTime(self): - # type: (self: DateTime) -> Int64 - """ - ToFileTime(self: DateTime) -> Int64 - - Converts the value of the current System.DateTime object to a Windows file time. - Returns: The value of the current System.DateTime object expressed as a Windows file time. - """ - pass - - def ToFileTimeUtc(self): - # type: (self: DateTime) -> Int64 - """ - ToFileTimeUtc(self: DateTime) -> Int64 - - Converts the value of the current System.DateTime object to a Windows file time. - Returns: The value of the current System.DateTime object expressed as a Windows file time. - """ - pass - - def ToLocalTime(self): - # type: (self: DateTime) -> DateTime - """ - ToLocalTime(self: DateTime) -> DateTime - - Converts the value of the current System.DateTime object to local time. - Returns: An object whose System.DateTime.Kind property is System.DateTimeKind.Local, and whose value is the local time equivalent to the value of the current System.DateTime object, or System.DateTime.MaxValue if the converted value is too large to be - represented by a System.DateTime object, or System.DateTime.MinValue if the converted value is too small to be represented as a System.DateTime object. - """ - pass - - def ToLongDateString(self): - # type: (self: DateTime) -> str - """ - ToLongDateString(self: DateTime) -> str - - Converts the value of the current System.DateTime object to its equivalent long date string representation. - Returns: A string that contains the long date string representation of the current System.DateTime object. - """ - pass - - def ToLongTimeString(self): - # type: (self: DateTime) -> str - """ - ToLongTimeString(self: DateTime) -> str - - Converts the value of the current System.DateTime object to its equivalent long time string representation. - Returns: A string that contains the long time string representation of the current System.DateTime object. - """ - pass - - def ToOADate(self): - # type: (self: DateTime) -> float - """ - ToOADate(self: DateTime) -> float - - Converts the value of this instance to the equivalent OLE Automation date. - Returns: A double-precision floating-point number that contains an OLE Automation date equivalent to the value of this instance. - """ - pass - - def ToShortDateString(self): - # type: (self: DateTime) -> str - """ - ToShortDateString(self: DateTime) -> str - - Converts the value of the current System.DateTime object to its equivalent short date string representation. - Returns: A string that contains the short date string representation of the current System.DateTime object. - """ - pass - - def ToShortTimeString(self): - # type: (self: DateTime) -> str - """ - ToShortTimeString(self: DateTime) -> str - - Converts the value of the current System.DateTime object to its equivalent short time string representation. - Returns: A string that contains the short time string representation of the current System.DateTime object. - """ - pass - - def ToString(self, *__args): - # type: (self: DateTime) -> str - """ - ToString(self: DateTime) -> str - - Converts the value of the current System.DateTime object to its equivalent string representation. - Returns: A string representation of the value of the current System.DateTime object. - ToString(self: DateTime, format: str) -> str - - Converts the value of the current System.DateTime object to its equivalent string representation using the specified format. - - format: A standard or custom date and time format string (see Remarks). - Returns: A string representation of value of the current System.DateTime object as specified by format. - ToString(self: DateTime, provider: IFormatProvider) -> str - - Converts the value of the current System.DateTime object to its equivalent string representation using the specified culture-specific format information. - - provider: An object that supplies culture-specific formatting information. - Returns: A string representation of value of the current System.DateTime object as specified by provider. - ToString(self: DateTime, format: str, provider: IFormatProvider) -> str - - Converts the value of the current System.DateTime object to its equivalent string representation using the specified format and culture-specific format information. - - format: A standard or custom date and time format string. - provider: An object that supplies culture-specific formatting information. - Returns: A string representation of value of the current System.DateTime object as specified by format and provider. - """ - pass - - def ToUniversalTime(self): - # type: (self: DateTime) -> DateTime - """ - ToUniversalTime(self: DateTime) -> DateTime - - Converts the value of the current System.DateTime object to Coordinated Universal Time (UTC). - Returns: An object whose System.DateTime.Kind property is System.DateTimeKind.Utc, and whose value is the UTC equivalent to the value of the current System.DateTime object, or System.DateTime.MaxValue if the converted value is too large to be represented by a - System.DateTime object, or System.DateTime.MinValue if the converted value is too small to be represented by a System.DateTime object. - """ - pass - - @staticmethod - def TryParse(s, *__args): - # type: (s: str) -> (bool, DateTime) - """ - TryParse(s: str) -> (bool, DateTime) - - Converts the specified string representation of a date and time to its System.DateTime equivalent and returns a value that indicates whether the conversion succeeded. - - s: A string containing a date and time to convert. - Returns: true if the s parameter was converted successfully; otherwise, false. - TryParse(s: str, provider: IFormatProvider, styles: DateTimeStyles) -> (bool, DateTime) - - Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified culture-specific format information and formatting style, and returns a value that indicates whether the conversion succeeded. - - s: A string containing a date and time to convert. - provider: An object that supplies culture-specific formatting information about s. - styles: A bitwise combination of enumeration values that defines how to interpret the parsed date in relation to the current time zone or the current date. A typical value to specify is System.Globalization.DateTimeStyles.None. - Returns: true if the s parameter was converted successfully; otherwise, false. - """ - pass - - @staticmethod - def TryParseExact(s, *__args): - # type: (s: str, format: str, provider: IFormatProvider, style: DateTimeStyles) -> (bool, DateTime) - """ - TryParseExact(s: str, format: str, provider: IFormatProvider, style: DateTimeStyles) -> (bool, DateTime) - - Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format - exactly. The method returns a value that indicates whether the conversion succeeded. - - - s: A string containing a date and time to convert. - format: The required format of s. - provider: An object that supplies culture-specific formatting information about s. - style: A bitwise combination of one or more enumeration values that indicate the permitted format of s. - Returns: true if s was converted successfully; otherwise, false. - TryParseExact(s: str, formats: Array[str], provider: IFormatProvider, style: DateTimeStyles) -> (bool, DateTime) - - Converts the specified string representation of a date and time to its System.DateTime equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match at least one of - the specified formats exactly. The method returns a value that indicates whether the conversion succeeded. - - - s: A string containing one or more dates and times to convert. - formats: An array of allowable formats of s. - provider: An object that supplies culture-specific format information about s. - style: A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.DateTimeStyles.None. - Returns: true if the s parameter was converted successfully; otherwise, false. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__[DateTime]() -> DateTime - - __new__(cls: type, ticks: Int64) - __new__(cls: type, ticks: Int64, kind: DateTimeKind) - __new__(cls: type, year: int, month: int, day: int) - __new__(cls: type, year: int, month: int, day: int, calendar: Calendar) - __new__(cls: type, year: int, month: int, day: int, hour: int, minute: int, second: int) - __new__(cls: type, year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) - __new__(cls: type, year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Calendar) - __new__(cls: type, year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int) - __new__(cls: type, year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, kind: DateTimeKind) - __new__(cls: type, year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, calendar: Calendar) - __new__(cls: type, year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, calendar: Calendar, kind: DateTimeKind) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ - __rsub__(d1: DateTime, d2: DateTime) -> TimeSpan - - Subtracts a specified date and time from another specified date and time and returns a time interval. - - d1: The date and time value to subtract from (the minuend). - d2: The date and time value to subtract (the subtrahend). - Returns: The time interval between d1 and d2; that is, d1 minus d2. - """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-yx.__sub__(y) <==> x-y """ - pass - - Date = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the date component of this instance. - - Get: Date(self: DateTime) -> DateTime - """ - - Day = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the day of the month represented by this instance. - - Get: Day(self: DateTime) -> int - """ - - DayOfWeek = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the day of the week represented by this instance. - - Get: DayOfWeek(self: DateTime) -> DayOfWeek - """ - - DayOfYear = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the day of the year represented by this instance. - - Get: DayOfYear(self: DateTime) -> int - """ - - Hour = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the hour component of the date represented by this instance. - - Get: Hour(self: DateTime) -> int - """ - - Kind = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (UTC), or neither. - """ - Gets a value that indicates whether the time represented by this instance is based on local time, Coordinated Universal Time (UTC), or neither. - - Get: Kind(self: DateTime) -> DateTimeKind - """ - - Millisecond = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the milliseconds component of the date represented by this instance. - - Get: Millisecond(self: DateTime) -> int - """ - - Minute = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the minute component of the date represented by this instance. - - Get: Minute(self: DateTime) -> int - """ - - Month = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the month component of the date represented by this instance. - - Get: Month(self: DateTime) -> int - """ - - Second = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the seconds component of the date represented by this instance. - - Get: Second(self: DateTime) -> int - """ - - Ticks = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of ticks that represent the date and time of this instance. - - Get: Ticks(self: DateTime) -> Int64 - """ - - TimeOfDay = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the time of day for this instance. - - Get: TimeOfDay(self: DateTime) -> TimeSpan - """ - - Year = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the year component of the date represented by this instance. - - Get: Year(self: DateTime) -> int - """ - - - MaxValue = None - MinValue = None - Now = None - Today = None - UtcNow = None - - -class DateTimeKind(Enum, IComparable, IFormattable, IConvertible): - # type: (UTC), or is not specified as either local time or UTC. - """ - Specifies whether a System.DateTime object represents a local time, a Coordinated Universal Time (UTC), or is not specified as either local time or UTC. - - enum DateTimeKind, values: Local (2), Unspecified (0), Utc (1) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Local = None - Unspecified = None - Utc = None - value__ = None - - -class DateTimeOffset(object, IComparable, IFormattable, ISerializable, IDeserializationCallback, IComparable[DateTimeOffset], IEquatable[DateTimeOffset]): - # type: (UTC). - """ - Represents a point in time, typically expressed as a date and time of day, relative to Coordinated Universal Time (UTC). - - DateTimeOffset(ticks: Int64, offset: TimeSpan) - DateTimeOffset(dateTime: DateTime) - DateTimeOffset(dateTime: DateTime, offset: TimeSpan) - DateTimeOffset(year: int, month: int, day: int, hour: int, minute: int, second: int, offset: TimeSpan) - DateTimeOffset(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, offset: TimeSpan) - DateTimeOffset(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, calendar: Calendar, offset: TimeSpan) - """ - def Add(self, timeSpan): - # type: (self: DateTimeOffset, timeSpan: TimeSpan) -> DateTimeOffset - """ - Add(self: DateTimeOffset, timeSpan: TimeSpan) -> DateTimeOffset - - Adds a specified time interval to a System.DateTimeOffset object. - - timeSpan: A System.TimeSpan object that represents a positive or a negative time interval. - Returns: An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the time interval represented by timeSpan. - """ - pass - - def AddDays(self, days): - # type: (self: DateTimeOffset, days: float) -> DateTimeOffset - """ - AddDays(self: DateTimeOffset, days: float) -> DateTimeOffset - - Adds a specified number of whole and fractional days to the current System.DateTimeOffset object. - - days: A number of whole and fractional days. The number can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of days represented by days. - """ - pass - - def AddHours(self, hours): - # type: (self: DateTimeOffset, hours: float) -> DateTimeOffset - """ - AddHours(self: DateTimeOffset, hours: float) -> DateTimeOffset - - Adds a specified number of whole and fractional hours to the current System.DateTimeOffset object. - - hours: A number of whole and fractional hours. The number can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of hours represented by hours. - """ - pass - - def AddMilliseconds(self, milliseconds): - # type: (self: DateTimeOffset, milliseconds: float) -> DateTimeOffset - """ - AddMilliseconds(self: DateTimeOffset, milliseconds: float) -> DateTimeOffset - - Adds a specified number of milliseconds to the current System.DateTimeOffset object. - - milliseconds: A number of whole and fractional milliseconds. The number can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of whole milliseconds represented by milliseconds. - """ - pass - - def AddMinutes(self, minutes): - # type: (self: DateTimeOffset, minutes: float) -> DateTimeOffset - """ - AddMinutes(self: DateTimeOffset, minutes: float) -> DateTimeOffset - - Adds a specified number of whole and fractional minutes to the current System.DateTimeOffset object. - - minutes: A number of whole and fractional minutes. The number can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of minutes represented by minutes. - """ - pass - - def AddMonths(self, months): - # type: (self: DateTimeOffset, months: int) -> DateTimeOffset - """ - AddMonths(self: DateTimeOffset, months: int) -> DateTimeOffset - - Adds a specified number of months to the current System.DateTimeOffset object. - - months: A number of whole months. The number can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of months represented by months. - """ - pass - - def AddSeconds(self, seconds): - # type: (self: DateTimeOffset, seconds: float) -> DateTimeOffset - """ - AddSeconds(self: DateTimeOffset, seconds: float) -> DateTimeOffset - - Adds a specified number of whole and fractional seconds to the current System.DateTimeOffset object. - - seconds: A number of whole and fractional seconds. The number can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of seconds represented by seconds. - """ - pass - - def AddTicks(self, ticks): - # type: (self: DateTimeOffset, ticks: Int64) -> DateTimeOffset - """ - AddTicks(self: DateTimeOffset, ticks: Int64) -> DateTimeOffset - - Adds a specified number of ticks to the current System.DateTimeOffset object. - - ticks: A number of 100-nanosecond ticks. The number can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of ticks represented by ticks. - """ - pass - - def AddYears(self, years): - # type: (self: DateTimeOffset, years: int) -> DateTimeOffset - """ - AddYears(self: DateTimeOffset, years: int) -> DateTimeOffset - - Adds a specified number of years to the System.DateTimeOffset object. - - years: A number of years. The number can be negative or positive. - Returns: An object whose value is the sum of the date and time represented by the current System.DateTimeOffset object and the number of years represented by years. - """ - pass - - @staticmethod - def Compare(first, second): - # type: (first: DateTimeOffset, second: DateTimeOffset) -> int - """ - Compare(first: DateTimeOffset, second: DateTimeOffset) -> int - - Compares two System.DateTimeOffset objects and indicates whether the first is earlier than the second, equal to the second, or later than the second. - - first: The first object to compare. - second: The second object to compare. - Returns: A signed integer that indicates whether the value of the first parameter is earlier than, later than, or the same time as the value of the second parameter, as the following table shows.Return valueMeaningLess than zerofirst is earlier than - second.Zerofirst is equal to second.Greater than zerofirst is later than second. - """ - pass - - def CompareTo(self, other): - # type: (self: DateTimeOffset, other: DateTimeOffset) -> int - """ - CompareTo(self: DateTimeOffset, other: DateTimeOffset) -> int - - Compares the current System.DateTimeOffset object to a specified System.DateTimeOffset object and indicates whether the current object is earlier than, the same as, or later than the second System.DateTimeOffset object. - - other: An object to compare with the current System.DateTimeOffset object. - Returns: A signed integer that indicates the relationship between the current System.DateTimeOffset object and other, as the following table shows.Return ValueDescriptionLess than zeroThe current System.DateTimeOffset object is earlier than other.ZeroThe - current System.DateTimeOffset object is the same as other.Greater than zero.The current System.DateTimeOffset object is later than other. - """ - pass - - def Equals(self, *__args): - # type: (self: DateTimeOffset, obj: object) -> bool - """ - Equals(self: DateTimeOffset, obj: object) -> bool - - Determines whether a System.DateTimeOffset object represents the same point in time as a specified object. - - obj: The object to compare to the current System.DateTimeOffset object. - Returns: true if the obj parameter is a System.DateTimeOffset object and represents the same point in time as the current System.DateTimeOffset object; otherwise, false. - Equals(self: DateTimeOffset, other: DateTimeOffset) -> bool - - Determines whether the current System.DateTimeOffset object represents the same point in time as a specified System.DateTimeOffset object. - - other: An object to compare to the current System.DateTimeOffset object. - Returns: true if both System.DateTimeOffset objects have the same System.DateTimeOffset.UtcDateTime value; otherwise, false. - Equals(first: DateTimeOffset, second: DateTimeOffset) -> bool - - Determines whether two specified System.DateTimeOffset objects represent the same point in time. - - first: The first object to compare. - second: The second object to compare. - Returns: true if the two System.DateTimeOffset objects have the same System.DateTimeOffset.UtcDateTime value; otherwise, false. - """ - pass - - def EqualsExact(self, other): - # type: (self: DateTimeOffset, other: DateTimeOffset) -> bool - """ - EqualsExact(self: DateTimeOffset, other: DateTimeOffset) -> bool - - Determines whether the current System.DateTimeOffset object represents the same time and has the same offset as a specified System.DateTimeOffset object. - - other: The object to compare to the current System.DateTimeOffset object. - Returns: true if the current System.DateTimeOffset object and other have the same date and time value and the same System.DateTimeOffset.Offset value; otherwise, false. - """ - pass - - @staticmethod - def FromFileTime(fileTime): - # type: (fileTime: Int64) -> DateTimeOffset - """ - FromFileTime(fileTime: Int64) -> DateTimeOffset - - Converts the specified Windows file time to an equivalent local time. - - fileTime: A Windows file time, expressed in ticks. - Returns: An object that represents the date and time of fileTime with the offset set to the local time offset. - """ - pass - - @staticmethod - def FromUnixTimeMilliseconds(milliseconds): - # type: (milliseconds: Int64) -> DateTimeOffset - """ FromUnixTimeMilliseconds(milliseconds: Int64) -> DateTimeOffset """ - pass - - @staticmethod - def FromUnixTimeSeconds(seconds): - # type: (seconds: Int64) -> DateTimeOffset - """ FromUnixTimeSeconds(seconds: Int64) -> DateTimeOffset """ - pass - - def GetHashCode(self): - # type: (self: DateTimeOffset) -> int - """ - GetHashCode(self: DateTimeOffset) -> int - - Returns the hash code for the current System.DateTimeOffset object. - Returns: A 32-bit signed integer hash code. - """ - pass - - @staticmethod - def Parse(input, formatProvider=None, styles=None): - # type: (input: str) -> DateTimeOffset - """ - Parse(input: str) -> DateTimeOffset - - Converts the specified string representation of a date, time, and offset to its System.DateTimeOffset equivalent. - - input: A string that contains a date and time to convert. - Returns: An object that is equivalent to the date and time that is contained in input. - Parse(input: str, formatProvider: IFormatProvider) -> DateTimeOffset - - Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified culture-specific format information. - - input: A string that contains a date and time to convert. - formatProvider: An object that provides culture-specific format information about input. - Returns: An object that is equivalent to the date and time that is contained in input, as specified by formatProvider. - Parse(input: str, formatProvider: IFormatProvider, styles: DateTimeStyles) -> DateTimeOffset - - Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified culture-specific format information and formatting style. - - input: A string that contains a date and time to convert. - formatProvider: An object that provides culture-specific format information about input. - styles: A bitwise combination of enumeration values that indicates the permitted format of input. A typical value to specify is System.Globalization.DateTimeStyles.None. - Returns: An object that is equivalent to the date and time that is contained in input as specified by formatProvider and styles. - """ - pass - - @staticmethod - def ParseExact(input, *__args): - # type: (input: str, format: str, formatProvider: IFormatProvider) -> DateTimeOffset - """ - ParseExact(input: str, format: str, formatProvider: IFormatProvider) -> DateTimeOffset - - Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified format and culture-specific format information. The format of the string representation must match the specified format exactly. - - input: A string that contains a date and time to convert. - format: A format specifier that defines the expected format of input. - formatProvider: An object that supplies culture-specific formatting information about input. - Returns: An object that is equivalent to the date and time that is contained in input as specified by format and formatProvider. - ParseExact(input: str, format: str, formatProvider: IFormatProvider, styles: DateTimeStyles) -> DateTimeOffset - - Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format - exactly. - - - input: A string that contains a date and time to convert. - format: A format specifier that defines the expected format of input. - formatProvider: An object that supplies culture-specific formatting information about input. - styles: A bitwise combination of enumeration values that indicates the permitted format of input. - Returns: An object that is equivalent to the date and time that is contained in the input parameter, as specified by the format, formatProvider, and styles parameters. - ParseExact(input: str, formats: Array[str], formatProvider: IFormatProvider, styles: DateTimeStyles) -> DateTimeOffset - - Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified formats, culture-specific format information, and style. The format of the string representation must match one of the - specified formats exactly. - - - input: A string that contains a date and time to convert. - formats: An array of format specifiers that define the expected formats of input. - formatProvider: An object that supplies culture-specific formatting information about input. - styles: A bitwise combination of enumeration values that indicates the permitted format of input. - Returns: An object that is equivalent to the date and time that is contained in the input parameter, as specified by the formats, formatProvider, and styles parameters. - """ - pass - - def Subtract(self, value): - # type: (self: DateTimeOffset, value: DateTimeOffset) -> TimeSpan - """ - Subtract(self: DateTimeOffset, value: DateTimeOffset) -> TimeSpan - - Subtracts a System.DateTimeOffset value that represents a specific date and time from the current System.DateTimeOffset object. - - value: An object that represents the value to subtract. - Returns: An object that specifies the interval between the two System.DateTimeOffset objects. - Subtract(self: DateTimeOffset, value: TimeSpan) -> DateTimeOffset - - Subtracts a specified time interval from the current System.DateTimeOffset object. - - value: The time interval to subtract. - Returns: An object that is equal to the date and time represented by the current System.DateTimeOffset object, minus the time interval represented by value. - """ - pass - - def ToFileTime(self): - # type: (self: DateTimeOffset) -> Int64 - """ - ToFileTime(self: DateTimeOffset) -> Int64 - - Converts the value of the current System.DateTimeOffset object to a Windows file time. - Returns: The value of the current System.DateTimeOffset object, expressed as a Windows file time. - """ - pass - - def ToLocalTime(self): - # type: (self: DateTimeOffset) -> DateTimeOffset - """ - ToLocalTime(self: DateTimeOffset) -> DateTimeOffset - - Converts the current System.DateTimeOffset object to a System.DateTimeOffset object that represents the local time. - Returns: An object that represents the date and time of the current System.DateTimeOffset object converted to local time. - """ - pass - - def ToOffset(self, offset): - # type: (self: DateTimeOffset, offset: TimeSpan) -> DateTimeOffset - """ - ToOffset(self: DateTimeOffset, offset: TimeSpan) -> DateTimeOffset - - Converts the value of the current System.DateTimeOffset object to the date and time specified by an offset value. - - offset: The offset to convert the System.DateTimeOffset value to. - Returns: An object that is equal to the original System.DateTimeOffset object (that is, their System.DateTimeOffset.ToUniversalTime methods return identical points in time) but whose System.DateTimeOffset.Offset property is set to offset. - """ - pass - - def ToString(self, *__args): - # type: (self: DateTimeOffset) -> str - """ - ToString(self: DateTimeOffset) -> str - - Converts the value of the current System.DateTimeOffset object to its equivalent string representation. - Returns: A string representation of a System.DateTimeOffset object that includes the offset appended at the end of the string. - ToString(self: DateTimeOffset, format: str) -> str - - Converts the value of the current System.DateTimeOffset object to its equivalent string representation using the specified format. - - format: A format string. - Returns: A string representation of the value of the current System.DateTimeOffset object, as specified by format. - ToString(self: DateTimeOffset, formatProvider: IFormatProvider) -> str - - Converts the value of the current System.DateTimeOffset object to its equivalent string representation using the specified culture-specific formatting information. - - formatProvider: An object that supplies culture-specific formatting information. - Returns: A string representation of the value of the current System.DateTimeOffset object, as specified by formatProvider. - ToString(self: DateTimeOffset, format: str, formatProvider: IFormatProvider) -> str - - Converts the value of the current System.DateTimeOffset object to its equivalent string representation using the specified format and culture-specific format information. - - format: A format string. - formatProvider: An object that supplies culture-specific formatting information. - Returns: A string representation of the value of the current System.DateTimeOffset object, as specified by format and provider. - """ - pass - - def ToUniversalTime(self): - # type: (self: DateTimeOffset) -> DateTimeOffset - """ - ToUniversalTime(self: DateTimeOffset) -> DateTimeOffset - - Converts the current System.DateTimeOffset object to a System.DateTimeOffset value that represents the Coordinated Universal Time (UTC). - Returns: An object that represents the date and time of the current System.DateTimeOffset object converted to Coordinated Universal Time (UTC). - """ - pass - - def ToUnixTimeMilliseconds(self): - # type: (self: DateTimeOffset) -> Int64 - """ ToUnixTimeMilliseconds(self: DateTimeOffset) -> Int64 """ - pass - - def ToUnixTimeSeconds(self): - # type: (self: DateTimeOffset) -> Int64 - """ ToUnixTimeSeconds(self: DateTimeOffset) -> Int64 """ - pass - - @staticmethod - def TryParse(input, *__args): - # type: (input: str) -> (bool, DateTimeOffset) - """ - TryParse(input: str) -> (bool, DateTimeOffset) - - Tries to converts a specified string representation of a date and time to its System.DateTimeOffset equivalent, and returns a value that indicates whether the conversion succeeded. - - input: A string that contains a date and time to convert. - Returns: true if the input parameter is successfully converted; otherwise, false. - TryParse(input: str, formatProvider: IFormatProvider, styles: DateTimeStyles) -> (bool, DateTimeOffset) - - Tries to convert a specified string representation of a date and time to its System.DateTimeOffset equivalent, and returns a value that indicates whether the conversion succeeded. - - input: A string that contains a date and time to convert. - formatProvider: An object that provides culture-specific formatting information about input. - styles: A bitwise combination of enumeration values that indicates the permitted format of input. - Returns: true if the input parameter is successfully converted; otherwise, false. - """ - pass - - @staticmethod - def TryParseExact(input, *__args): - # type: (input: str, format: str, formatProvider: IFormatProvider, styles: DateTimeStyles) -> (bool, DateTimeOffset) - """ - TryParseExact(input: str, format: str, formatProvider: IFormatProvider, styles: DateTimeStyles) -> (bool, DateTimeOffset) - - Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified format, culture-specific format information, and style. The format of the string representation must match the specified format - exactly. - - - input: A string that contains a date and time to convert. - format: A format specifier that defines the required format of input. - formatProvider: An object that supplies culture-specific formatting information about input. - styles: A bitwise combination of enumeration values that indicates the permitted format of input. A typical value to specify is None. - Returns: true if the input parameter is successfully converted; otherwise, false. - TryParseExact(input: str, formats: Array[str], formatProvider: IFormatProvider, styles: DateTimeStyles) -> (bool, DateTimeOffset) - - Converts the specified string representation of a date and time to its System.DateTimeOffset equivalent using the specified array of formats, culture-specific format information, and style. The format of the string representation must match one of the - specified formats exactly. - - - input: A string that contains a date and time to convert. - formats: An array that defines the expected formats of input. - formatProvider: An object that supplies culture-specific formatting information about input. - styles: A bitwise combination of enumeration values that indicates the permitted format of input. A typical value to specify is None. - Returns: true if the input parameter is successfully converted; otherwise, false. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__[DateTimeOffset]() -> DateTimeOffset - - __new__(cls: type, ticks: Int64, offset: TimeSpan) - __new__(cls: type, dateTime: DateTime) - __new__(cls: type, dateTime: DateTime, offset: TimeSpan) - __new__(cls: type, year: int, month: int, day: int, hour: int, minute: int, second: int, offset: TimeSpan) - __new__(cls: type, year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, offset: TimeSpan) - __new__(cls: type, year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, calendar: Calendar, offset: TimeSpan) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ - __rsub__(left: DateTimeOffset, right: DateTimeOffset) -> TimeSpan - - Subtracts one System.DateTimeOffset object from another and yields a time interval. - - left: The minuend. - right: The subtrahend. - Returns: An object that represents the difference between left and right. - """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-yx.__sub__(y) <==> x-y """ - pass - - Date = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.DateTime value that represents the date component of the current System.DateTimeOffset object. - - Get: Date(self: DateTimeOffset) -> DateTime - """ - - DateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.DateTime value that represents the date and time of the current System.DateTimeOffset object. - - Get: DateTime(self: DateTimeOffset) -> DateTime - """ - - Day = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the day of the month represented by the current System.DateTimeOffset object. - - Get: Day(self: DateTimeOffset) -> int - """ - - DayOfWeek = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the day of the week represented by the current System.DateTimeOffset object. - - Get: DayOfWeek(self: DateTimeOffset) -> DayOfWeek - """ - - DayOfYear = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the day of the year represented by the current System.DateTimeOffset object. - - Get: DayOfYear(self: DateTimeOffset) -> int - """ - - Hour = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the hour component of the time represented by the current System.DateTimeOffset object. - - Get: Hour(self: DateTimeOffset) -> int - """ - - LocalDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.DateTime value that represents the local date and time of the current System.DateTimeOffset object. - - Get: LocalDateTime(self: DateTimeOffset) -> DateTime - """ - - Millisecond = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the millisecond component of the time represented by the current System.DateTimeOffset object. - - Get: Millisecond(self: DateTimeOffset) -> int - """ - - Minute = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the minute component of the time represented by the current System.DateTimeOffset object. - - Get: Minute(self: DateTimeOffset) -> int - """ - - Month = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the month component of the date represented by the current System.DateTimeOffset object. - - Get: Month(self: DateTimeOffset) -> int - """ - - Offset = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (UTC). - """ - Gets the time's offset from Coordinated Universal Time (UTC). - - Get: Offset(self: DateTimeOffset) -> TimeSpan - """ - - Second = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the second component of the clock time represented by the current System.DateTimeOffset object. - - Get: Second(self: DateTimeOffset) -> int - """ - - Ticks = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of ticks that represents the date and time of the current System.DateTimeOffset object in clock time. - - Get: Ticks(self: DateTimeOffset) -> Int64 - """ - - TimeOfDay = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the time of day for the current System.DateTimeOffset object. - - Get: TimeOfDay(self: DateTimeOffset) -> TimeSpan - """ - - UtcDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (UTC) date and time of the current System.DateTimeOffset object. - """ - Gets a System.DateTime value that represents the Coordinated Universal Time (UTC) date and time of the current System.DateTimeOffset object. - - Get: UtcDateTime(self: DateTimeOffset) -> DateTime - """ - - UtcTicks = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (UTC). - """ - Gets the number of ticks that represents the date and time of the current System.DateTimeOffset object in Coordinated Universal Time (UTC). - - Get: UtcTicks(self: DateTimeOffset) -> Int64 - """ - - Year = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the year component of the date represented by the current System.DateTimeOffset object. - - Get: Year(self: DateTimeOffset) -> int - """ - - - MaxValue = None - MinValue = None - Now = None - UtcNow = None - - -class DayOfWeek(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies the day of the week. - - enum DayOfWeek, values: Friday (5), Monday (1), Saturday (6), Sunday (0), Thursday (4), Tuesday (2), Wednesday (3) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Friday = None - Monday = None - Saturday = None - Sunday = None - Thursday = None - Tuesday = None - value__ = None - Wednesday = None - - -class DBNull(object, ISerializable, IConvertible): - """ Represents a nonexistent value. This class cannot be inherited. """ - def GetObjectData(self, info, context): - # type: (self: DBNull, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: DBNull, info: SerializationInfo, context: StreamingContext) - Implements the System.Runtime.Serialization.ISerializable interface and returns the data needed to serialize the System.DBNull object. - - info: A System.Runtime.Serialization.SerializationInfo object containing information required to serialize the System.DBNull object. - context: A System.Runtime.Serialization.StreamingContext object containing the source and destination of the serialized stream associated with the System.DBNull object. - """ - pass - - def GetTypeCode(self): - # type: (self: DBNull) -> TypeCode - """ - GetTypeCode(self: DBNull) -> TypeCode - - Gets the System.TypeCode value for System.DBNull. - Returns: The System.TypeCode value for System.DBNull, which is System.TypeCode.DBNull. - """ - pass - - def ToString(self, provider=None): - # type: (self: DBNull) -> str - """ - ToString(self: DBNull) -> str - - Returns an empty string (System.String.Empty). - Returns: An empty string (System.String.Empty). - ToString(self: DBNull, provider: IFormatProvider) -> str - - Returns an empty string using the specified System.IFormatProvider. - - provider: The System.IFormatProvider to be used to format the return value.-or- null to obtain the format information from the current locale setting of the operating system. - Returns: An empty string (System.String.Empty). - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(value: DBNull) -> bool """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Value = None - - -class Decimal(object, IFormattable, IComparable, IConvertible, IDeserializationCallback, IComparable[Decimal], IEquatable[Decimal]): - """ - Represents a decimal number. - - Decimal(value: int) - Decimal(value: UInt32) - Decimal(value: Int64) - Decimal(value: UInt64) - Decimal(value: Single) - Decimal(value: float) - Decimal(bits: Array[int]) - Decimal(lo: int, mid: int, hi: int, isNegative: bool, scale: Byte) - """ - @staticmethod - def Add(d1, d2): - # type: (d1: Decimal, d2: Decimal) -> Decimal - """ - Add(d1: Decimal, d2: Decimal) -> Decimal - - Adds two specified System.Decimal values. - - d1: The first value to add. - d2: The second value to add. - Returns: The sum of d1 and d2. - """ - pass - - @staticmethod - def Ceiling(d): - # type: (d: Decimal) -> Decimal - """ - Ceiling(d: Decimal) -> Decimal - - Returns the smallest integral value that is greater than or equal to the specified decimal number. - - d: A decimal number. - Returns: The smallest integral value that is greater than or equal to the d parameter. Note that this method returns a System.Decimal instead of an integral type. - """ - pass - - @staticmethod - def Compare(d1, d2): - # type: (d1: Decimal, d2: Decimal) -> int - """ - Compare(d1: Decimal, d2: Decimal) -> int - - Compares two specified System.Decimal values. - - d1: The first value to compare. - d2: The second value to compare. - Returns: A signed number indicating the relative values of d1 and d2.Return Value Meaning Less than zero d1 is less than d2. Zero d1 and d2 are equal. Greater than zero d1 is greater than d2. - """ - pass - - def CompareTo(self, value): - # type: (self: Decimal, value: object) -> int - """ - CompareTo(self: Decimal, value: object) -> int - - Compares this instance to a specified System.Object. - - value: The object to compare with this instance, or null. - Returns: A signed number indicating the relative values of this instance and value.Return Value Meaning Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.-or- value is - null. - - CompareTo(self: Decimal, value: Decimal) -> int - - Compares this instance to a specified System.Decimal object. - - value: The object to compare with this instance. - Returns: A signed number indicating the relative values of this instance and value.Return Value Meaning Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value. - """ - pass - - @staticmethod - def Divide(d1, d2): - # type: (d1: Decimal, d2: Decimal) -> Decimal - """ - Divide(d1: Decimal, d2: Decimal) -> Decimal - - Divides two specified System.Decimal values. - - d1: The dividend. - d2: The divisor. - Returns: The result of dividing d1 by d2. - """ - pass - - def Equals(self, *__args): - # type: (self: Decimal, value: object) -> bool - """ - Equals(self: Decimal, value: object) -> bool - - Returns a value indicating whether this instance and a specified System.Object represent the same type and value. - - value: The object to compare with this instance. - Returns: true if value is a System.Decimal and equal to this instance; otherwise, false. - Equals(self: Decimal, value: Decimal) -> bool - - Returns a value indicating whether this instance and a specified System.Decimal object represent the same value. - - value: An object to compare to this instance. - Returns: true if value is equal to this instance; otherwise, false. - Equals(d1: Decimal, d2: Decimal) -> bool - - Returns a value indicating whether two specified instances of System.Decimal represent the same value. - - d1: The first value to compare. - d2: The second value to compare. - Returns: true if d1 and d2 are equal; otherwise, false. - """ - pass - - @staticmethod - def Floor(d): - # type: (d: Decimal) -> Decimal - """ - Floor(d: Decimal) -> Decimal - - Rounds a specified System.Decimal number to the closest integer toward negative infinity. - - d: The value to round. - Returns: If d has a fractional part, the next whole System.Decimal number toward negative infinity that is less than d.-or- If d doesn't have a fractional part, d is returned unchanged. - """ - pass - - @staticmethod - def FromOACurrency(cy): - # type: (cy: Int64) -> Decimal - """ - FromOACurrency(cy: Int64) -> Decimal - - Converts the specified 64-bit signed integer, which contains an OLE Automation Currency value, to the equivalent System.Decimal value. - - cy: An OLE Automation Currency value. - Returns: A System.Decimal that contains the equivalent of cy. - """ - pass - - @staticmethod - def GetBits(d): - # type: (d: Decimal) -> Array[int] - """ - GetBits(d: Decimal) -> Array[int] - - Converts the value of a specified instance of System.Decimal to its equivalent binary representation. - - d: The value to convert. - Returns: A 32-bit signed integer array with four elements that contain the binary representation of d. - """ - pass - - def GetHashCode(self): - # type: (self: Decimal) -> int - """ - GetHashCode(self: Decimal) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetTypeCode(self): - # type: (self: Decimal) -> TypeCode - """ - GetTypeCode(self: Decimal) -> TypeCode - - Returns the System.TypeCode for value type System.Decimal. - Returns: The enumerated constant System.TypeCode.Decimal. - """ - pass - - @staticmethod - def Multiply(d1, d2): - # type: (d1: Decimal, d2: Decimal) -> Decimal - """ - Multiply(d1: Decimal, d2: Decimal) -> Decimal - - Multiplies two specified System.Decimal values. - - d1: The multiplicand. - d2: The multiplier. - Returns: The result of multiplying d1 and d2. - """ - pass - - @staticmethod - def Negate(d): - # type: (d: Decimal) -> Decimal - """ - Negate(d: Decimal) -> Decimal - - Returns the result of multiplying the specified System.Decimal value by negative one. - - d: The value to negate. - Returns: A decimal number with the value of d, but the opposite sign.-or- Zero, if d is zero. - """ - pass - - @staticmethod - def Parse(s, *__args): - # type: (s: str) -> Decimal - """ - Parse(s: str) -> Decimal - - Converts the string representation of a number to its System.Decimal equivalent. - - s: The string representation of the number to convert. - Returns: The equivalent to the number contained in s. - Parse(s: str, style: NumberStyles) -> Decimal - - Converts the string representation of a number in a specified style to its System.Decimal equivalent. - - s: The string representation of the number to convert. - style: A bitwise combination of System.Globalization.NumberStyles values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Number. - Returns: The System.Decimal number equivalent to the number contained in s as specified by style. - Parse(s: str, provider: IFormatProvider) -> Decimal - - Converts the string representation of a number to its System.Decimal equivalent using the specified culture-specific format information. - - s: The string representation of the number to convert. - provider: An System.IFormatProvider that supplies culture-specific parsing information about s. - Returns: The System.Decimal number equivalent to the number contained in s as specified by provider. - Parse(s: str, style: NumberStyles, provider: IFormatProvider) -> Decimal - - Converts the string representation of a number to its System.Decimal equivalent using the specified style and culture-specific format. - - s: The string representation of the number to convert. - style: A bitwise combination of System.Globalization.NumberStyles values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Number. - provider: An System.IFormatProvider object that supplies culture-specific information about the format of s. - Returns: The System.Decimal number equivalent to the number contained in s as specified by style and provider. - """ - pass - - @staticmethod - def Remainder(d1, d2): - # type: (d1: Decimal, d2: Decimal) -> Decimal - """ - Remainder(d1: Decimal, d2: Decimal) -> Decimal - - Computes the remainder after dividing two System.Decimal values. - - d1: The dividend. - d2: The divisor. - Returns: The remainder after dividing d1 by d2. - """ - pass - - @staticmethod - def Round(d, *__args): - # type: (d: Decimal) -> Decimal - """ - Round(d: Decimal) -> Decimal - - Rounds a decimal value to the nearest integer. - - d: A decimal number to round. - Returns: The integer that is nearest to the d parameter. If d is halfway between two integers, one of which is even and the other odd, the even number is returned. - Round(d: Decimal, decimals: int) -> Decimal - - Rounds a System.Decimal value to a specified number of decimal places. - - d: A decimal number to round. - decimals: A value from 0 to 28 that specifies the number of decimal places to round to. - Returns: The decimal number equivalent to d rounded to decimals number of decimal places. - Round(d: Decimal, mode: MidpointRounding) -> Decimal - - Rounds a decimal value to the nearest integer. A parameter specifies how to round the value if it is midway between two other numbers. - - d: A decimal number to round. - mode: A value that specifies how to round d if it is midway between two other numbers. - Returns: The integer that is nearest to the d parameter. If d is halfway between two numbers, one of which is even and the other odd, the mode parameter determines which of the two numbers is returned. - Round(d: Decimal, decimals: int, mode: MidpointRounding) -> Decimal - - Rounds a decimal value to a specified precision. A parameter specifies how to round the value if it is midway between two other numbers. - - d: A decimal number to round. - decimals: The number of significant decimal places (precision) in the return value. - mode: A value that specifies how to round d if it is midway between two other numbers. - Returns: The number that is nearest to the d parameter with a precision equal to the decimals parameter. If d is halfway between two numbers, one of which is even and the other odd, the mode parameter determines which of the two numbers is returned. If the - precision of d is less than decimals, d is returned unchanged. - """ - pass - - @staticmethod - def Subtract(d1, d2): - # type: (d1: Decimal, d2: Decimal) -> Decimal - """ - Subtract(d1: Decimal, d2: Decimal) -> Decimal - - Subtracts one specified System.Decimal value from another. - - d1: The minuend. - d2: The subtrahend. - Returns: The result of subtracting d2 from d1. - """ - pass - - @staticmethod - def ToByte(value): - # type: (value: Decimal) -> Byte - """ - ToByte(value: Decimal) -> Byte - - Converts the value of the specified System.Decimal to the equivalent 8-bit unsigned integer. - - value: The decimal number to convert. - Returns: An 8-bit unsigned integer equivalent to value. - """ - pass - - @staticmethod - def ToDouble(d): - # type: (d: Decimal) -> float - """ - ToDouble(d: Decimal) -> float - - Converts the value of the specified System.Decimal to the equivalent double-precision floating-point number. - - d: The decimal number to convert. - Returns: A double-precision floating-point number equivalent to d. - """ - pass - - @staticmethod - def ToInt16(value): - # type: (value: Decimal) -> Int16 - """ - ToInt16(value: Decimal) -> Int16 - - Converts the value of the specified System.Decimal to the equivalent 16-bit signed integer. - - value: The decimal number to convert. - Returns: A 16-bit signed integer equivalent to value. - """ - pass - - @staticmethod - def ToInt32(d): - # type: (d: Decimal) -> int - """ - ToInt32(d: Decimal) -> int - - Converts the value of the specified System.Decimal to the equivalent 32-bit signed integer. - - d: The decimal number to convert. - Returns: A 32-bit signed integer equivalent to the value of d. - """ - pass - - @staticmethod - def ToInt64(d): - # type: (d: Decimal) -> Int64 - """ - ToInt64(d: Decimal) -> Int64 - - Converts the value of the specified System.Decimal to the equivalent 64-bit signed integer. - - d: The decimal number to convert. - Returns: A 64-bit signed integer equivalent to the value of d. - """ - pass - - @staticmethod - def ToOACurrency(value): - # type: (value: Decimal) -> Int64 - """ - ToOACurrency(value: Decimal) -> Int64 - - Converts the specified System.Decimal value to the equivalent OLE Automation Currency value, which is contained in a 64-bit signed integer. - - value: The decimal number to convert. - Returns: A 64-bit signed integer that contains the OLE Automation equivalent of value. - """ - pass - - @staticmethod - def ToSByte(value): - # type: (value: Decimal) -> SByte - """ - ToSByte(value: Decimal) -> SByte - - Converts the value of the specified System.Decimal to the equivalent 8-bit signed integer. - - value: The decimal number to convert. - Returns: An 8-bit signed integer equivalent to value. - """ - pass - - @staticmethod - def ToSingle(d): - # type: (d: Decimal) -> Single - """ - ToSingle(d: Decimal) -> Single - - Converts the value of the specified System.Decimal to the equivalent single-precision floating-point number. - - d: The decimal number to convert. - Returns: A single-precision floating-point number equivalent to the value of d. - """ - pass - - def ToString(self, *__args): - # type: (self: Decimal) -> str - """ - ToString(self: Decimal) -> str - - Converts the numeric value of this instance to its equivalent string representation. - Returns: A string that represents the value of this instance. - ToString(self: Decimal, format: str) -> str - - Converts the numeric value of this instance to its equivalent string representation, using the specified format. - - format: A standard or custom numeric format string (see Remarks). - Returns: The string representation of the value of this instance as specified by format. - ToString(self: Decimal, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information. - - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance as specified by provider. - ToString(self: Decimal, format: str, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information. - - format: A numeric format string (see Remarks). - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance as specified by format and provider. - """ - pass - - @staticmethod - def ToUInt16(value): - # type: (value: Decimal) -> UInt16 - """ - ToUInt16(value: Decimal) -> UInt16 - - Converts the value of the specified System.Decimal to the equivalent 16-bit unsigned integer. - - value: The decimal number to convert. - Returns: A 16-bit unsigned integer equivalent to the value of value. - """ - pass - - @staticmethod - def ToUInt32(d): - # type: (d: Decimal) -> UInt32 - """ - ToUInt32(d: Decimal) -> UInt32 - - Converts the value of the specified System.Decimal to the equivalent 32-bit unsigned integer. - - d: The decimal number to convert. - Returns: A 32-bit unsigned integer equivalent to the value of d. - """ - pass - - @staticmethod - def ToUInt64(d): - # type: (d: Decimal) -> UInt64 - """ - ToUInt64(d: Decimal) -> UInt64 - - Converts the value of the specified System.Decimal to the equivalent 64-bit unsigned integer. - - d: The decimal number to convert. - Returns: A 64-bit unsigned integer equivalent to the value of d. - """ - pass - - @staticmethod - def Truncate(d): - # type: (d: Decimal) -> Decimal - """ - Truncate(d: Decimal) -> Decimal - - Returns the integral digits of the specified System.Decimal; any fractional digits are discarded. - - d: The decimal number to truncate. - Returns: The result of d rounded toward zero, to the nearest whole number. - """ - pass - - @staticmethod - def TryParse(s, *__args): - # type: (s: str) -> (bool, Decimal) - """ - TryParse(s: str) -> (bool, Decimal) - - Converts the string representation of a number to its System.Decimal equivalent. A return value indicates whether the conversion succeeded or failed. - - s: The string representation of the number to convert. - Returns: true if s was converted successfully; otherwise, false. - TryParse(s: str, style: NumberStyles, provider: IFormatProvider) -> (bool, Decimal) - - Converts the string representation of a number to its System.Decimal equivalent using the specified style and culture-specific format. A return value indicates whether the conversion succeeded or failed. - - s: The string representation of the number to convert. - style: A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Number. - provider: An object that supplies culture-specific parsing information about s. - Returns: true if s was converted successfully; otherwise, false. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __complex__(self, *args): #cannot find CLR method - """ __complex__(value: Decimal) -> float """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/y """ - pass - - def __float__(self, *args): #cannot find CLR method - """ __complex__(value: Decimal) -> float """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(self: Decimal, formatSpec: str) -> str """ - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(value: Decimal) -> int """ - pass - - def __long__(self, *args): #cannot find CLR method - """ __int__(value: Decimal) -> int """ - pass - - def __mod__(self, *args): #cannot find CLR method - """ x.__mod__(y) <==> x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*y """ - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__[Decimal]() -> Decimal - - __new__(cls: type, value: int) - __new__(cls: type, value: UInt32) - __new__(cls: type, value: Int64) - __new__(cls: type, value: UInt64) - __new__(cls: type, value: Single) - __new__(cls: type, value: float) - __new__(cls: type, bits: Array[int]) - __new__(cls: type, lo: int, mid: int, hi: int, isNegative: bool, scale: Byte) - """ - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(x: Decimal) -> bool """ - pass - - def __pos__(self, *args): #cannot find CLR method - """ - __pos__(d: Decimal) -> Decimal - - Returns the value of the System.Decimal operand (the sign of the operand is unchanged). - - d: The operand to return. - Returns: The value of the operand, d. - """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ - __radd__(d1: Decimal, d2: Decimal) -> Decimal - - Adds two specified System.Decimal values. - - d1: The first value to add. - d2: The second value to add. - Returns: The result of adding d1 and d2. - """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ - __rdiv__(d1: Decimal, d2: Decimal) -> Decimal - - Divides two specified System.Decimal values. - - d1: The dividend. - d2: The divisor. - Returns: The result of dividing d1 by d2. - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(x: Decimal) -> str """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ - __rmod__(d1: Decimal, d2: Decimal) -> Decimal - - Returns the remainder resulting from dividing two specified System.Decimal values. - - d1: The dividend. - d2: The divisor. - Returns: The remainder resulting from dividing d1 by d2. - """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ - __rmul__(d1: Decimal, d2: Decimal) -> Decimal - - Multiplies two specified System.Decimal values. - - d1: The first value to multiply. - d2: The second value to multiply. - Returns: The result of multiplying d1 by d2. - """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ - __rsub__(d1: Decimal, d2: Decimal) -> Decimal - - Subtracts two specified System.Decimal values. - - d1: The minuend. - d2: The subtrahend. - Returns: The result of subtracting d2 from d1. - """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - MaxValue = None - MinusOne = None - MinValue = None - One = None - Zero = None - - -class DivideByZeroException(ArithmeticException, ISerializable, _Exception): - """ - The exception that is thrown when there is an attempt to divide an integral or decimal value by zero. - - DivideByZeroException() - DivideByZeroException(message: str) - DivideByZeroException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class TypeLoadException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when type-loading failures occur. - - TypeLoadException() - TypeLoadException(message: str) - TypeLoadException(message: str, inner: Exception) - """ - def GetObjectData(self, info, context): - # type: (self: TypeLoadException, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: TypeLoadException, info: SerializationInfo, context: StreamingContext) - Sets the System.Runtime.Serialization.SerializationInfo object with the class name, method name, resource ID, and additional exception information. - - info: The object that holds the serialized object data. - context: The contextual information about the source or destination. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Message = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the error message for this exception. - - Get: Message(self: TypeLoadException) -> str - """ - - TypeName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the fully qualified name of the type that causes the exception. - - Get: TypeName(self: TypeLoadException) -> str - """ - - - SerializeObjectState = None - - -class DllNotFoundException(TypeLoadException, ISerializable, _Exception): - """ - The exception that is thrown when a DLL specified in a DLL import cannot be found. - - DllNotFoundException() - DllNotFoundException(message: str) - DllNotFoundException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class Double(object): - """ Represents a double-precision floating-point number. """ - def as_integer_ratio(self, *args): #cannot find CLR method - # type: (self: float) -> tuple - """ as_integer_ratio(self: float) -> tuple """ - pass - - def conjugate(self, *args): #cannot find CLR method - # type: (x: float) -> float - """ conjugate(x: float) -> float """ - pass - - def fromhex(self, *args): #cannot find CLR method - # type: (cls: type, self: str) -> object - """ fromhex(cls: type, self: str) -> object """ - pass - - def hex(self, *args): #cannot find CLR method - # type: (self: float) -> str - """ hex(self: float) -> str """ - pass - - def is_integer(self, *args): #cannot find CLR method - # type: (self: float) -> bool - """ is_integer(self: float) -> bool """ - pass - - def __abs__(self, *args): #cannot find CLR method - """ x.__abs__() <==> abs(x) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __coerce__(self, *args): #cannot find CLR method - """ __coerce__(x: float, o: object) -> tuple """ - pass - - def __divmod__(self, *args): #cannot find CLR method - """ __divmod__(x: float, y: float) -> object """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/y """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __float__(self, *args): #cannot find CLR method - """ __float__(self: float) -> float """ - pass - - def __floordiv__(self, *args): #cannot find CLR method - """ x.__floordiv__(y) <==> x//y """ - pass - - def __getformat__(self, *args): #cannot find CLR method - """ __getformat__(typestr: str) -> str """ - pass - - def __getnewargs__(self, *args): #cannot find CLR method - """ __getnewargs__(self: float) -> object """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(d: float) -> object """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __long__(self, *args): #cannot find CLR method - """ __long__(self: float) -> long """ - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __mod__(self, *args): #cannot find CLR method - """ x.__mod__(y) <==> x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*y """ - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) -> object - __new__(cls: type, x: object) -> object - __new__(cls: type, s: IList[Byte]) -> object - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(x: float) -> bool """ - pass - - def __pos__(self, *args): #cannot find CLR method - """ __pos__(x: float) -> float """ - pass - - def __pow__(self, *args): #cannot find CLR method - """ x.__pow__(y[, z]) <==> pow(x, y[, z]) """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ __radd__(x: float, y: float) -> float """ - pass - - def __rdivmod__(self, *args): #cannot find CLR method - """ __rdivmod__(x: float, y: float) -> object """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ __rdiv__(x: float, y: float) -> float """ - pass - - def __rfloordiv__(self, *args): #cannot find CLR method - """ __rfloordiv__(x: float, y: float) -> float """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ __rmod__(x: float, y: float) -> float """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ __rmul__(x: float, y: float) -> float """ - pass - - def __rpow__(self, *args): #cannot find CLR method - """ __rpow__(x: float, y: float) -> float """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ __rsub__(x: float, y: float) -> float """ - pass - - def __rtruediv__(self, *args): #cannot find CLR method - """ __rtruediv__(x: float, y: float) -> float """ - pass - - def __setformat__(self, *args): #cannot find CLR method - """ __setformat__(typestr: str, fmt: str) """ - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - def __truediv__(self, *args): #cannot find CLR method - """ x.__truediv__(y) <==> x/y """ - pass - - def __trunc__(self, *args): #cannot find CLR method - """ __trunc__(x: float) -> object """ - pass - - imag = None - real = None - - -class DuplicateWaitObjectException(ArgumentException, ISerializable, _Exception): - """ - The exception that is thrown when an object appears more than once in an array of synchronization objects. - - DuplicateWaitObjectException() - DuplicateWaitObjectException(parameterName: str) - DuplicateWaitObjectException(parameterName: str, message: str) - DuplicateWaitObjectException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, parameterName: str) - __new__(cls: type, parameterName: str, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class EntryPointNotFoundException(TypeLoadException, ISerializable, _Exception): - """ - The exception that is thrown when an attempt to load a class fails due to the absence of an entry method. - - EntryPointNotFoundException() - EntryPointNotFoundException(message: str) - EntryPointNotFoundException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class Environment(object): - """ Provides information about, and means to manipulate, the current environment and platform. This class cannot be inherited. """ - @staticmethod - def Exit(exitCode): - # type: (exitCode: int) - """ - Exit(exitCode: int) - Terminates this process and gives the underlying operating system the specified exit code. - - exitCode: Exit code to be given to the operating system. - """ - pass - - @staticmethod - def ExpandEnvironmentVariables(name): - # type: (name: str) -> str - """ - ExpandEnvironmentVariables(name: str) -> str - - Replaces the name of each environment variable embedded in the specified string with the string equivalent of the value of the variable, then returns the resulting string. - - name: A string containing the names of zero or more environment variables. Each environment variable is quoted with the percent sign character (%). - Returns: A string with each environment variable replaced by its value. - """ - pass - - @staticmethod - def FailFast(message, exception=None): - # type: (message: str) - """ - FailFast(message: str) - Immediately terminates a process after writing a message to the Windows Application event log, and then includes the message in error reporting to Microsoft. - - message: A message that explains why the process was terminated, or null if no explanation is provided. - FailFast(message: str, exception: Exception) - Immediately terminates a process after writing a message to the Windows Application event log, and then includes the message and exception information in error reporting to Microsoft. - - message: A message that explains why the process was terminated, or null if no explanation is provided. - exception: An exception that represents the error that caused the termination. This is typically the exception in a catch block. - """ - pass - - @staticmethod - def GetCommandLineArgs(): - # type: () -> Array[str] - """ - GetCommandLineArgs() -> Array[str] - - Returns a string array containing the command-line arguments for the current process. - Returns: An array of string where each element contains a command-line argument. The first element is the executable file name, and the following zero or more elements contain the remaining command-line arguments. - """ - pass - - @staticmethod - def GetEnvironmentVariable(variable, target=None): - # type: (variable: str) -> str - """ - GetEnvironmentVariable(variable: str) -> str - - Retrieves the value of an environment variable from the current process. - - variable: The name of the environment variable. - Returns: The value of the environment variable specified by variable, or null if the environment variable is not found. - GetEnvironmentVariable(variable: str, target: EnvironmentVariableTarget) -> str - - Retrieves the value of an environment variable from the current process or from the Windows operating system registry key for the current user or local machine. - - variable: The name of an environment variable. - target: One of the System.EnvironmentVariableTarget values. - Returns: The value of the environment variable specified by the variable and target parameters, or null if the environment variable is not found. - """ - pass - - @staticmethod - def GetEnvironmentVariables(target=None): - # type: () -> IDictionary - """ - GetEnvironmentVariables() -> IDictionary - - Retrieves all environment variable names and their values from the current process. - Returns: A dictionary that contains all environment variable names and their values; otherwise, an empty dictionary if no environment variables are found. - GetEnvironmentVariables(target: EnvironmentVariableTarget) -> IDictionary - - Retrieves all environment variable names and their values from the current process, or from the Windows operating system registry key for the current user or local machine. - - target: One of the System.EnvironmentVariableTarget values. - Returns: A dictionary that contains all environment variable names and their values from the source specified by the target parameter; otherwise, an empty dictionary if no environment variables are found. - """ - pass - - @staticmethod - def GetFolderPath(folder, option=None): - # type: (folder: SpecialFolder) -> str - """ - GetFolderPath(folder: SpecialFolder) -> str - GetFolderPath(folder: SpecialFolder, option: SpecialFolderOption) -> str - """ - pass - - @staticmethod - def GetLogicalDrives(): - # type: () -> Array[str] - """ - GetLogicalDrives() -> Array[str] - - Returns an array of string containing the names of the logical drives on the current computer. - Returns: An array of strings where each element contains the name of a logical drive. For example, if the computer's hard drive is the first logical drive, the first element returned is "C:\". - """ - pass - - @staticmethod - def SetEnvironmentVariable(variable, value, target=None): - # type: (variable: str, value: str) - """ - SetEnvironmentVariable(variable: str, value: str) - Creates, modifies, or deletes an environment variable stored in the current process. - - variable: The name of an environment variable. - value: A value to assign to variable. - SetEnvironmentVariable(variable: str, value: str, target: EnvironmentVariableTarget) - Creates, modifies, or deletes an environment variable stored in the current process or in the Windows operating system registry key reserved for the current user or local machine. - - variable: The name of an environment variable. - value: A value to assign to variable. - target: One of the System.EnvironmentVariableTarget values. - """ - pass - - CommandLine = '"C:\\Program Files\\IronPython 2.7\\ipy.exe" -m ironstubs make System.Xml --overwrite --output=..\\..\\pyesapi\\stubs' - CurrentDirectory = 'C:\\Users\\blw8175\\Source\\repos\\PyESAPI\\stubgen' - CurrentManagedThreadId = 1 - ExitCode = 0 - HasShutdownStarted = False - Is64BitOperatingSystem = True - Is64BitProcess = True - MachineName = 'PA7L3363ZF2-DPT' - NewLine = '\r\n' - OSVersion = None - ProcessorCount = 8 - SpecialFolder = None - SpecialFolderOption = None - StackTrace = ' at System.Environment.GetStackTrace(Exception e, Boolean needFileInfo)\r\n at System.Environment.get_StackTrace()\r\n at Microsoft.Scripting.Interpreter.FuncCallInstruction`1.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run3[T0,T1,T2,TRet](T0 arg0, T1 arg1, T2 arg2)\r\n at System.Dynamic.UpdateDelegates.UpdateAndExecute2[T0,T1,TRet](CallSite site, T0 arg0, T1 arg1)\r\n at Microsoft.Scripting.Interpreter.FuncCallInstruction`5.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run3[T0,T1,T2,TRet](T0 arg0, T1 arg1, T2 arg2)\r\n at IronPython.Runtime.Types.BuiltinFunction.Call0(CodeContext context, SiteLocalStorage`1 storage, Object instance)\r\n at IronPython.Runtime.Types.ReflectedProperty.CallGetter(CodeContext context, PythonType owner, SiteLocalStorage`1 storage, Object instance)\r\n at IronPython.Runtime.Types.ReflectedProperty.TryGetValue(CodeContext context, Object instance, PythonType owner, Object& value)\r\n at IronPython.Runtime.Binding.MetaPythonType.FastGetBinderHelper.SlotAccessDelegate.Target(CodeContext context, Object self, Object& result)\r\n at IronPython.Runtime.Types.TypeGetBase.RunDelegates(Object self, CodeContext context)\r\n at System.Dynamic.UpdateDelegates.UpdateAndExecute2[T0,T1,TRet](CallSite site, T0 arg0, T1 arg1)\r\n at IronPython.Runtime.Types.PythonType.TryGetBoundAttr(CodeContext context, Object o, String name, Object& ret)\r\n at IronPython.Runtime.Operations.PythonOps.GetBoundAttr(CodeContext context, Object o, String name)\r\n at redo_class$449(Closure , PythonFunction , Object , Object , Object , Object , Object , Object , Object , Object )\r\n at CallSite.Target(Closure , CallSite , CodeContext , Object , Object , Object , Object , Object , Object , Object , Object )\r\n at lambda_method(Closure , Object[] , StrongBox`1[] , InterpretedFrame )\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run4[T0,T1,T2,T3,TRet](T0 arg0, T1 arg1, T2 arg2, T3 arg3)\r\n at System.Dynamic.UpdateDelegates.UpdateAndExecute5[T0,T1,T2,T3,T4,TRet](CallSite site, T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4)\r\n at IronPython.Runtime.Method.MethodBinding`2.SelfTarget(CallSite site, CodeContext context, Object target, T0 arg0, T1 arg1)\r\n at System.Dynamic.UpdateDelegates.UpdateAndExecute4[T0,T1,T2,T3,TRet](CallSite site, T0 arg0, T1 arg1, T2 arg2, T3 arg3)\r\n at IronPython.Compiler.Ast.CallExpression.Invoke2Instruction.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run5[T0,T1,T2,T3,T4,TRet](T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4)\r\n at Microsoft.Scripting.Interpreter.FuncCallInstruction`7.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run7[T0,T1,T2,T3,T4,T5,T6,TRet](T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6)\r\n at Microsoft.Scripting.Interpreter.DynamicInstruction`7.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run6[T0,T1,T2,T3,T4,T5,TRet](T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5)\r\n at Microsoft.Scripting.Interpreter.FuncCallInstruction`8.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run7[T0,T1,T2,T3,T4,T5,T6,TRet](T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6)\r\n at Microsoft.Scripting.Interpreter.DynamicInstruction`7.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run3[T0,T1,T2,TRet](T0 arg0, T1 arg1, T2 arg2)\r\n at IronPython.Compiler.Ast.CallExpression.Invoke2Instruction.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run5[T0,T1,T2,T3,T4,TRet](T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4)\r\n at IronPython.Compiler.PythonCallTargets.OriginalCallTarget4(PythonFunction function, Object arg0, Object arg1, Object arg2, Object arg3)\r\n at Microsoft.Scripting.Interpreter.FuncCallInstruction`7.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run7[T0,T1,T2,T3,T4,T5,T6,TRet](T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6)\r\n at System.Dynamic.UpdateDelegates.UpdateAndExecute6[T0,T1,T2,T3,T4,T5,TRet](CallSite site, T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5)\r\n at Microsoft.Scripting.Interpreter.DynamicInstruction`7.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run2[T0,T1,TRet](T0 arg0, T1 arg1)\r\n at IronPython.Runtime.Operations.PythonOps.QualifiedExec(CodeContext context, Object code, PythonDictionary globals, Object locals)\r\n at Microsoft.Scripting.Interpreter.ActionCallInstruction`4.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run8[T0,T1,T2,T3,T4,T5,T6,T7,TRet](T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7)\r\n at IronPython.Compiler.PythonCallTargets.OriginalCallTarget7(PythonFunction function, Object arg0, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6)\r\n at System.Dynamic.UpdateDelegates.UpdateAndExecute9[T0,T1,T2,T3,T4,T5,T6,T7,T8,TRet](CallSite site, T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7, T8 arg8)\r\n at Microsoft.Scripting.Interpreter.DynamicInstruction`10.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run7[T0,T1,T2,T3,T4,T5,T6,TRet](T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6)\r\n at IronPython.Compiler.PythonCallTargets.OriginalCallTarget6(PythonFunction function, Object arg0, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5)\r\n at System.Dynamic.UpdateDelegates.UpdateAndExecute8[T0,T1,T2,T3,T4,T5,T6,T7,TRet](CallSite site, T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4, T5 arg5, T6 arg6, T7 arg7)\r\n at IronPython.Compiler.Ast.CallExpression.Invoke6Instruction.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run5[T0,T1,T2,T3,T4,TRet](T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4)\r\n at IronPython.Compiler.PythonCallTargets.OriginalCallTarget4(PythonFunction function, Object arg0, Object arg1, Object arg2, Object arg3)\r\n at Microsoft.Scripting.Interpreter.FuncCallInstruction`7.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.Interpreter.Run(InterpretedFrame frame)\r\n at Microsoft.Scripting.Interpreter.LightLambda.Run5[T0,T1,T2,T3,T4,TRet](T0 arg0, T1 arg1, T2 arg2, T3 arg3, T4 arg4)\r\n at System.Dynamic.UpdateDelegates.UpdateAndExecute4[T0,T1,T2,T3,TRet](CallSite site, T0 arg0, T1 arg1, T2 arg2, T3 arg3)\r\n at IronPython.Runtime.PythonContext.CallWithKeywords(Object func, Object[] args, IDictionary`2 dict)\r\n at IronPython.Runtime.Operations.PythonCalls.CallWithKeywordArgs(CodeContext context, Object func, Object[] args, String[] names)\r\n at IronPython.Hosting.PythonCommandLine.Run()\r\n at Microsoft.Scripting.Hosting.Shell.CommandLine.Run(ScriptEngine engine, IConsole console, ConsoleOptions options)\r\n at Microsoft.Scripting.Hosting.Shell.ConsoleHost.RunCommandLine()\r\n at Microsoft.Scripting.Hosting.Shell.ConsoleHost.ExecuteInternal()\r\n at Microsoft.Scripting.Hosting.Shell.ConsoleHost.Run(String[] args)\r\n at PythonConsoleHost.Main(String[] args)' - SystemDirectory = 'C:\\WINDOWS\\system32' - SystemPageSize = 4096 - TickCount = 598760812 - UserDomainName = 'VMS' - UserInteractive = True - UserName = 'blw8175' - Version = None - WorkingSet = None - __all__ = [ - 'Exit', - 'ExpandEnvironmentVariables', - 'FailFast', - 'GetCommandLineArgs', - 'GetEnvironmentVariable', - 'GetEnvironmentVariables', - 'GetFolderPath', - 'GetLogicalDrives', - 'SetEnvironmentVariable', - 'SpecialFolder', - 'SpecialFolderOption', - ] - - -class EnvironmentVariableTarget(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies the location where an environment variable is stored or retrieved in a set or get operation. - - enum EnvironmentVariableTarget, values: Machine (2), Process (0), User (1) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Machine = None - Process = None - User = None - value__ = None - - -class ExecutionEngineException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when there is an internal error in the execution engine of the common language runtime. This class cannot be inherited. - - ExecutionEngineException() - ExecutionEngineException(message: str) - ExecutionEngineException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class MemberAccessException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when an attempt to access a class member fails. - - MemberAccessException() - MemberAccessException(message: str) - MemberAccessException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class FieldAccessException(MemberAccessException, ISerializable, _Exception): - """ - The exception that is thrown when there is an invalid attempt to access a private or protected field inside a class. - - FieldAccessException() - FieldAccessException(message: str) - FieldAccessException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class UriParser(object): - """ Parses a new URI scheme. This is an abstract class. """ - def GetComponents(self, *args): #cannot find CLR method - # type: (self: UriParser, uri: Uri, components: UriComponents, format: UriFormat) -> str - """ - GetComponents(self: UriParser, uri: Uri, components: UriComponents, format: UriFormat) -> str - - Gets the components from a URI. - - uri: The URI to parse. - components: The System.UriComponents to retrieve from uri. - format: One of the System.UriFormat values that controls how special characters are escaped. - Returns: A string that contains the components. - """ - pass - - def InitializeAndValidate(self, *args): #cannot find CLR method - # type: (self: UriParser, uri: Uri) -> UriFormatException - """ - InitializeAndValidate(self: UriParser, uri: Uri) -> UriFormatException - - Initialize the state of the parser and validate the URI. - - uri: The T:System.Uri to validate. - """ - pass - - def IsBaseOf(self, *args): #cannot find CLR method - # type: (self: UriParser, baseUri: Uri, relativeUri: Uri) -> bool - """ - IsBaseOf(self: UriParser, baseUri: Uri, relativeUri: Uri) -> bool - - Determines whether baseUri is a base URI for relativeUri. - - baseUri: The base URI. - relativeUri: The URI to test. - Returns: true if baseUri is a base URI for relativeUri; otherwise, false. - """ - pass - - @staticmethod - def IsKnownScheme(schemeName): - # type: (schemeName: str) -> bool - """ - IsKnownScheme(schemeName: str) -> bool - - Indicates whether the parser for a scheme is registered. - - schemeName: The scheme name to check. - Returns: true if schemeName has been registered; otherwise, false. - """ - pass - - def IsWellFormedOriginalString(self, *args): #cannot find CLR method - # type: (self: UriParser, uri: Uri) -> bool - """ - IsWellFormedOriginalString(self: UriParser, uri: Uri) -> bool - - Indicates whether a URI is well-formed. - - uri: The URI to check. - Returns: true if uri is well-formed; otherwise, false. - """ - pass - - def OnNewUri(self, *args): #cannot find CLR method - # type: (self: UriParser) -> UriParser - """ - OnNewUri(self: UriParser) -> UriParser - - Invoked by a System.Uri constructor to get a System.UriParser instance - Returns: A System.UriParser for the constructed System.Uri. - """ - pass - - def OnRegister(self, *args): #cannot find CLR method - # type: (self: UriParser, schemeName: str, defaultPort: int) - """ - OnRegister(self: UriParser, schemeName: str, defaultPort: int) - Invoked by the Framework when a System.UriParser method is registered. - - schemeName: The scheme that is associated with this System.UriParser. - defaultPort: The port number of the scheme. - """ - pass - - @staticmethod - def Register(uriParser, schemeName, defaultPort): - # type: (uriParser: UriParser, schemeName: str, defaultPort: int) - """ - Register(uriParser: UriParser, schemeName: str, defaultPort: int) - Associates a scheme and port number with a System.UriParser. - - uriParser: The URI parser to register. - schemeName: The name of the scheme that is associated with this parser. - defaultPort: The default port number for the specified scheme. - """ - pass - - def Resolve(self, *args): #cannot find CLR method - # type: (self: UriParser, baseUri: Uri, relativeUri: Uri) -> (str, UriFormatException) - """ - Resolve(self: UriParser, baseUri: Uri, relativeUri: Uri) -> (str, UriFormatException) - - Called by System.Uri constructors and erload:System.Uri.TryCreate to resolve a relative URI. - - baseUri: A base URI. - relativeUri: A relative URI. - Returns: The string of the resolved relative System.Uri. - """ - pass - - -class FileStyleUriParser(UriParser): - """ - A customizable parser based on the File scheme. - - FileStyleUriParser() - """ - -class FlagsAttribute(Attribute, _Attribute): - """ - Indicates that an enumeration can be treated as a bit field; that is, a set of flags. - - FlagsAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class FormatException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when the format of an argument does not meet the parameter specifications of the invoked method. - - FormatException() - FormatException(message: str) - FormatException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class FormattableString(object, IFormattable): - # no doc - def GetArgument(self, index): - # type: (self: FormattableString, index: int) -> object - """ GetArgument(self: FormattableString, index: int) -> object """ - pass - - def GetArguments(self): - # type: (self: FormattableString) -> Array[object] - """ GetArguments(self: FormattableString) -> Array[object] """ - pass - - @staticmethod - def Invariant(formattable): - # type: (formattable: FormattableString) -> str - """ Invariant(formattable: FormattableString) -> str """ - pass - - def ToString(self, formatProvider=None): - # type: (self: FormattableString, formatProvider: IFormatProvider) -> str - """ - ToString(self: FormattableString, formatProvider: IFormatProvider) -> str - ToString(self: FormattableString) -> str - """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ArgumentCount = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: FormattableString) -> int - """ Get: ArgumentCount(self: FormattableString) -> int """ - - Format = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: FormattableString) -> str - """ Get: Format(self: FormattableString) -> str """ - - - -class FtpStyleUriParser(UriParser): - # type: (FTP) scheme. - """ - A customizable parser based on the File Transfer Protocol (FTP) scheme. - - FtpStyleUriParser() - """ - -class GC(object): - """ Controls the system garbage collector, a service that automatically reclaims unused memory. """ - @staticmethod - def AddMemoryPressure(bytesAllocated): - # type: (bytesAllocated: Int64) - """ - AddMemoryPressure(bytesAllocated: Int64) - Informs the runtime of a large allocation of unmanaged memory that should be taken into account when scheduling garbage collection. - - bytesAllocated: The incremental amount of unmanaged memory that has been allocated. - """ - pass - - @staticmethod - def CancelFullGCNotification(): - # type: () - """ - CancelFullGCNotification() - Cancels the registration of a garbage collection notification. - """ - pass - - @staticmethod - def Collect(generation=None, mode=None, blocking=None, compacting=None): - # type: (generation: int) - """ - Collect(generation: int) - Forces an immediate garbage collection from generation zero through a specified generation. - - generation: The number of the oldest generation that garbage collection can be performed on. - Collect() - Forces an immediate garbage collection of all generations. - Collect(generation: int, mode: GCCollectionMode) - Forces a garbage collection from generation zero through a specified generation, at a time specified by a System.GCCollectionMode value. - - generation: The number of the oldest generation that garbage collection can be performed on. - mode: One of the System.GCCollectionMode values. - Collect(generation: int, mode: GCCollectionMode, blocking: bool)Collect(generation: int, mode: GCCollectionMode, blocking: bool, compacting: bool) - """ - pass - - @staticmethod - def CollectionCount(generation): - # type: (generation: int) -> int - """ - CollectionCount(generation: int) -> int - - Returns the number of times garbage collection has occurred for the specified generation of objects. - - generation: The generation of objects for which the garbage collection count is to be determined. - Returns: The number of times garbage collection has occurred for the specified generation since the process was started. - """ - pass - - @staticmethod - def EndNoGCRegion(): - # type: () - """ EndNoGCRegion() """ - pass - - @staticmethod - def GetGeneration(*__args): - # type: (obj: object) -> int - """ - GetGeneration(obj: object) -> int - - Returns the current generation number of the specified object. - - obj: The object that generation information is retrieved for. - Returns: The current generation number of obj. - GetGeneration(wo: WeakReference) -> int - - Returns the current generation number of the target of a specified weak reference. - - wo: A System.WeakReference that refers to the target object whose generation number is to be determined. - Returns: The current generation number of the target of wo. - """ - pass - - @staticmethod - def GetTotalMemory(forceFullCollection): - # type: (forceFullCollection: bool) -> Int64 - """ - GetTotalMemory(forceFullCollection: bool) -> Int64 - - Retrieves the number of bytes currently thought to be allocated. A parameter indicates whether this method can wait a short interval before returning, to allow the system to collect garbage and finalize objects. - - forceFullCollection: true to indicate that this method can wait for garbage collection to occur before returning; otherwise, false. - Returns: A number that is the best available approximation of the number of bytes currently allocated in managed memory. - """ - pass - - @staticmethod - def KeepAlive(obj): - # type: (obj: object) - """ - KeepAlive(obj: object) - References the specified object, which makes it ineligible for garbage collection from the start of the current routine to the point where this method is called. - - obj: The object to reference. - """ - pass - - @staticmethod - def RegisterForFullGCNotification(maxGenerationThreshold, largeObjectHeapThreshold): - # type: (maxGenerationThreshold: int, largeObjectHeapThreshold: int) - """ - RegisterForFullGCNotification(maxGenerationThreshold: int, largeObjectHeapThreshold: int) - Specifies that a garbage collection notification should be raised when conditions favor full garbage collection and when the collection has been completed. - - maxGenerationThreshold: A number between 1 and 99 that specifies when the notification should be raised based on the objects surviving in generation 2. - largeObjectHeapThreshold: A number between 1 and 99 that specifies when the notification should be raised based on objects allocated in the large object heap. - """ - pass - - @staticmethod - def RemoveMemoryPressure(bytesAllocated): - # type: (bytesAllocated: Int64) - """ - RemoveMemoryPressure(bytesAllocated: Int64) - Informs the runtime that unmanaged memory has been released and no longer needs to be taken into account when scheduling garbage collection. - - bytesAllocated: The amount of unmanaged memory that has been released. - """ - pass - - @staticmethod - def ReRegisterForFinalize(obj): - # type: (obj: object) - """ - ReRegisterForFinalize(obj: object) - Requests that the system call the finalizer for the specified object for which System.GC.SuppressFinalize(System.Object) has previously been called. - - obj: The object that a finalizer must be called for. - """ - pass - - @staticmethod - def SuppressFinalize(obj): - # type: (obj: object) - """ - SuppressFinalize(obj: object) - Requests that the system not call the finalizer for the specified object. - - obj: The object that a finalizer must not be called for. - """ - pass - - @staticmethod - def TryStartNoGCRegion(totalSize, *__args): - # type: (totalSize: Int64) -> bool - """ - TryStartNoGCRegion(totalSize: Int64) -> bool - TryStartNoGCRegion(totalSize: Int64, lohSize: Int64) -> bool - TryStartNoGCRegion(totalSize: Int64, disallowFullBlockingGC: bool) -> bool - TryStartNoGCRegion(totalSize: Int64, lohSize: Int64, disallowFullBlockingGC: bool) -> bool - """ - pass - - @staticmethod - def WaitForFullGCApproach(millisecondsTimeout=None): - # type: () -> GCNotificationStatus - """ - WaitForFullGCApproach() -> GCNotificationStatus - - Returns the status of a registered notification for determining whether a full garbage collection by the common langauge runtime is imminent. - Returns: The status of the registered garbage collection notification. - WaitForFullGCApproach(millisecondsTimeout: int) -> GCNotificationStatus - - Returns, in a specified time-out period, the status of a registered notification for determining whether a full garbage collection by the common language runtime is imminent. - - millisecondsTimeout: The length of time to wait before a notification status can be obtained. Specify -1 to wait indefinitely. - Returns: The status of the registered garbage collection notification. - """ - pass - - @staticmethod - def WaitForFullGCComplete(millisecondsTimeout=None): - # type: () -> GCNotificationStatus - """ - WaitForFullGCComplete() -> GCNotificationStatus - - Returns the status of a registered notification for determining whether a full garbage collection by the common language runtime has completed. - Returns: The status of the registered garbage collection notification. - WaitForFullGCComplete(millisecondsTimeout: int) -> GCNotificationStatus - - Returns, in a specified time-out period, the status of a registered notification for determining whether a full garbage collection by common language the runtime has completed. - - millisecondsTimeout: The length of time to wait before a notification status can be obtained. Specify -1 to wait indefinitely. - Returns: The status of the registered garbage collection notification. - """ - pass - - @staticmethod - def WaitForPendingFinalizers(): - # type: () - """ - WaitForPendingFinalizers() - Suspends the current thread until the thread that is processing the queue of finalizers has emptied that queue. - """ - pass - - MaxGeneration = 2 - __all__ = [ - 'AddMemoryPressure', - 'CancelFullGCNotification', - 'Collect', - 'CollectionCount', - 'EndNoGCRegion', - 'GetGeneration', - 'GetTotalMemory', - 'KeepAlive', - 'RegisterForFullGCNotification', - 'RemoveMemoryPressure', - 'ReRegisterForFinalize', - 'SuppressFinalize', - 'TryStartNoGCRegion', - 'WaitForFullGCApproach', - 'WaitForFullGCComplete', - 'WaitForPendingFinalizers', - ] - - -class GCCollectionMode(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies the behavior for a forced garbage collection. - - enum GCCollectionMode, values: Default (0), Forced (1), Optimized (2) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Default = None - Forced = None - Optimized = None - value__ = None - - -class GCNotificationStatus(Enum, IComparable, IFormattable, IConvertible): - """ - Provides information about the current registration for notification of the next full garbage collection. - - enum GCNotificationStatus, values: Canceled (2), Failed (1), NotApplicable (4), Succeeded (0), Timeout (3) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Canceled = None - Failed = None - NotApplicable = None - Succeeded = None - Timeout = None - value__ = None - - -class GenericUriParser(UriParser): - """ - A customizable parser for a hierarchical URI. - - GenericUriParser(options: GenericUriParserOptions) - """ - @staticmethod # known case of __new__ - def __new__(self, options): - """ __new__(cls: type, options: GenericUriParserOptions) """ - pass - - -class GenericUriParserOptions(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies options for a System.UriParser. - - enum (flags) GenericUriParserOptions, values: AllowEmptyAuthority (2), Default (0), DontCompressPath (128), DontConvertPathBackslashes (64), DontUnescapePathDotsAndSlashes (256), GenericAuthority (1), Idn (512), IriParsing (1024), NoFragment (32), NoPort (8), NoQuery (16), NoUserInfo (4) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - AllowEmptyAuthority = None - Default = None - DontCompressPath = None - DontConvertPathBackslashes = None - DontUnescapePathDotsAndSlashes = None - GenericAuthority = None - Idn = None - IriParsing = None - NoFragment = None - NoPort = None - NoQuery = None - NoUserInfo = None - value__ = None - - -class GopherStyleUriParser(UriParser): - """ - A customizable parser based on the Gopher scheme. - - GopherStyleUriParser() - """ - -class Guid(object, IFormattable, IComparable, IComparable[Guid], IEquatable[Guid]): - # type: (GUID). - """ - Represents a globally unique identifier (GUID). - - Guid(b: Array[Byte]) - Guid(a: UInt32, b: UInt16, c: UInt16, d: Byte, e: Byte, f: Byte, g: Byte, h: Byte, i: Byte, j: Byte, k: Byte) - Guid(a: int, b: Int16, c: Int16, d: Array[Byte]) - Guid(a: int, b: Int16, c: Int16, d: Byte, e: Byte, f: Byte, g: Byte, h: Byte, i: Byte, j: Byte, k: Byte) - Guid(g: str) - """ - def CompareTo(self, value): - # type: (self: Guid, value: object) -> int - """ - CompareTo(self: Guid, value: object) -> int - - Compares this instance to a specified object and returns an indication of their relative values. - - value: An object to compare, or null. - Returns: A signed number indicating the relative values of this instance and value.Return value Description A negative integer This instance is less than value. Zero This instance is equal to value. A positive integer This instance is greater than value, or - value is null. - - CompareTo(self: Guid, value: Guid) -> int - - Compares this instance to a specified System.Guid object and returns an indication of their relative values. - - value: An object to compare to this instance. - Returns: A signed number indicating the relative values of this instance and value.Return value Description A negative integer This instance is less than value. Zero This instance is equal to value. A positive integer This instance is greater than value. - """ - pass - - def Equals(self, *__args): - # type: (self: Guid, o: object) -> bool - """ - Equals(self: Guid, o: object) -> bool - - Returns a value that indicates whether this instance is equal to a specified object. - - o: The object to compare with this instance. - Returns: true if o is a System.Guid that has the same value as this instance; otherwise, false. - Equals(self: Guid, g: Guid) -> bool - - Returns a value indicating whether this instance and a specified System.Guid object represent the same value. - - g: An object to compare to this instance. - Returns: true if g is equal to this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: Guid) -> int - """ - GetHashCode(self: Guid) -> int - - Returns the hash code for this instance. - Returns: The hash code for this instance. - """ - pass - - @staticmethod - def NewGuid(): - # type: () -> Guid - """ - NewGuid() -> Guid - - Initializes a new instance of the System.Guid structure. - Returns: A new GUID object. - """ - pass - - @staticmethod - def Parse(input): - # type: (input: str) -> Guid - """ - Parse(input: str) -> Guid - - Converts the string representation of a GUID to the equivalent System.Guid structure. - - input: The GUID to convert. - Returns: A structure that contains the value that was parsed. - """ - pass - - @staticmethod - def ParseExact(input, format): - # type: (input: str, format: str) -> Guid - """ - ParseExact(input: str, format: str) -> Guid - - Converts the string representation of a GUID to the equivalent System.Guid structure, provided that the string is in the specified format. - - input: The GUID to convert. - format: One of the following specifiers that indicates the exact format to use when interpreting input: "N", "D", "B", "P", or "X". - Returns: A structure that contains the value that was parsed. - """ - pass - - def ToByteArray(self): - # type: (self: Guid) -> Array[Byte] - """ - ToByteArray(self: Guid) -> Array[Byte] - - Returns a 16-element byte array that contains the value of this instance. - Returns: A 16-element byte array. - """ - pass - - def ToString(self, format=None, provider=None): - # type: (self: Guid) -> str - """ - ToString(self: Guid) -> str - - Returns a string representation of the value of this instance in registry format. - Returns: The value of this System.Guid, formatted using the "D" format specifier as follows: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx where the value of the GUID is represented as a series of lowercase hexadecimal digits in groups of 8, 4, 4, 4, and 12 digits and - separated by hyphens. An example of a return value is "382c74c3-721d-4f34-80e5-57657b6cbc27". - - ToString(self: Guid, format: str) -> str - - Returns a string representation of the value of this System.Guid instance, according to the provided format specifier. - - format: A single format specifier that indicates how to format the value of this System.Guid. The format parameter can be "N", "D", "B", "P", or "X". If format is null or an empty string (""), "D" is used. - Returns: The value of this System.Guid, represented as a series of lowercase hexadecimal digits in the specified format. - ToString(self: Guid, format: str, provider: IFormatProvider) -> str - - Returns a string representation of the value of this instance of the System.Guid structure, according to the provided format specifier and culture-specific format information. - - format: A single format specifier that indicates how to format the value of this System.Guid. The format parameter can be "N", "D", "B", "P", or "X". If format is null or an empty string (""), "D" is used. - provider: (Reserved) An object that supplies culture-specific formatting services. - Returns: The value of this System.Guid, represented as a series of lowercase hexadecimal digits in the specified format. - """ - pass - - @staticmethod - def TryParse(input, result): - # type: (input: str) -> (bool, Guid) - """ - TryParse(input: str) -> (bool, Guid) - - Converts the string representation of a GUID to the equivalent System.Guid structure. - - input: The GUID to convert. - Returns: true if the parse operation was successful; otherwise, false. - """ - pass - - @staticmethod - def TryParseExact(input, format, result): - # type: (input: str, format: str) -> (bool, Guid) - """ - TryParseExact(input: str, format: str) -> (bool, Guid) - - Converts the string representation of a GUID to the equivalent System.Guid structure, provided that the string is in the specified format. - - input: The GUID to convert. - format: One of the following specifiers that indicates the exact format to use when interpreting input: "N", "D", "B", "P", or "X". - Returns: true if the parse operation was successful; otherwise, false. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__[Guid]() -> Guid - - __new__(cls: type, b: Array[Byte]) - __new__(cls: type, a: UInt32, b: UInt16, c: UInt16, d: Byte, e: Byte, f: Byte, g: Byte, h: Byte, i: Byte, j: Byte, k: Byte) - __new__(cls: type, a: int, b: Int16, c: Int16, d: Array[Byte]) - __new__(cls: type, a: int, b: Int16, c: Int16, d: Byte, e: Byte, f: Byte, g: Byte, h: Byte, i: Byte, j: Byte, k: Byte) - __new__(cls: type, g: str) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Empty = None - - -class HttpStyleUriParser(UriParser): - """ - A customizable parser based on the HTTP scheme. - - HttpStyleUriParser() - """ - -class IAppDomainSetup: - """ Represents assembly binding information that can be added to an instance of System.AppDomain. """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - ApplicationBase = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the name of the directory containing the application. - - Get: ApplicationBase(self: IAppDomainSetup) -> str - - Set: ApplicationBase(self: IAppDomainSetup) = value - """ - - ApplicationName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the name of the application. - - Get: ApplicationName(self: IAppDomainSetup) -> str - - Set: ApplicationName(self: IAppDomainSetup) = value - """ - - CachePath = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets and sets the name of an area specific to the application where files are shadow copied. - - Get: CachePath(self: IAppDomainSetup) -> str - - Set: CachePath(self: IAppDomainSetup) = value - """ - - ConfigurationFile = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets and sets the name of the configuration file for an application domain. - - Get: ConfigurationFile(self: IAppDomainSetup) -> str - - Set: ConfigurationFile(self: IAppDomainSetup) = value - """ - - DynamicBase = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the directory where dynamically generated files are stored and accessed. - - Get: DynamicBase(self: IAppDomainSetup) -> str - - Set: DynamicBase(self: IAppDomainSetup) = value - """ - - LicenseFile = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the location of the license file associated with this domain. - - Get: LicenseFile(self: IAppDomainSetup) -> str - - Set: LicenseFile(self: IAppDomainSetup) = value - """ - - PrivateBinPath = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the list of directories that is combined with the System.AppDomainSetup.ApplicationBase directory to probe for private assemblies. - - Get: PrivateBinPath(self: IAppDomainSetup) -> str - - Set: PrivateBinPath(self: IAppDomainSetup) = value - """ - - PrivateBinPathProbe = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the private binary directory path used to locate an application. - - Get: PrivateBinPathProbe(self: IAppDomainSetup) -> str - - Set: PrivateBinPathProbe(self: IAppDomainSetup) = value - """ - - ShadowCopyDirectories = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the names of the directories containing assemblies to be shadow copied. - - Get: ShadowCopyDirectories(self: IAppDomainSetup) -> str - - Set: ShadowCopyDirectories(self: IAppDomainSetup) = value - """ - - ShadowCopyFiles = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets a string that indicates whether shadow copying is turned on or off. - - Get: ShadowCopyFiles(self: IAppDomainSetup) -> str - - Set: ShadowCopyFiles(self: IAppDomainSetup) = value - """ - - - -class IAsyncResult: - """ Represents the status of an asynchronous operation. """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - AsyncState = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a user-defined object that qualifies or contains information about an asynchronous operation. - - Get: AsyncState(self: IAsyncResult) -> object - """ - - AsyncWaitHandle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.Threading.WaitHandle that is used to wait for an asynchronous operation to complete. - - Get: AsyncWaitHandle(self: IAsyncResult) -> WaitHandle - """ - - CompletedSynchronously = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the asynchronous operation completed synchronously. - - Get: CompletedSynchronously(self: IAsyncResult) -> bool - """ - - IsCompleted = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the asynchronous operation has completed. - - Get: IsCompleted(self: IAsyncResult) -> bool - """ - - - -class ICustomFormatter: - """ Defines a method that supports custom formatting of the value of an object. """ - def Format(self, format, arg, formatProvider): - # type: (self: ICustomFormatter, format: str, arg: object, formatProvider: IFormatProvider) -> str - """ - Format(self: ICustomFormatter, format: str, arg: object, formatProvider: IFormatProvider) -> str - - Converts the value of a specified object to an equivalent string representation using specified format and culture-specific formatting information. - - format: A format string containing formatting specifications. - arg: An object to format. - formatProvider: An object that supplies format information about the current instance. - Returns: The string representation of the value of arg, formatted as specified by format and formatProvider. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IEquatable: - # no doc - def Equals(self, other): - # type: (self: IEquatable[T], other: T) -> bool - """ - Equals(self: IEquatable[T], other: T) -> bool - - Indicates whether the current object is equal to another object of the same type. - - other: An object to compare with this object. - Returns: true if the current object is equal to the other parameter; otherwise, false. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IFormatProvider: - """ Provides a mechanism for retrieving an object to control formatting. """ - def GetFormat(self, formatType): - # type: (self: IFormatProvider, formatType: Type) -> object - """ - GetFormat(self: IFormatProvider, formatType: Type) -> object - - Returns an object that provides formatting services for the specified type. - - formatType: An object that specifies the type of format object to return. - Returns: An instance of the object specified by formatType, if the System.IFormatProvider implementation can supply that type of object; otherwise, null. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IndexOutOfRangeException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when an attempt is made to access an element of an array with an index that is outside the bounds of the array. This class cannot be inherited. - - IndexOutOfRangeException() - IndexOutOfRangeException(message: str) - IndexOutOfRangeException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class InsufficientExecutionStackException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when there is insufficient execution stack available to allow most methods to execute. - - InsufficientExecutionStackException() - InsufficientExecutionStackException(message: str) - InsufficientExecutionStackException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class OutOfMemoryException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when there is not enough memory to continue the execution of a program. - - OutOfMemoryException() - OutOfMemoryException(message: str) - OutOfMemoryException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class InsufficientMemoryException(OutOfMemoryException, ISerializable, _Exception): - """ - The exception that is thrown when a check for sufficient available memory fails. This class cannot be inherited. - - InsufficientMemoryException() - InsufficientMemoryException(message: str) - InsufficientMemoryException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class Int16(object, IComparable, IFormattable, IConvertible, IComparable[Int16], IEquatable[Int16]): - """ Represents a 16-bit signed integer. """ - def bit_length(self, *args): #cannot find CLR method - # type: (value: Int16) -> int - """ bit_length(value: Int16) -> int """ - pass - - def CompareTo(self, value): - # type: (self: Int16, value: object) -> int - """ - CompareTo(self: Int16, value: object) -> int - - Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the object. - - value: An object to compare, or null. - Returns: A signed number indicating the relative values of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.-or- value - is null. - - CompareTo(self: Int16, value: Int16) -> int - - Compares this instance to a specified 16-bit signed integer and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified 16-bit signed integer. - - value: An integer to compare. - Returns: A signed number indicating the relative values of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value. - """ - pass - - def conjugate(self, *args): #cannot find CLR method - # type: (x: Int16) -> Int16 - """ conjugate(x: Int16) -> Int16 """ - pass - - def Equals(self, obj): - # type: (self: Int16, obj: object) -> bool - """ - Equals(self: Int16, obj: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - obj: An object to compare to this instance. - Returns: true if obj is an instance of System.Int16 and equals the value of this instance; otherwise, false. - Equals(self: Int16, obj: Int16) -> bool - - Returns a value indicating whether this instance is equal to a specified System.Int16 value. - - obj: An System.Int16 value to compare to this instance. - Returns: true if obj has the same value as this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: Int16) -> int - """ - GetHashCode(self: Int16) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetTypeCode(self): - # type: (self: Int16) -> TypeCode - """ - GetTypeCode(self: Int16) -> TypeCode - - Returns the System.TypeCode for value type System.Int16. - Returns: The enumerated constant, System.TypeCode.Int16. - """ - pass - - @staticmethod - def Parse(s, *__args): - # type: (s: str) -> Int16 - """ - Parse(s: str) -> Int16 - - Converts the string representation of a number to its 16-bit signed integer equivalent. - - s: A string containing a number to convert. - Returns: A 16-bit signed integer equivalent to the number contained in s. - Parse(s: str, style: NumberStyles) -> Int16 - - Converts the string representation of a number in a specified style to its 16-bit signed integer equivalent. - - s: A string containing a number to convert. - style: A bitwise combination of the enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - Returns: A 16-bit signed integer equivalent to the number specified in s. - Parse(s: str, provider: IFormatProvider) -> Int16 - - Converts the string representation of a number in a specified culture-specific format to its 16-bit signed integer equivalent. - - s: A string containing a number to convert. - provider: An System.IFormatProvider that supplies culture-specific formatting information about s. - Returns: A 16-bit signed integer equivalent to the number specified in s. - Parse(s: str, style: NumberStyles, provider: IFormatProvider) -> Int16 - - Converts the string representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent. - - s: A string containing a number to convert. - style: A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An System.IFormatProvider that supplies culture-specific formatting information about s. - Returns: A 16-bit signed integer equivalent to the number specified in s. - """ - pass - - def ToString(self, *__args): - # type: (self: Int16) -> str - """ - ToString(self: Int16) -> str - - Converts the numeric value of this instance to its equivalent string representation. - Returns: The string representation of the value of this instance, consisting of a minus sign if the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeroes. - ToString(self: Int16, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information. - - provider: An System.IFormatProvider that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance as specified by provider. - ToString(self: Int16, format: str) -> str - - Converts the numeric value of this instance to its equivalent string representation, using the specified format. - - format: A numeric format string. - Returns: The string representation of the value of this instance as specified by format. - ToString(self: Int16, format: str, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific formatting information. - - format: A numeric format string. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance as specified by format and provider. - """ - pass - - @staticmethod - def TryParse(s, *__args): - # type: (s: str) -> (bool, Int16) - """ - TryParse(s: str) -> (bool, Int16) - - Converts the string representation of a number to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string containing a number to convert. - Returns: true if s was converted successfully; otherwise, false. - TryParse(s: str, style: NumberStyles, provider: IFormatProvider) -> (bool, Int16) - - Converts the string representation of a number in a specified style and culture-specific format to its 16-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string containing a number to convert. The string is interpreted using the style specified by style. - style: A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific formatting information about s. - Returns: true if s was converted successfully; otherwise, false. - """ - pass - - def __abs__(self, *args): #cannot find CLR method - """ x.__abs__() <==> abs(x) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __and__(self, *args): #cannot find CLR method - """ __and__(x: Int16, y: Int16) -> Int16 """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/y """ - pass - - def __float__(self, *args): #cannot find CLR method - """ __float__(x: Int16) -> float """ - pass - - def __floordiv__(self, *args): #cannot find CLR method - """ x.__floordiv__(y) <==> x//y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __hex__(self, *args): #cannot find CLR method - """ __hex__(value: Int16) -> str """ - pass - - def __index__(self, *args): #cannot find CLR method - """ __index__(x: Int16) -> int """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(x: Int16) -> int """ - pass - - def __invert__(self, *args): #cannot find CLR method - """ __invert__(x: Int16) -> Int16 """ - pass - - def __lshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x< x< x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*y """ - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) -> object - __new__(cls: type, value: object) -> object - """ - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(x: Int16) -> bool """ - pass - - def __or__(self, *args): #cannot find CLR method - """ __or__(x: Int16, y: Int16) -> Int16 """ - pass - - def __pos__(self, *args): #cannot find CLR method - """ __pos__(x: Int16) -> Int16 """ - pass - - def __pow__(self, *args): #cannot find CLR method - """ x.__pow__(y[, z]) <==> pow(x, y[, z]) """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ __radd__(x: Int16, y: Int16) -> object """ - pass - - def __rand__(self, *args): #cannot find CLR method - """ __rand__(x: Int16, y: Int16) -> Int16 """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ __rdiv__(x: Int16, y: Int16) -> object """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(x: Int16) -> str """ - pass - - def __rfloordiv__(self, *args): #cannot find CLR method - """ __rfloordiv__(x: Int16, y: Int16) -> object """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ __rmod__(x: Int16, y: Int16) -> Int16 """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ __rmul__(x: Int16, y: Int16) -> object """ - pass - - def __ror__(self, *args): #cannot find CLR method - """ __ror__(x: Int16, y: Int16) -> Int16 """ - pass - - def __rpow__(self, *args): #cannot find CLR method - """ __rpow__(x: Int16, y: Int16) -> object """ - pass - - def __rshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x>>yx.__rshift__(y) <==> x>>y """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ __rsub__(x: Int16, y: Int16) -> object """ - pass - - def __rtruediv__(self, *args): #cannot find CLR method - """ __rtruediv__(x: Int16, y: Int16) -> float """ - pass - - def __rxor__(self, *args): #cannot find CLR method - """ __rxor__(x: Int16, y: Int16) -> Int16 """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - def __truediv__(self, *args): #cannot find CLR method - """ x.__truediv__(y) <==> x/y """ - pass - - def __trunc__(self, *args): #cannot find CLR method - """ __trunc__(x: Int16) -> Int16 """ - pass - - def __xor__(self, *args): #cannot find CLR method - """ __xor__(x: Int16, y: Int16) -> Int16 """ - pass - - denominator = None - imag = None - MaxValue = None - MinValue = None - numerator = None - real = None - - -class Int64(object, IComparable, IFormattable, IConvertible, IComparable[Int64], IEquatable[Int64]): - """ Represents a 64-bit signed integer. """ - def bit_length(self, *args): #cannot find CLR method - # type: (value: Int64) -> int - """ bit_length(value: Int64) -> int """ - pass - - def CompareTo(self, value): - # type: (self: Int64, value: object) -> int - """ - CompareTo(self: Int64, value: object) -> int - - Compares this instance to a specified object and returns an indication of their relative values. - - value: An object to compare, or null. - Returns: A signed number indicating the relative values of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.-or- value - is null. - - CompareTo(self: Int64, value: Int64) -> int - - Compares this instance to a specified 64-bit signed integer and returns an indication of their relative values. - - value: An integer to compare. - Returns: A signed number indicating the relative values of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value. - """ - pass - - def conjugate(self, *args): #cannot find CLR method - # type: (x: Int64) -> Int64 - """ conjugate(x: Int64) -> Int64 """ - pass - - def Equals(self, obj): - # type: (self: Int64, obj: object) -> bool - """ - Equals(self: Int64, obj: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - obj: An object to compare with this instance. - Returns: true if obj is an instance of an System.Int64 and equals the value of this instance; otherwise, false. - Equals(self: Int64, obj: Int64) -> bool - - Returns a value indicating whether this instance is equal to a specified System.Int64 value. - - obj: An System.Int64 value to compare to this instance. - Returns: true if obj has the same value as this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: Int64) -> int - """ - GetHashCode(self: Int64) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetTypeCode(self): - # type: (self: Int64) -> TypeCode - """ - GetTypeCode(self: Int64) -> TypeCode - - Returns the System.TypeCode for value type System.Int64. - Returns: The enumerated constant, System.TypeCode.Int64. - """ - pass - - @staticmethod - def Parse(s, *__args): - # type: (s: str) -> Int64 - """ - Parse(s: str) -> Int64 - - Converts the string representation of a number to its 64-bit signed integer equivalent. - - s: A string containing a number to convert. - Returns: A 64-bit signed integer equivalent to the number contained in s. - Parse(s: str, style: NumberStyles) -> Int64 - - Converts the string representation of a number in a specified style to its 64-bit signed integer equivalent. - - s: A string containing a number to convert. - style: A bitwise combination of System.Globalization.NumberStyles values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Integer. - Returns: A 64-bit signed integer equivalent to the number specified in s. - Parse(s: str, provider: IFormatProvider) -> Int64 - - Converts the string representation of a number in a specified culture-specific format to its 64-bit signed integer equivalent. - - s: A string containing a number to convert. - provider: An object that supplies culture-specific formatting information about s. - Returns: A 64-bit signed integer equivalent to the number specified in s. - Parse(s: str, style: NumberStyles, provider: IFormatProvider) -> Int64 - - Converts the string representation of a number in a specified style and culture-specific format to its 64-bit signed integer equivalent. - - s: A string containing a number to convert. - style: A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An System.IFormatProvider that supplies culture-specific formatting information about s. - Returns: A 64-bit signed integer equivalent to the number specified in s. - """ - pass - - def ToString(self, *__args): - # type: (self: Int64) -> str - """ - ToString(self: Int64) -> str - - Converts the numeric value of this instance to its equivalent string representation. - Returns: The string representation of the value of this instance, consisting of a minus sign if the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeroes. - ToString(self: Int64, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information. - - provider: An System.IFormatProvider that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance as specified by provider. - ToString(self: Int64, format: str) -> str - - Converts the numeric value of this instance to its equivalent string representation, using the specified format. - - format: A numeric format string. - Returns: The string representation of the value of this instance as specified by format. - ToString(self: Int64, format: str, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information. - - format: A numeric format string. - provider: An object that supplies culture-specific formatting information about this instance. - Returns: The string representation of the value of this instance as specified by format and provider. - """ - pass - - @staticmethod - def TryParse(s, *__args): - # type: (s: str) -> (bool, Int64) - """ - TryParse(s: str) -> (bool, Int64) - - Converts the string representation of a number to its 64-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string containing a number to convert. - Returns: true if s was converted successfully; otherwise, false. - TryParse(s: str, style: NumberStyles, provider: IFormatProvider) -> (bool, Int64) - - Converts the string representation of a number in a specified style and culture-specific format to its 64-bit signed integer equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string containing a number to convert. The string is interpreted using the style specified by style. - style: A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific formatting information about s. - Returns: true if s was converted successfully; otherwise, false. - """ - pass - - def __abs__(self, *args): #cannot find CLR method - """ x.__abs__() <==> abs(x) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __and__(self, *args): #cannot find CLR method - """ __and__(x: Int64, y: Int64) -> Int64 """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/y """ - pass - - def __float__(self, *args): #cannot find CLR method - """ __float__(x: Int64) -> float """ - pass - - def __floordiv__(self, *args): #cannot find CLR method - """ x.__floordiv__(y) <==> x//y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __hex__(self, *args): #cannot find CLR method - """ __hex__(value: Int64) -> str """ - pass - - def __index__(self, *args): #cannot find CLR method - """ __index__(x: Int64) -> long """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(x: Int64) -> int """ - pass - - def __invert__(self, *args): #cannot find CLR method - """ __invert__(x: Int64) -> Int64 """ - pass - - def __lshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x< x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*y """ - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) -> object - __new__(cls: type, value: object) -> object - """ - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(x: Int64) -> bool """ - pass - - def __or__(self, *args): #cannot find CLR method - """ __or__(x: Int64, y: Int64) -> Int64 """ - pass - - def __pos__(self, *args): #cannot find CLR method - """ __pos__(x: Int64) -> Int64 """ - pass - - def __pow__(self, *args): #cannot find CLR method - """ x.__pow__(y[, z]) <==> pow(x, y[, z]) """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ __radd__(x: Int64, y: Int64) -> object """ - pass - - def __rand__(self, *args): #cannot find CLR method - """ __rand__(x: Int64, y: Int64) -> Int64 """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ __rdiv__(x: Int64, y: Int64) -> object """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(x: Int64) -> str """ - pass - - def __rfloordiv__(self, *args): #cannot find CLR method - """ __rfloordiv__(x: Int64, y: Int64) -> object """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ __rmod__(x: Int64, y: Int64) -> Int64 """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ __rmul__(x: Int64, y: Int64) -> object """ - pass - - def __ror__(self, *args): #cannot find CLR method - """ __ror__(x: Int64, y: Int64) -> Int64 """ - pass - - def __rpow__(self, *args): #cannot find CLR method - """ __rpow__(x: Int64, y: Int64) -> object """ - pass - - def __rshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x>>y """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ __rsub__(x: Int64, y: Int64) -> object """ - pass - - def __rtruediv__(self, *args): #cannot find CLR method - """ __rtruediv__(x: Int64, y: Int64) -> float """ - pass - - def __rxor__(self, *args): #cannot find CLR method - """ __rxor__(x: Int64, y: Int64) -> Int64 """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - def __truediv__(self, *args): #cannot find CLR method - """ x.__truediv__(y) <==> x/y """ - pass - - def __trunc__(self, *args): #cannot find CLR method - """ __trunc__(x: Int64) -> Int64 """ - pass - - def __xor__(self, *args): #cannot find CLR method - """ __xor__(x: Int64, y: Int64) -> Int64 """ - pass - - denominator = None - imag = None - MaxValue = None - MinValue = None - numerator = None - real = None - - -class IntPtr(object, ISerializable): - """ - A platform-specific type that is used to represent a pointer or a handle. - - IntPtr(value: int) - IntPtr(value: Int64) - IntPtr(value: Void*) - """ - @staticmethod - def Add(pointer, offset): - # type: (pointer: IntPtr, offset: int) -> IntPtr - """ - Add(pointer: IntPtr, offset: int) -> IntPtr - - Adds an offset to the value of a pointer. - - pointer: The pointer to add the offset to. - offset: The offset to add. - Returns: A new pointer that reflects the addition of offset to pointer. - """ - pass - - def Equals(self, obj): - # type: (self: IntPtr, obj: object) -> bool - """ - Equals(self: IntPtr, obj: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - obj: An object to compare with this instance or null. - Returns: true if obj is an instance of System.IntPtr and equals the value of this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: IntPtr) -> int - """ - GetHashCode(self: IntPtr) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - @staticmethod - def Subtract(pointer, offset): - # type: (pointer: IntPtr, offset: int) -> IntPtr - """ - Subtract(pointer: IntPtr, offset: int) -> IntPtr - - Subtracts an offset from the value of a pointer. - - pointer: The pointer to subtract the offset from. - offset: The offset to subtract. - Returns: A new pointer that reflects the subtraction of offset from pointer. - """ - pass - - def ToInt32(self): - # type: (self: IntPtr) -> int - """ - ToInt32(self: IntPtr) -> int - - Converts the value of this instance to a 32-bit signed integer. - Returns: A 32-bit signed integer equal to the value of this instance. - """ - pass - - def ToInt64(self): - # type: (self: IntPtr) -> Int64 - """ - ToInt64(self: IntPtr) -> Int64 - - Converts the value of this instance to a 64-bit signed integer. - Returns: A 64-bit signed integer equal to the value of this instance. - """ - pass - - def ToPointer(self): - # type: (self: IntPtr) -> Void* - """ - ToPointer(self: IntPtr) -> Void* - - Converts the value of this instance to a pointer to an unspecified type. - Returns: A pointer to System.Void; that is, a pointer to memory containing data of an unspecified type. - """ - pass - - def ToString(self, format=None): - # type: (self: IntPtr) -> str - """ - ToString(self: IntPtr) -> str - - Converts the numeric value of the current System.IntPtr object to its equivalent string representation. - Returns: The string representation of the value of this instance. - ToString(self: IntPtr, format: str) -> str - - Converts the numeric value of the current System.IntPtr object to its equivalent string representation. - - format: A format specification that governs how the current System.IntPtr object is converted. - Returns: The string representation of the value of the current System.IntPtr object. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(value: IntPtr) -> int """ - pass - - def __long__(self, *args): #cannot find CLR method - """ __int__(value: IntPtr) -> int """ - pass - - @staticmethod # known case of __new__ - def __new__(self, value): - """ - __new__[IntPtr]() -> IntPtr - - __new__(cls: type, value: int) - __new__(cls: type, value: Int64) - __new__(cls: type, value: Void*) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - Size = 8 - Zero = None - - -class InvalidCastException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown for invalid casting or explicit conversion. - - InvalidCastException() - InvalidCastException(message: str) - InvalidCastException(message: str, innerException: Exception) - InvalidCastException(message: str, errorCode: int) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, *__args): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - __new__(cls: type, message: str, errorCode: int) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class InvalidOperationException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when a method call is invalid for the object's current state. - - InvalidOperationException() - InvalidOperationException(message: str) - InvalidOperationException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class InvalidProgramException(SystemException, ISerializable, _Exception): - # type: (MSIL) or metadata. Generally this indicates a bug in the compiler that generated the program. - """ - The exception that is thrown when a program contains invalid Microsoft intermediate language (MSIL) or metadata. Generally this indicates a bug in the compiler that generated the program. - - InvalidProgramException() - InvalidProgramException(message: str) - InvalidProgramException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class InvalidTimeZoneException(Exception, ISerializable, _Exception): - """ - The exception that is thrown when time zone information is invalid. - - InvalidTimeZoneException(message: str) - InvalidTimeZoneException(message: str, innerException: Exception) - InvalidTimeZoneException() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - __new__(cls: type) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class IObservable: - # no doc - def Subscribe(self, observer): - # type: (self: IObservable[T], observer: IObserver[T]) -> IDisposable - """ - Subscribe(self: IObservable[T], observer: IObserver[T]) -> IDisposable - - Notifies the provider that an observer is to receive notifications. - - observer: The object that is to receive notifications. - Returns: A reference to an interface that allows observers to stop receiving notifications before the provider has finished sending them. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IObserver: - # no doc - def OnCompleted(self): - # type: (self: IObserver[T]) - """ - OnCompleted(self: IObserver[T]) - Notifies the observer that the provider has finished sending push-based notifications. - """ - pass - - def OnError(self, error): - # type: (self: IObserver[T], error: Exception) - """ - OnError(self: IObserver[T], error: Exception) - Notifies the observer that the provider has experienced an error condition. - - error: An object that provides additional information about the error. - """ - pass - - def OnNext(self, value): - # type: (self: IObserver[T], value: T) - """ - OnNext(self: IObserver[T], value: T) - Provides the observer with new data. - - value: The current notification information. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IProgress: - # no doc - def Report(self, value): - # type: (self: IProgress[T], value: T) - """ Report(self: IProgress[T], value: T) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class IServiceProvider: - """ Defines a mechanism for retrieving a service object; that is, an object that provides custom support to other objects. """ - def GetService(self, serviceType): - # type: (self: IServiceProvider, serviceType: Type) -> object - """ - GetService(self: IServiceProvider, serviceType: Type) -> object - - Gets the service object of the specified type. - - serviceType: An object that specifies the type of service object to get. - Returns: A service object of type serviceType.-or- null if there is no service object of type serviceType. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class Lazy(object): - # type: (valueFactory: Func[T], mode: LazyThreadSafetyMode) - """ - Lazy[T](valueFactory: Func[T], mode: LazyThreadSafetyMode) - Lazy[T]() - Lazy[T](valueFactory: Func[T]) - Lazy[T](isThreadSafe: bool) - Lazy[T](mode: LazyThreadSafetyMode) - Lazy[T](valueFactory: Func[T], isThreadSafe: bool) - """ - def ToString(self): - # type: (self: Lazy[T]) -> str - """ - ToString(self: Lazy[T]) -> str - - Creates and returns a string representation of the System.Lazy property for this instance. - Returns: The result of calling the System.Object.ToString method on the System.Lazy property for this instance, if the value has been created (that is, if the System.Lazy property returns true). Otherwise, a string indicating that the value has not been - created. - """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, valueFactory: Func[T]) - __new__(cls: type, isThreadSafe: bool) - __new__(cls: type, mode: LazyThreadSafetyMode) - __new__(cls: type, valueFactory: Func[T], isThreadSafe: bool) - __new__(cls: type, valueFactory: Func[T], mode: LazyThreadSafetyMode) - """ - pass - - IsValueCreated = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether a value has been created for this System.Lazy instance. - - Get: IsValueCreated(self: Lazy[T]) -> bool - """ - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the lazily initialized value of the current System.Lazy instance. - - Get: Value(self: Lazy[T]) -> T - """ - - - -class LdapStyleUriParser(UriParser): - # type: (LDAP) scheme. - """ - A customizable parser based on the Lightweight Directory Access Protocol (LDAP) scheme. - - LdapStyleUriParser() - """ - -class LoaderOptimization(Enum, IComparable, IFormattable, IConvertible): - """ - An enumeration used with the System.LoaderOptimizationAttribute class to specify loader optimizations for an executable. - - enum LoaderOptimization, values: DisallowBindings (4), DomainMask (3), MultiDomain (2), MultiDomainHost (3), NotSpecified (0), SingleDomain (1) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - DisallowBindings = None - DomainMask = None - MultiDomain = None - MultiDomainHost = None - NotSpecified = None - SingleDomain = None - value__ = None - - -class LoaderOptimizationAttribute(Attribute, _Attribute): - """ - Used to set the default loader optimization policy for the main method of an executable application. - - LoaderOptimizationAttribute(value: Byte) - LoaderOptimizationAttribute(value: LoaderOptimization) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, value): - """ - __new__(cls: type, value: Byte) - __new__(cls: type, value: LoaderOptimization) - """ - pass - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the current System.LoaderOptimization value for this instance. - - Get: Value(self: LoaderOptimizationAttribute) -> LoaderOptimization - """ - - - -class LocalDataStoreSlot(object): - """ Encapsulates a memory slot to store local data. This class cannot be inherited. """ - -class Math(object): - """ Provides constants and static methods for trigonometric, logarithmic, and other common mathematical functions. """ - @staticmethod - def Abs(value): - # type: (value: SByte) -> SByte - """ - Abs(value: SByte) -> SByte - - Returns the absolute value of an 8-bit signed integer. - - value: A number that is greater than System.SByte.MinValue, but less than or equal to System.SByte.MaxValue. - Abs(value: Int16) -> Int16 - - Returns the absolute value of a 16-bit signed integer. - - value: A number that is greater than System.Int16.MinValue, but less than or equal to System.Int16.MaxValue. - Abs(value: int) -> int - - Returns the absolute value of a 32-bit signed integer. - - value: A number that is greater than System.Int32.MinValue, but less than or equal to System.Int32.MaxValue. - Abs(value: Int64) -> Int64 - - Returns the absolute value of a 64-bit signed integer. - - value: A number that is greater than System.Int64.MinValue, but less than or equal to System.Int64.MaxValue. - Abs(value: Single) -> Single - - Returns the absolute value of a single-precision floating-point number. - - value: A number that is greater than or equal to System.Single.MinValue, but less than or equal to System.Single.MaxValue. - Abs(value: float) -> float - - Returns the absolute value of a double-precision floating-point number. - - value: A number that is greater than or equal to System.Double.MinValue, but less than or equal to System.Double.MaxValue. - Abs(value: Decimal) -> Decimal - - Returns the absolute value of a System.Decimal number. - - value: A number that is greater than or equal to System.Decimal.MinValue, but less than or equal to System.Decimal.MaxValue. - """ - pass - - @staticmethod - def Acos(d): - # type: (d: float) -> float - """ - Acos(d: float) -> float - - Returns the angle whose cosine is the specified number. - - d: A number representing a cosine, where d must be greater than or equal to -1, but less than or equal to 1. - """ - pass - - @staticmethod - def Asin(d): - # type: (d: float) -> float - """ - Asin(d: float) -> float - - Returns the angle whose sine is the specified number. - - d: A number representing a sine, where d must be greater than or equal to -1, but less than or equal to 1. - """ - pass - - @staticmethod - def Atan(d): - # type: (d: float) -> float - """ - Atan(d: float) -> float - - Returns the angle whose tangent is the specified number. - - d: A number representing a tangent. - (1.5707963267949) if d equals System.Double.PositiveInfinity. - """ - pass - - @staticmethod - def Atan2(y, x): - # type: (y: float, x: float) -> float - """ - Atan2(y: float, x: float) -> float - - Returns the angle whose tangent is the quotient of two specified numbers. - - y: The y coordinate of a point. - x: The x coordinate of a point. - """ - pass - - @staticmethod - def BigMul(a, b): - # type: (a: int, b: int) -> Int64 - """ - BigMul(a: int, b: int) -> Int64 - - Produces the full product of two 32-bit numbers. - - a: The first number to multiply. - b: The second number to multiply. - Returns: The number containing the product of the specified numbers. - """ - pass - - @staticmethod - def Ceiling(*__args): - # type: (d: Decimal) -> Decimal - """ - Ceiling(d: Decimal) -> Decimal - - Returns the smallest integral value that is greater than or equal to the specified decimal number. - - d: A decimal number. - Returns: The smallest integral value that is greater than or equal to d. Note that this method returns a System.Decimal instead of an integral type. - Ceiling(a: float) -> float - - Returns the smallest integral value that is greater than or equal to the specified double-precision floating-point number. - - a: A double-precision floating-point number. - Returns: The smallest integral value that is greater than or equal to a. If a is equal to System.Double.NaN, System.Double.NegativeInfinity, or System.Double.PositiveInfinity, that value is returned. Note that this method returns a System.Double instead of an - integral type. - """ - pass - - @staticmethod - def Cos(d): - # type: (d: float) -> float - """ - Cos(d: float) -> float - - Returns the cosine of the specified angle. - - d: An angle, measured in radians. - Returns: The cosine of d. If d is equal to System.Double.NaN, System.Double.NegativeInfinity, or System.Double.PositiveInfinity, this method returns System.Double.NaN. - """ - pass - - @staticmethod - def Cosh(value): - # type: (value: float) -> float - """ - Cosh(value: float) -> float - - Returns the hyperbolic cosine of the specified angle. - - value: An angle, measured in radians. - Returns: The hyperbolic cosine of value. If value is equal to System.Double.NegativeInfinity or System.Double.PositiveInfinity, System.Double.PositiveInfinity is returned. If value is equal to System.Double.NaN, System.Double.NaN is returned. - """ - pass - - @staticmethod - def DivRem(a, b, result): - # type: (a: int, b: int) -> (int, int) - """ - DivRem(a: int, b: int) -> (int, int) - - Calculates the quotient of two 32-bit signed integers and also returns the remainder in an output parameter. - - a: The dividend. - b: The divisor. - Returns: The quotient of the specified numbers. - DivRem(a: Int64, b: Int64) -> (Int64, Int64) - - Calculates the quotient of two 64-bit signed integers and also returns the remainder in an output parameter. - - a: The dividend. - b: The divisor. - Returns: The quotient of the specified numbers. - """ - pass - - @staticmethod - def Exp(d): - # type: (d: float) -> float - """ - Exp(d: float) -> float - - Returns e raised to the specified power. - - d: A number specifying a power. - Returns: The number e raised to the power d. If d equals System.Double.NaN or System.Double.PositiveInfinity, that value is returned. If d equals System.Double.NegativeInfinity, 0 is returned. - """ - pass - - @staticmethod - def Floor(d): - # type: (d: Decimal) -> Decimal - """ - Floor(d: Decimal) -> Decimal - - Returns the largest integer less than or equal to the specified decimal number. - - d: A decimal number. - Returns: The largest integer less than or equal to d. - Floor(d: float) -> float - - Returns the largest integer less than or equal to the specified double-precision floating-point number. - - d: A double-precision floating-point number. - Returns: The largest integer less than or equal to d. If d is equal to System.Double.NaN, System.Double.NegativeInfinity, or System.Double.PositiveInfinity, that value is returned. - """ - pass - - @staticmethod - def IEEERemainder(x, y): - # type: (x: float, y: float) -> float - """ - IEEERemainder(x: float, y: float) -> float - - Returns the remainder resulting from the division of a specified number by another specified number. - - x: A dividend. - y: A divisor. - Returns: A number equal to x - (y Q), where Q is the quotient of x / y rounded to the nearest integer (if x / y falls halfway between two integers, the even integer is returned).If x - (y Q) is zero, the value +0 is returned if x is positive, or -0 if x is - negative.If y = 0, System.Double.NaN is returned. - """ - pass - - @staticmethod - def Log(*__args): - # type: (d: float) -> float - """ - Log(d: float) -> float - - Returns the natural (base e) logarithm of a specified number. - - d: A number whose logarithm is to be found. - Returns: One of the values in the following table. d parameterReturn value Positive The natural logarithm of d; that is, ln d, or log edZero System.Double.NegativeInfinityNegative System.Double.NaNEqual to System.Double.NaNSystem.Double.NaNEqual to - System.Double.PositiveInfinitySystem.Double.PositiveInfinity - - Log(a: float, newBase: float) -> float - - Returns the logarithm of a specified number in a specified base. - - a: A number whose logarithm is to be found. - newBase: The base of the logarithm. - Returns: One of the values in the following table. (+Infinity denotes System.Double.PositiveInfinity, -Infinity denotes System.Double.NegativeInfinity, and NaN denotes System.Double.NaN.)anewBaseReturn valuea> 0(0 1)lognewBase(a)a< - 0(any value)NaN(any value)newBase< 0NaNa != 1newBase = 0NaNa != 1newBase = +InfinityNaNa = NaN(any value)NaN(any value)newBase = NaNNaN(any value)newBase = 1NaNa = 00 1-Infinitya = +Infinity0 1+Infinitya = 1newBase = 00a = 1newBase = +Infinity0 - """ - pass - - @staticmethod - def Log10(d): - # type: (d: float) -> float - """ - Log10(d: float) -> float - - Returns the base 10 logarithm of a specified number. - - d: A number whose logarithm is to be found. - Returns: One of the values in the following table. d parameter Return value Positive The base 10 log of d; that is, log 10d. Zero System.Double.NegativeInfinityNegative System.Double.NaNEqual to System.Double.NaNSystem.Double.NaNEqual to - System.Double.PositiveInfinitySystem.Double.PositiveInfinity - """ - pass - - @staticmethod - def Max(val1, val2): - # type: (val1: SByte, val2: SByte) -> SByte - """ - Max(val1: SByte, val2: SByte) -> SByte - - Returns the larger of two 8-bit signed integers. - - val1: The first of two 8-bit signed integers to compare. - val2: The second of two 8-bit signed integers to compare. - Returns: Parameter val1 or val2, whichever is larger. - Max(val1: Byte, val2: Byte) -> Byte - - Returns the larger of two 8-bit unsigned integers. - - val1: The first of two 8-bit unsigned integers to compare. - val2: The second of two 8-bit unsigned integers to compare. - Returns: Parameter val1 or val2, whichever is larger. - Max(val1: Int16, val2: Int16) -> Int16 - - Returns the larger of two 16-bit signed integers. - - val1: The first of two 16-bit signed integers to compare. - val2: The second of two 16-bit signed integers to compare. - Returns: Parameter val1 or val2, whichever is larger. - Max(val1: UInt16, val2: UInt16) -> UInt16 - - Returns the larger of two 16-bit unsigned integers. - - val1: The first of two 16-bit unsigned integers to compare. - val2: The second of two 16-bit unsigned integers to compare. - Returns: Parameter val1 or val2, whichever is larger. - Max(val1: int, val2: int) -> int - - Returns the larger of two 32-bit signed integers. - - val1: The first of two 32-bit signed integers to compare. - val2: The second of two 32-bit signed integers to compare. - Returns: Parameter val1 or val2, whichever is larger. - Max(val1: UInt32, val2: UInt32) -> UInt32 - - Returns the larger of two 32-bit unsigned integers. - - val1: The first of two 32-bit unsigned integers to compare. - val2: The second of two 32-bit unsigned integers to compare. - Returns: Parameter val1 or val2, whichever is larger. - Max(val1: Int64, val2: Int64) -> Int64 - - Returns the larger of two 64-bit signed integers. - - val1: The first of two 64-bit signed integers to compare. - val2: The second of two 64-bit signed integers to compare. - Returns: Parameter val1 or val2, whichever is larger. - Max(val1: UInt64, val2: UInt64) -> UInt64 - - Returns the larger of two 64-bit unsigned integers. - - val1: The first of two 64-bit unsigned integers to compare. - val2: The second of two 64-bit unsigned integers to compare. - Returns: Parameter val1 or val2, whichever is larger. - Max(val1: Single, val2: Single) -> Single - - Returns the larger of two single-precision floating-point numbers. - - val1: The first of two single-precision floating-point numbers to compare. - val2: The second of two single-precision floating-point numbers to compare. - Returns: Parameter val1 or val2, whichever is larger. If val1, or val2, or both val1 and val2 are equal to System.Single.NaN, System.Single.NaN is returned. - Max(val1: float, val2: float) -> float - - Returns the larger of two double-precision floating-point numbers. - - val1: The first of two double-precision floating-point numbers to compare. - val2: The second of two double-precision floating-point numbers to compare. - Returns: Parameter val1 or val2, whichever is larger. If val1, val2, or both val1 and val2 are equal to System.Double.NaN, System.Double.NaN is returned. - Max(val1: Decimal, val2: Decimal) -> Decimal - - Returns the larger of two decimal numbers. - - val1: The first of two decimal numbers to compare. - val2: The second of two decimal numbers to compare. - Returns: Parameter val1 or val2, whichever is larger. - """ - pass - - @staticmethod - def Min(val1, val2): - # type: (val1: SByte, val2: SByte) -> SByte - """ - Min(val1: SByte, val2: SByte) -> SByte - - Returns the smaller of two 8-bit signed integers. - - val1: The first of two 8-bit signed integers to compare. - val2: The second of two 8-bit signed integers to compare. - Returns: Parameter val1 or val2, whichever is smaller. - Min(val1: Byte, val2: Byte) -> Byte - - Returns the smaller of two 8-bit unsigned integers. - - val1: The first of two 8-bit unsigned integers to compare. - val2: The second of two 8-bit unsigned integers to compare. - Returns: Parameter val1 or val2, whichever is smaller. - Min(val1: Int16, val2: Int16) -> Int16 - - Returns the smaller of two 16-bit signed integers. - - val1: The first of two 16-bit signed integers to compare. - val2: The second of two 16-bit signed integers to compare. - Returns: Parameter val1 or val2, whichever is smaller. - Min(val1: UInt16, val2: UInt16) -> UInt16 - - Returns the smaller of two 16-bit unsigned integers. - - val1: The first of two 16-bit unsigned integers to compare. - val2: The second of two 16-bit unsigned integers to compare. - Returns: Parameter val1 or val2, whichever is smaller. - Min(val1: int, val2: int) -> int - - Returns the smaller of two 32-bit signed integers. - - val1: The first of two 32-bit signed integers to compare. - val2: The second of two 32-bit signed integers to compare. - Returns: Parameter val1 or val2, whichever is smaller. - Min(val1: UInt32, val2: UInt32) -> UInt32 - - Returns the smaller of two 32-bit unsigned integers. - - val1: The first of two 32-bit unsigned integers to compare. - val2: The second of two 32-bit unsigned integers to compare. - Returns: Parameter val1 or val2, whichever is smaller. - Min(val1: Int64, val2: Int64) -> Int64 - - Returns the smaller of two 64-bit signed integers. - - val1: The first of two 64-bit signed integers to compare. - val2: The second of two 64-bit signed integers to compare. - Returns: Parameter val1 or val2, whichever is smaller. - Min(val1: UInt64, val2: UInt64) -> UInt64 - - Returns the smaller of two 64-bit unsigned integers. - - val1: The first of two 64-bit unsigned integers to compare. - val2: The second of two 64-bit unsigned integers to compare. - Returns: Parameter val1 or val2, whichever is smaller. - Min(val1: Single, val2: Single) -> Single - - Returns the smaller of two single-precision floating-point numbers. - - val1: The first of two single-precision floating-point numbers to compare. - val2: The second of two single-precision floating-point numbers to compare. - Returns: Parameter val1 or val2, whichever is smaller. If val1, val2, or both val1 and val2 are equal to System.Single.NaN, System.Single.NaN is returned. - Min(val1: float, val2: float) -> float - - Returns the smaller of two double-precision floating-point numbers. - - val1: The first of two double-precision floating-point numbers to compare. - val2: The second of two double-precision floating-point numbers to compare. - Returns: Parameter val1 or val2, whichever is smaller. If val1, val2, or both val1 and val2 are equal to System.Double.NaN, System.Double.NaN is returned. - Min(val1: Decimal, val2: Decimal) -> Decimal - - Returns the smaller of two decimal numbers. - - val1: The first of two decimal numbers to compare. - val2: The second of two decimal numbers to compare. - Returns: Parameter val1 or val2, whichever is smaller. - """ - pass - - @staticmethod - def Pow(x, y): - # type: (x: float, y: float) -> float - """ - Pow(x: float, y: float) -> float - - Returns a specified number raised to the specified power. - - x: A double-precision floating-point number to be raised to a power. - y: A double-precision floating-point number that specifies a power. - Returns: The number x raised to the power y. - """ - pass - - @staticmethod - def Round(*__args): - # type: (a: float) -> float - """ - Round(a: float) -> float - - Rounds a double-precision floating-point value to the nearest integral value. - - a: A double-precision floating-point number to be rounded. - Returns: The integer nearest a. If the fractional component of a is halfway between two integers, one of which is even and the other odd, then the even number is returned. Note that this method returns a System.Double instead of an integral type. - Round(value: float, digits: int) -> float - - Rounds a double-precision floating-point value to a specified number of fractional digits. - - value: A double-precision floating-point number to be rounded. - digits: The number of fractional digits in the return value. - Returns: The number nearest to value that contains a number of fractional digits equal to digits. - Round(value: float, mode: MidpointRounding) -> float - - Rounds a double-precision floating-point value to the nearest integer. A parameter specifies how to round the value if it is midway between two other numbers. - - value: A double-precision floating-point number to be rounded. - mode: Specification for how to round value if it is midway between two other numbers. - Returns: The integer nearest value. If value is halfway between two integers, one of which is even and the other odd, then mode determines which of the two is returned. - Round(value: float, digits: int, mode: MidpointRounding) -> float - - Rounds a double-precision floating-point value to the specified number of fractional digits. A parameter specifies how to round the value if it is midway between two other numbers. - - value: A double-precision floating-point number to be rounded. - digits: The number of fractional digits in the return value. - mode: Specification for how to round value if it is midway between two other numbers. - Returns: The number nearest to value that has a number of fractional digits equal to digits. If value has fewer fractional digits than digits, value is returned unchanged. - Round(d: Decimal) -> Decimal - - Rounds a decimal value to the nearest integral value. - - d: A decimal number to be rounded. - Returns: The integer nearest parameter d. If the fractional component of d is halfway between two integers, one of which is even and the other odd, the even number is returned. Note that this method returns a System.Decimal instead of an integral type. - Round(d: Decimal, decimals: int) -> Decimal - - Rounds a decimal value to a specified number of fractional digits. - - d: A decimal number to be rounded. - decimals: The number of decimal places in the return value. - Returns: The number nearest to d that contains a number of fractional digits equal to decimals. - Round(d: Decimal, mode: MidpointRounding) -> Decimal - - Rounds a decimal value to the nearest integer. A parameter specifies how to round the value if it is midway between two other numbers. - - d: A decimal number to be rounded. - mode: Specification for how to round d if it is midway between two other numbers. - Returns: The integer nearest d. If d is halfway between two numbers, one of which is even and the other odd, then mode determines which of the two is returned. - Round(d: Decimal, decimals: int, mode: MidpointRounding) -> Decimal - - Rounds a decimal value to a specified number of fractional digits. A parameter specifies how to round the value if it is midway between two other numbers. - - d: A decimal number to be rounded. - decimals: The number of decimal places in the return value. - mode: Specification for how to round d if it is midway between two other numbers. - Returns: The number nearest to d that contains a number of fractional digits equal to decimals. If d has fewer fractional digits than decimals, d is returned unchanged. - """ - pass - - @staticmethod - def Sign(value): - # type: (value: SByte) -> int - """ - Sign(value: SByte) -> int - - Returns a value indicating the sign of an 8-bit signed integer. - - value: A signed number. - Returns: A number that indicates the sign of value, as shown in the following table.Return value Meaning -1 value is less than zero. 0 value is equal to zero. 1 value is greater than zero. - Sign(value: Int16) -> int - - Returns a value indicating the sign of a 16-bit signed integer. - - value: A signed number. - Returns: A number that indicates the sign of value, as shown in the following table.Return value Meaning -1 value is less than zero. 0 value is equal to zero. 1 value is greater than zero. - Sign(value: int) -> int - - Returns a value indicating the sign of a 32-bit signed integer. - - value: A signed number. - Returns: A number that indicates the sign of value, as shown in the following table.Return value Meaning -1 value is less than zero. 0 value is equal to zero. 1 value is greater than zero. - Sign(value: Int64) -> int - - Returns a value indicating the sign of a 64-bit signed integer. - - value: A signed number. - Returns: A number that indicates the sign of value, as shown in the following table.Return value Meaning -1 value is less than zero. 0 value is equal to zero. 1 value is greater than zero. - Sign(value: Single) -> int - - Returns a value indicating the sign of a single-precision floating-point number. - - value: A signed number. - Returns: A number that indicates the sign of value, as shown in the following table.Return value Meaning -1 value is less than zero. 0 value is equal to zero. 1 value is greater than zero. - Sign(value: float) -> int - - Returns a value indicating the sign of a double-precision floating-point number. - - value: A signed number. - Returns: A number that indicates the sign of value, as shown in the following table.Return value Meaning -1 value is less than zero. 0 value is equal to zero. 1 value is greater than zero. - Sign(value: Decimal) -> int - - Returns a value indicating the sign of a decimal number. - - value: A signed decimal number. - Returns: A number that indicates the sign of value, as shown in the following table.Return value Meaning -1 value is less than zero. 0 value is equal to zero. 1 value is greater than zero. - """ - pass - - @staticmethod - def Sin(a): - # type: (a: float) -> float - """ - Sin(a: float) -> float - - Returns the sine of the specified angle. - - a: An angle, measured in radians. - Returns: The sine of a. If a is equal to System.Double.NaN, System.Double.NegativeInfinity, or System.Double.PositiveInfinity, this method returns System.Double.NaN. - """ - pass - - @staticmethod - def Sinh(value): - # type: (value: float) -> float - """ - Sinh(value: float) -> float - - Returns the hyperbolic sine of the specified angle. - - value: An angle, measured in radians. - Returns: The hyperbolic sine of value. If value is equal to System.Double.NegativeInfinity, System.Double.PositiveInfinity, or System.Double.NaN, this method returns a System.Double equal to value. - """ - pass - - @staticmethod - def Sqrt(d): - # type: (d: float) -> float - """ - Sqrt(d: float) -> float - - Returns the square root of a specified number. - - d: A number. - Returns: One of the values in the following table. d parameter Return value Zero, or positive The positive square root of d. Negative System.Double.NaNEquals System.Double.NaNSystem.Double.NaNEquals System.Double.PositiveInfinitySystem.Double.PositiveInfinity - """ - pass - - @staticmethod - def Tan(a): - # type: (a: float) -> float - """ - Tan(a: float) -> float - - Returns the tangent of the specified angle. - - a: An angle, measured in radians. - Returns: The tangent of a. If a is equal to System.Double.NaN, System.Double.NegativeInfinity, or System.Double.PositiveInfinity, this method returns System.Double.NaN. - """ - pass - - @staticmethod - def Tanh(value): - # type: (value: float) -> float - """ - Tanh(value: float) -> float - - Returns the hyperbolic tangent of the specified angle. - - value: An angle, measured in radians. - Returns: The hyperbolic tangent of value. If value is equal to System.Double.NegativeInfinity, this method returns -1. If value is equal to System.Double.PositiveInfinity, this method returns 1. If value is equal to System.Double.NaN, this method returns - System.Double.NaN. - """ - pass - - @staticmethod - def Truncate(d): - # type: (d: Decimal) -> Decimal - """ - Truncate(d: Decimal) -> Decimal - - Calculates the integral part of a specified decimal number. - - d: A number to truncate. - Returns: The integral part of d; that is, the number that remains after any fractional digits have been discarded. - Truncate(d: float) -> float - - Calculates the integral part of a specified double-precision floating-point number. - - d: A number to truncate. - Returns: The integral part of d; that is, the number that remains after any fractional digits have been discarded, or one of the values listed in the following table. dReturn - valueSystem.Double.NaNSystem.Double.NaNSystem.Double.NegativeInfinitySystem.Double.NegativeInfinitySystem.Double.PositiveInfinitySystem.Double.PositiveInfinity - """ - pass - - E = 2.7182818284590451 - PI = 3.1415926535897931 - __all__ = [ - 'Abs', - 'Acos', - 'Asin', - 'Atan', - 'Atan2', - 'BigMul', - 'Ceiling', - 'Cos', - 'Cosh', - 'DivRem', - 'E', - 'Exp', - 'Floor', - 'IEEERemainder', - 'Log', - 'Log10', - 'Max', - 'Min', - 'PI', - 'Pow', - 'Round', - 'Sign', - 'Sin', - 'Sinh', - 'Sqrt', - 'Tan', - 'Tanh', - 'Truncate', - ] - - -class MethodAccessException(MemberAccessException, ISerializable, _Exception): - """ - The exception that is thrown when there is an invalid attempt to access a method, such as accessing a private method from partially trusted code. - - MethodAccessException() - MethodAccessException(message: str) - MethodAccessException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class MidpointRounding(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies how mathematical rounding methods should process a number that is midway between two numbers. - - enum MidpointRounding, values: AwayFromZero (1), ToEven (0) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - AwayFromZero = None - ToEven = None - value__ = None - - -class MissingMemberException(MemberAccessException, ISerializable, _Exception): - """ - The exception that is thrown when there is an attempt to dynamically access a class member that does not exist. - - MissingMemberException() - MissingMemberException(message: str) - MissingMemberException(message: str, inner: Exception) - MissingMemberException(className: str, memberName: str) - """ - def GetObjectData(self, info, context): - # type: (self: MissingMemberException, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: MissingMemberException, info: SerializationInfo, context: StreamingContext) - Sets the System.Runtime.Serialization.SerializationInfo object with the class name, the member name, the signature of the missing member, and additional exception information. - - info: The object that holds the serialized object data. - context: The contextual information about the source or destination. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - __new__(cls: type, className: str, memberName: str) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Message = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the text string showing the class name, the member name, and the signature of the missing member. - - Get: Message(self: MissingMemberException) -> str - """ - - - ClassName = None - MemberName = None - SerializeObjectState = None - Signature = None - - -class MissingFieldException(MissingMemberException, ISerializable, _Exception): - """ - The exception that is thrown when there is an attempt to dynamically access a field that does not exist. - - MissingFieldException() - MissingFieldException(message: str) - MissingFieldException(message: str, inner: Exception) - MissingFieldException(className: str, fieldName: str) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - __new__(cls: type, className: str, fieldName: str) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Message = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the text string showing the signature of the missing field, the class name, and the field name. This property is read-only. - - Get: Message(self: MissingFieldException) -> str - """ - - - ClassName = None - MemberName = None - SerializeObjectState = None - Signature = None - - -class MissingMethodException(MissingMemberException, ISerializable, _Exception): - """ - The exception that is thrown when there is an attempt to dynamically access a method that does not exist. - - MissingMethodException() - MissingMethodException(message: str) - MissingMethodException(message: str, inner: Exception) - MissingMethodException(className: str, methodName: str) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - __new__(cls: type, className: str, methodName: str) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Message = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the text string showing the class name, the method name, and the signature of the missing method. This property is read-only. - - Get: Message(self: MissingMethodException) -> str - """ - - - ClassName = None - MemberName = None - SerializeObjectState = None - Signature = None - - -class ModuleHandle(object): - """ Represents a runtime handle for a module. """ - def Equals(self, *__args): - # type: (self: ModuleHandle, obj: object) -> bool - """ - Equals(self: ModuleHandle, obj: object) -> bool - - Returns a System.Boolean value indicating whether the specified object is a System.ModuleHandle structure, and equal to the current System.ModuleHandle. - - obj: The object to be compared with the current System.ModuleHandle structure. - Returns: true if obj is a System.ModuleHandle structure, and is equal to the current System.ModuleHandle structure; otherwise, false. - Equals(self: ModuleHandle, handle: ModuleHandle) -> bool - - Returns a System.Boolean value indicating whether the specified System.ModuleHandle structure is equal to the current System.ModuleHandle. - - handle: The System.ModuleHandle structure to be compared with the current System.ModuleHandle. - Returns: true if handle is equal to the current System.ModuleHandle structure; otherwise false. - """ - pass - - def GetHashCode(self): - # type: (self: ModuleHandle) -> int - """ GetHashCode(self: ModuleHandle) -> int """ - pass - - def GetRuntimeFieldHandleFromMetadataToken(self, fieldToken): - # type: (self: ModuleHandle, fieldToken: int) -> RuntimeFieldHandle - """ - GetRuntimeFieldHandleFromMetadataToken(self: ModuleHandle, fieldToken: int) -> RuntimeFieldHandle - - Returns a runtime handle for the field identified by the specified metadata token. - - fieldToken: A metadata token that identifies a field in the module. - Returns: A System.RuntimeFieldHandle for the field identified by fieldToken. - """ - pass - - def GetRuntimeMethodHandleFromMetadataToken(self, methodToken): - # type: (self: ModuleHandle, methodToken: int) -> RuntimeMethodHandle - """ - GetRuntimeMethodHandleFromMetadataToken(self: ModuleHandle, methodToken: int) -> RuntimeMethodHandle - - Returns a runtime method handle for the method or constructor identified by the specified metadata token. - - methodToken: A metadata token that identifies a method or constructor in the module. - Returns: A System.RuntimeMethodHandle for the method or constructor identified by methodToken. - """ - pass - - def GetRuntimeTypeHandleFromMetadataToken(self, typeToken): - # type: (self: ModuleHandle, typeToken: int) -> RuntimeTypeHandle - """ - GetRuntimeTypeHandleFromMetadataToken(self: ModuleHandle, typeToken: int) -> RuntimeTypeHandle - - Returns a runtime type handle for the type identified by the specified metadata token. - - typeToken: A metadata token that identifies a type in the module. - Returns: A System.RuntimeTypeHandle for the type identified by typeToken. - """ - pass - - def ResolveFieldHandle(self, fieldToken, typeInstantiationContext=None, methodInstantiationContext=None): - # type: (self: ModuleHandle, fieldToken: int) -> RuntimeFieldHandle - """ - ResolveFieldHandle(self: ModuleHandle, fieldToken: int) -> RuntimeFieldHandle - - Returns a runtime handle for the field identified by the specified metadata token. - - fieldToken: A metadata token that identifies a field in the module. - Returns: A System.RuntimeFieldHandle for the field identified by fieldToken. - ResolveFieldHandle(self: ModuleHandle, fieldToken: int, typeInstantiationContext: Array[RuntimeTypeHandle], methodInstantiationContext: Array[RuntimeTypeHandle]) -> RuntimeFieldHandle - - Returns a runtime field handle for the field identified by the specified metadata token, specifying the generic type arguments of the type and method where the token is in scope. - - fieldToken: A metadata token that identifies a field in the module. - typeInstantiationContext: An array of System.RuntimeTypeHandle structures representing the generic type arguments of the type where the token is in scope, or null if that type is not generic. - methodInstantiationContext: An array of System.RuntimeTypeHandle structures representing the generic type arguments of the method where the token is in scope, or null if that method is not generic. - Returns: A System.RuntimeFieldHandle for the field identified by fieldToken. - """ - pass - - def ResolveMethodHandle(self, methodToken, typeInstantiationContext=None, methodInstantiationContext=None): - # type: (self: ModuleHandle, methodToken: int) -> RuntimeMethodHandle - """ - ResolveMethodHandle(self: ModuleHandle, methodToken: int) -> RuntimeMethodHandle - - Returns a runtime method handle for the method or constructor identified by the specified metadata token. - - methodToken: A metadata token that identifies a method or constructor in the module. - Returns: A System.RuntimeMethodHandle for the method or constructor identified by methodToken. - ResolveMethodHandle(self: ModuleHandle, methodToken: int, typeInstantiationContext: Array[RuntimeTypeHandle], methodInstantiationContext: Array[RuntimeTypeHandle]) -> RuntimeMethodHandle - - Returns a runtime method handle for the method or constructor identified by the specified metadata token, specifying the generic type arguments of the type and method where the token is in scope. - - methodToken: A metadata token that identifies a method or constructor in the module. - typeInstantiationContext: An array of System.RuntimeTypeHandle structures representing the generic type arguments of the type where the token is in scope, or null if that type is not generic. - methodInstantiationContext: An array of System.RuntimeTypeHandle structures representing the generic type arguments of the method where the token is in scope, or null if that method is not generic. - Returns: A System.RuntimeMethodHandle for the method or constructor identified by methodToken. - """ - pass - - def ResolveTypeHandle(self, typeToken, typeInstantiationContext=None, methodInstantiationContext=None): - # type: (self: ModuleHandle, typeToken: int) -> RuntimeTypeHandle - """ - ResolveTypeHandle(self: ModuleHandle, typeToken: int) -> RuntimeTypeHandle - - Returns a runtime type handle for the type identified by the specified metadata token. - - typeToken: A metadata token that identifies a type in the module. - Returns: A System.RuntimeTypeHandle for the type identified by typeToken. - ResolveTypeHandle(self: ModuleHandle, typeToken: int, typeInstantiationContext: Array[RuntimeTypeHandle], methodInstantiationContext: Array[RuntimeTypeHandle]) -> RuntimeTypeHandle - - Returns a runtime type handle for the type identified by the specified metadata token, specifying the generic type arguments of the type and method where the token is in scope. - - typeToken: A metadata token that identifies a type in the module. - typeInstantiationContext: An array of System.RuntimeTypeHandle structures representing the generic type arguments of the type where the token is in scope, or null if that type is not generic. - methodInstantiationContext: An array of System.RuntimeTypeHandle structures objects representing the generic type arguments of the method where the token is in scope, or null if that method is not generic. - Returns: A System.RuntimeTypeHandle for the type identified by typeToken. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - MDStreamVersion = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the metadata stream version. - - Get: MDStreamVersion(self: ModuleHandle) -> int - """ - - - EmptyHandle = None - - -class MTAThreadAttribute(Attribute, _Attribute): - # type: (MTA). - """ - Indicates that the COM threading model for an application is multithreaded apartment (MTA). - - MTAThreadAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class MulticastNotSupportedException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when there is an attempt to combine two delegates based on the System.Delegate type instead of the System.MulticastDelegate type. This class cannot be inherited. - - MulticastNotSupportedException() - MulticastNotSupportedException(message: str) - MulticastNotSupportedException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class NetPipeStyleUriParser(UriParser): - """ - A parser based on the NetPipe scheme for the "Indigo" system. - - NetPipeStyleUriParser() - """ - -class NetTcpStyleUriParser(UriParser): - """ - A parser based on the NetTcp scheme for the "Indigo" system. - - NetTcpStyleUriParser() - """ - -class NewsStyleUriParser(UriParser): - # type: (NNTP). - """ - A customizable parser based on the news scheme using the Network News Transfer Protocol (NNTP). - - NewsStyleUriParser() - """ - -class NonSerializedAttribute(Attribute, _Attribute): - """ - Indicates that a field of a serializable class should not be serialized. This class cannot be inherited. - - NonSerializedAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class NotFiniteNumberException(ArithmeticException, ISerializable, _Exception): - # type: (NaN). - """ - The exception that is thrown when a floating-point value is positive infinity, negative infinity, or Not-a-Number (NaN). - - NotFiniteNumberException() - NotFiniteNumberException(offendingNumber: float) - NotFiniteNumberException(message: str) - NotFiniteNumberException(message: str, offendingNumber: float) - NotFiniteNumberException(message: str, innerException: Exception) - NotFiniteNumberException(message: str, offendingNumber: float, innerException: Exception) - """ - def GetObjectData(self, info, context): - # type: (self: NotFiniteNumberException, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: NotFiniteNumberException, info: SerializationInfo, context: StreamingContext) - Sets the System.Runtime.Serialization.SerializationInfo object with the invalid number and additional exception information. - - info: The object that holds the serialized object data. - context: The contextual information about the source or destination. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, offendingNumber: float) - __new__(cls: type, message: str) - __new__(cls: type, message: str, offendingNumber: float) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, message: str, offendingNumber: float, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - OffendingNumber = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (NaN). - """ - Gets the invalid number that is a positive infinity, a negative infinity, or Not-a-Number (NaN). - - Get: OffendingNumber(self: NotFiniteNumberException) -> float - """ - - - SerializeObjectState = None - - -class NotImplementedException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when a requested method or operation is not implemented. - - NotImplementedException() - NotImplementedException(message: str) - NotImplementedException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class NotSupportedException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when an invoked method is not supported, or when there is an attempt to read, seek, or write to a stream that does not support the invoked functionality. - - NotSupportedException() - NotSupportedException(message: str) - NotSupportedException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class NullReferenceException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when there is an attempt to dereference a null object reference. - - NullReferenceException() - NullReferenceException(message: str) - NullReferenceException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class ObjectDisposedException(InvalidOperationException, ISerializable, _Exception): - """ - The exception that is thrown when an operation is performed on a disposed object. - - ObjectDisposedException(objectName: str) - ObjectDisposedException(objectName: str, message: str) - ObjectDisposedException(message: str, innerException: Exception) - """ - def GetObjectData(self, info, context): - # type: (self: ObjectDisposedException, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: ObjectDisposedException, info: SerializationInfo, context: StreamingContext) - Retrieves the System.Runtime.Serialization.SerializationInfo object with the parameter name and additional exception information. - - info: The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown. - context: The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, objectName: str) - __new__(cls: type, objectName: str, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Message = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the message that describes the error. - - Get: Message(self: ObjectDisposedException) -> str - """ - - ObjectName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the name of the disposed object. - - Get: ObjectName(self: ObjectDisposedException) -> str - """ - - - SerializeObjectState = None - - -class ObsoleteAttribute(Attribute, _Attribute): - """ - Marks the program elements that are no longer in use. This class cannot be inherited. - - ObsoleteAttribute() - ObsoleteAttribute(message: str) - ObsoleteAttribute(message: str, error: bool) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, error=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, error: bool) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - IsError = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a Boolean value indicating whether the compiler will treat usage of the obsolete program element as an error. - - Get: IsError(self: ObsoleteAttribute) -> bool - """ - - Message = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the workaround message, including a description of the alternative program elements. - - Get: Message(self: ObsoleteAttribute) -> str - """ - - - -class OperatingSystem(object, ICloneable, ISerializable): - """ - Represents information about an operating system, such as the version and platform identifier. This class cannot be inherited. - - OperatingSystem(platform: PlatformID, version: Version) - """ - def Clone(self): - # type: (self: OperatingSystem) -> object - """ - Clone(self: OperatingSystem) -> object - - Creates an System.OperatingSystem object that is identical to this instance. - Returns: An System.OperatingSystem object that is a copy of this instance. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: OperatingSystem, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: OperatingSystem, info: SerializationInfo, context: StreamingContext) - Populates a System.Runtime.Serialization.SerializationInfo object with the data necessary to deserialize this instance. - - info: The object to populate with serialization information. - context: The place to store and retrieve serialized data. Reserved for future use. - """ - pass - - def ToString(self): - # type: (self: OperatingSystem) -> str - """ - ToString(self: OperatingSystem) -> str - - Converts the value of this System.OperatingSystem object to its equivalent string representation. - Returns: The string representation of the values returned by the System.OperatingSystem.Platform, System.OperatingSystem.Version, and System.OperatingSystem.ServicePack properties. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, platform, version): - """ __new__(cls: type, platform: PlatformID, version: Version) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Platform = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.PlatformID enumeration value that identifies the operating system platform. - - Get: Platform(self: OperatingSystem) -> PlatformID - """ - - ServicePack = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the service pack version represented by this System.OperatingSystem object. - - Get: ServicePack(self: OperatingSystem) -> str - """ - - Version = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.Version object that identifies the operating system. - - Get: Version(self: OperatingSystem) -> Version - """ - - VersionString = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the concatenated string representation of the platform identifier, version, and service pack that are currently installed on the operating system. - - Get: VersionString(self: OperatingSystem) -> str - """ - - - -class OperationCanceledException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown in a thread upon cancellation of an operation that the thread was executing. - - OperationCanceledException() - OperationCanceledException(message: str) - OperationCanceledException(message: str, innerException: Exception) - OperationCanceledException(token: CancellationToken) - OperationCanceledException(message: str, token: CancellationToken) - OperationCanceledException(message: str, innerException: Exception, token: CancellationToken) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, token: CancellationToken) - __new__(cls: type, message: str, token: CancellationToken) - __new__(cls: type, message: str, innerException: Exception, token: CancellationToken) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CancellationToken = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a token associated with the operation that was canceled. - - Get: CancellationToken(self: OperationCanceledException) -> CancellationToken - """ - - - SerializeObjectState = None - - -class OverflowException(ArithmeticException, ISerializable, _Exception): - """ - The exception that is thrown when an arithmetic, casting, or conversion operation in a checked context results in an overflow. - - OverflowException() - OverflowException(message: str) - OverflowException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class ParamArrayAttribute(Attribute, _Attribute): - """ - Indicates that a method will allow a variable number of arguments in its invocation. This class cannot be inherited. - - ParamArrayAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class PlatformID(Enum, IComparable, IFormattable, IConvertible): - """ - Identifies the operating system, or platform, supported by an assembly. - - enum PlatformID, values: MacOSX (6), Unix (4), Win32NT (2), Win32S (0), Win32Windows (1), WinCE (3), Xbox (5) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - MacOSX = None - Unix = None - value__ = None - Win32NT = None - Win32S = None - Win32Windows = None - WinCE = None - Xbox = None - - -class PlatformNotSupportedException(NotSupportedException, ISerializable, _Exception): - """ - The exception that is thrown when a feature does not run on a particular platform. - - PlatformNotSupportedException() - PlatformNotSupportedException(message: str) - PlatformNotSupportedException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class Predicate(MulticastDelegate, ICloneable, ISerializable): - # type: (object: object, method: IntPtr) - """ Predicate[T](object: object, method: IntPtr) """ - def BeginInvoke(self, obj, callback, object): - # type: (self: Predicate[T], obj: T, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: Predicate[T], obj: T, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: Predicate[T], result: IAsyncResult) -> bool - """ EndInvoke(self: Predicate[T], result: IAsyncResult) -> bool """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, obj): - # type: (self: Predicate[T], obj: T) -> bool - """ Invoke(self: Predicate[T], obj: T) -> bool """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class Progress(object, IProgress[T]): - # type: () - """ - Progress[T]() - Progress[T](handler: Action[T]) - """ - def OnReport(self, *args): #cannot find CLR method - # type: (self: Progress[T], value: T) - """ OnReport(self: Progress[T], value: T) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, handler=None): - """ - __new__(cls: type) - __new__(cls: type, handler: Action[T]) - """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - ProgressChanged = None - - -class Random(object): - """ - Represents a pseudo-random number generator, a device that produces a sequence of numbers that meet certain statistical requirements for randomness. - - Random() - Random(Seed: int) - """ - def Next(self, *__args): - # type: (self: Random) -> int - """ - Next(self: Random) -> int - - Returns a nonnegative random number. - Returns: A 32-bit signed integer greater than or equal to zero and less than System.Int32.MaxValue. - Next(self: Random, minValue: int, maxValue: int) -> int - - Returns a random number within a specified range. - - minValue: The inclusive lower bound of the random number returned. - maxValue: The exclusive upper bound of the random number returned. maxValue must be greater than or equal to minValue. - Returns: A 32-bit signed integer greater than or equal to minValue and less than maxValue; that is, the range of return values includes minValue but not maxValue. If minValue equals maxValue, minValue is returned. - Next(self: Random, maxValue: int) -> int - - Returns a nonnegative random number less than the specified maximum. - - maxValue: The exclusive upper bound of the random number to be generated. maxValue must be greater than or equal to zero. - Returns: A 32-bit signed integer greater than or equal to zero, and less than maxValue; that is, the range of return values ordinarily includes zero but not maxValue. However, if maxValue equals zero, maxValue is returned. - """ - pass - - def NextBytes(self, buffer): - # type: (self: Random, buffer: Array[Byte]) - """ - NextBytes(self: Random, buffer: Array[Byte]) - Fills the elements of a specified array of bytes with random numbers. - - buffer: An array of bytes to contain random numbers. - """ - pass - - def NextDouble(self): - # type: (self: Random) -> float - """ - NextDouble(self: Random) -> float - - Returns a random number between 0.0 and 1.0. - Returns: A double-precision floating point number greater than or equal to 0.0, and less than 1.0. - """ - pass - - def Sample(self, *args): #cannot find CLR method - # type: (self: Random) -> float - """ - Sample(self: Random) -> float - - Returns a random number between 0.0 and 1.0. - Returns: A double-precision floating point number greater than or equal to 0.0, and less than 1.0. - """ - pass - - @staticmethod # known case of __new__ - def __new__(self, Seed=None): - """ - __new__(cls: type) - __new__(cls: type, Seed: int) - """ - pass - - -class RankException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when an array with the wrong number of dimensions is passed to a method. - - RankException() - RankException(message: str) - RankException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class ResolveEventArgs(EventArgs): - """ - Provides data for loader resolution events, such as the System.AppDomain.TypeResolve, System.AppDomain.ResourceResolve, System.AppDomain.ReflectionOnlyAssemblyResolve, and System.AppDomain.AssemblyResolve events. - - ResolveEventArgs(name: str) - ResolveEventArgs(name: str, requestingAssembly: Assembly) - """ - @staticmethod # known case of __new__ - def __new__(self, name, requestingAssembly=None): - """ - __new__(cls: type, name: str) - __new__(cls: type, name: str, requestingAssembly: Assembly) - """ - pass - - Name = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the name of the item to resolve. - - Get: Name(self: ResolveEventArgs) -> str - """ - - RequestingAssembly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the assembly whose dependency is being resolved. - - Get: RequestingAssembly(self: ResolveEventArgs) -> Assembly - """ - - - -class ResolveEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents a method that handles the System.AppDomain.TypeResolve, System.AppDomain.ResourceResolve, or System.AppDomain.AssemblyResolve event of an System.AppDomain. - - ResolveEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, args, callback, object): - # type: (self: ResolveEventHandler, sender: object, args: ResolveEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: ResolveEventHandler, sender: object, args: ResolveEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: ResolveEventHandler, result: IAsyncResult) -> Assembly - """ EndInvoke(self: ResolveEventHandler, result: IAsyncResult) -> Assembly """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, args): - # type: (self: ResolveEventHandler, sender: object, args: ResolveEventArgs) -> Assembly - """ Invoke(self: ResolveEventHandler, sender: object, args: ResolveEventArgs) -> Assembly """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class RuntimeArgumentHandle(object): - """ References a variable-length argument list. """ - -class RuntimeFieldHandle(object, ISerializable): - """ Represents a field using an internal metadata token. """ - def Equals(self, *__args): - # type: (self: RuntimeFieldHandle, obj: object) -> bool - """ - Equals(self: RuntimeFieldHandle, obj: object) -> bool - - Indicates whether the current instance is equal to the specified object. - - obj: The object to compare to the current instance. - Returns: true if obj is a System.RuntimeFieldHandle and equal to the value of the current instance; otherwise, false. - Equals(self: RuntimeFieldHandle, handle: RuntimeFieldHandle) -> bool - - Indicates whether the current instance is equal to the specified System.RuntimeFieldHandle. - - handle: The System.RuntimeFieldHandle to compare to the current instance. - Returns: true if the value of handle is equal to the value of the current instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: RuntimeFieldHandle) -> int - """ GetHashCode(self: RuntimeFieldHandle) -> int """ - pass - - def GetObjectData(self, info, context): - # type: (self: RuntimeFieldHandle, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: RuntimeFieldHandle, info: SerializationInfo, context: StreamingContext) - Populates a System.Runtime.Serialization.SerializationInfo with the data necessary to deserialize the field represented by the current instance. - - info: The System.Runtime.Serialization.SerializationInfo object to populate with serialization information. - context: (Reserved) The place to store and retrieve serialized data. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a handle to the field represented by the current instance. - - Get: Value(self: RuntimeFieldHandle) -> IntPtr - """ - - - -class RuntimeMethodHandle(object, ISerializable): - """ System.RuntimeMethodHandle is a handle to the internal metadata representation of a method. """ - def Equals(self, *__args): - # type: (self: RuntimeMethodHandle, obj: object) -> bool - """ - Equals(self: RuntimeMethodHandle, obj: object) -> bool - - Indicates whether this instance is equal to a specified object. - - obj: A System.Object to compare to this instance. - Returns: true if obj is a System.RuntimeMethodHandle and equal to the value of this instance; otherwise, false. - Equals(self: RuntimeMethodHandle, handle: RuntimeMethodHandle) -> bool - - Indicates whether this instance is equal to a specified System.RuntimeMethodHandle. - - handle: A System.RuntimeMethodHandle to compare to this instance. - Returns: true if handle is equal to the value of this instance; otherwise, false. - """ - pass - - def GetFunctionPointer(self): - # type: (self: RuntimeMethodHandle) -> IntPtr - """ - GetFunctionPointer(self: RuntimeMethodHandle) -> IntPtr - - Obtains a pointer to the method represented by this instance. - Returns: A pointer to the method represented by this instance. - """ - pass - - def GetHashCode(self): - # type: (self: RuntimeMethodHandle) -> int - """ - GetHashCode(self: RuntimeMethodHandle) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: RuntimeMethodHandle, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: RuntimeMethodHandle, info: SerializationInfo, context: StreamingContext) - Populates a System.Runtime.Serialization.SerializationInfo with the data necessary to deserialize the field represented by this instance. - - info: The object to populate with serialization information. - context: (Reserved) The place to store and retrieve serialized data. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of this instance. - - Get: Value(self: RuntimeMethodHandle) -> IntPtr - """ - - - -class RuntimeTypeHandle(object, ISerializable): - """ Represents a type using an internal metadata token. """ - def Equals(self, *__args): - # type: (self: RuntimeTypeHandle, handle: RuntimeTypeHandle) -> bool - """ - Equals(self: RuntimeTypeHandle, handle: RuntimeTypeHandle) -> bool - - Indicates whether the specified System.RuntimeTypeHandle structure is equal to the current System.RuntimeTypeHandle structure. - - handle: The System.RuntimeTypeHandle structure to compare to the current instance. - Returns: true if the value of handle is equal to the value of this instance; otherwise, false. - Equals(self: RuntimeTypeHandle, obj: object) -> bool - - Indicates whether the specified object is equal to the current System.RuntimeTypeHandle structure. - - obj: An object to compare to the current instance. - Returns: true if obj is a System.RuntimeTypeHandle structure and is equal to the value of this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: RuntimeTypeHandle) -> int - """ - GetHashCode(self: RuntimeTypeHandle) -> int - - Returns the hash code for the current instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetModuleHandle(self): - # type: (self: RuntimeTypeHandle) -> ModuleHandle - """ - GetModuleHandle(self: RuntimeTypeHandle) -> ModuleHandle - - Gets a handle to the module that contains the type represented by the current instance. - Returns: A System.ModuleHandle structure representing a handle to the module that contains the type represented by the current instance. - """ - pass - - def GetObjectData(self, info, context): - # type: (self: RuntimeTypeHandle, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: RuntimeTypeHandle, info: SerializationInfo, context: StreamingContext) - Populates a System.Runtime.Serialization.SerializationInfo with the data necessary to deserialize the type represented by the current instance. - - info: The object to be populated with serialization information. - context: (Reserved) The location where serialized data will be stored and retrieved. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a handle to the type represented by this instance. - - Get: Value(self: RuntimeTypeHandle) -> IntPtr - """ - - - -class SByte(object, IComparable, IFormattable, IConvertible, IComparable[SByte], IEquatable[SByte]): - """ Represents an 8-bit signed integer. """ - def bit_length(self, *args): #cannot find CLR method - # type: (value: SByte) -> int - """ bit_length(value: SByte) -> int """ - pass - - def CompareTo(self, *__args): - # type: (self: SByte, obj: object) -> int - """ - CompareTo(self: SByte, obj: object) -> int - - Compares this instance to a specified object and returns an indication of their relative values. - - obj: An object to compare, or null. - Returns: A signed number indicating the relative values of this instance and obj.Return Value Description Less than zero This instance is less than obj. Zero This instance is equal to obj. Greater than zero This instance is greater than obj.-or- obj is null. - CompareTo(self: SByte, value: SByte) -> int - - Compares this instance to a specified 8-bit signed integer and returns an indication of their relative values. - - value: An 8-bit signed integer to compare. - Returns: A signed integer that indicates the relative order of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value. - """ - pass - - def conjugate(self, *args): #cannot find CLR method - # type: (x: SByte) -> SByte - """ conjugate(x: SByte) -> SByte """ - pass - - def Equals(self, obj): - # type: (self: SByte, obj: object) -> bool - """ - Equals(self: SByte, obj: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - obj: An object to compare with this instance. - Returns: true if obj is an instance of System.SByte and equals the value of this instance; otherwise, false. - Equals(self: SByte, obj: SByte) -> bool - - Returns a value indicating whether this instance is equal to a specified System.SByte value. - - obj: An System.SByte value to compare to this instance. - Returns: true if obj has the same value as this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: SByte) -> int - """ - GetHashCode(self: SByte) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetTypeCode(self): - # type: (self: SByte) -> TypeCode - """ - GetTypeCode(self: SByte) -> TypeCode - - Returns the System.TypeCode for value type System.SByte. - Returns: The enumerated constant, System.TypeCode.SByte. - """ - pass - - @staticmethod - def Parse(s, *__args): - # type: (s: str) -> SByte - """ - Parse(s: str) -> SByte - - Converts the string representation of a number to its 8-bit signed integer equivalent. - - s: A string that represents a number to convert. The string is interpreted using the System.Globalization.NumberStyles.Integer style. - Returns: An 8-bit signed integer that is equivalent to the number contained in the s parameter. - Parse(s: str, style: NumberStyles) -> SByte - - Converts the string representation of a number in a specified style to its 8-bit signed integer equivalent. - - s: A string that contains a number to convert. The string is interpreted using the style specified by style. - style: A bitwise combination of the enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - Returns: An 8-bit signed integer that is equivalent to the number specified in s. - Parse(s: str, provider: IFormatProvider) -> SByte - - Converts the string representation of a number in a specified culture-specific format to its 8-bit signed integer equivalent. - - s: A string that represents a number to convert. The string is interpreted using the System.Globalization.NumberStyles.Integer style. - provider: An object that supplies culture-specific formatting information about s. If provider is null, the thread current culture is used. - Returns: An 8-bit signed integer that is equivalent to the number specified in s. - Parse(s: str, style: NumberStyles, provider: IFormatProvider) -> SByte - - Converts the string representation of a number that is in a specified style and culture-specific format to its 8-bit signed equivalent. - - s: A string that contains the number to convert. The string is interpreted by using the style specified by style. - style: A bitwise combination of the enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific formatting information about s. If provider is null, the thread current culture is used. - Returns: An 8-bit signed byte value that is equivalent to the number specified in the s parameter. - """ - pass - - def ToString(self, *__args): - # type: (self: SByte) -> str - """ - ToString(self: SByte) -> str - - Converts the numeric value of this instance to its equivalent string representation. - Returns: The string representation of the value of this instance, consisting of a negative sign if the value is negative, and a sequence of digits ranging from 0 to 9 with no leading zeroes. - ToString(self: SByte, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information. - - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance, as specified by provider. - ToString(self: SByte, format: str) -> str - - Converts the numeric value of this instance to its equivalent string representation, using the specified format. - - format: A standard or custom numeric format string. - Returns: The string representation of the value of this instance as specified by format. - ToString(self: SByte, format: str, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information. - - format: A standard or custom numeric format string. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance as specified by format and provider. - """ - pass - - @staticmethod - def TryParse(s, *__args): - # type: (s: str) -> (bool, SByte) - """ - TryParse(s: str) -> (bool, SByte) - - Tries to convert the string representation of a number to its System.SByte equivalent, and returns a value that indicates whether the conversion succeeded. - - s: A string that contains a number to convert. - Returns: true if s was converted successfully; otherwise, false. - TryParse(s: str, style: NumberStyles, provider: IFormatProvider) -> (bool, SByte) - - Tries to convert the string representation of a number in a specified style and culture-specific format to its System.SByte equivalent, and returns a value that indicates whether the conversion succeeded. - - s: A string representing a number to convert. - style: A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific formatting information about s. - Returns: true if s was converted successfully; otherwise, false. - """ - pass - - def __abs__(self, *args): #cannot find CLR method - """ x.__abs__() <==> abs(x) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __and__(self, *args): #cannot find CLR method - """ __and__(x: SByte, y: SByte) -> SByte """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/y """ - pass - - def __float__(self, *args): #cannot find CLR method - """ __float__(x: SByte) -> float """ - pass - - def __floordiv__(self, *args): #cannot find CLR method - """ x.__floordiv__(y) <==> x//y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __hex__(self, *args): #cannot find CLR method - """ __hex__(value: SByte) -> str """ - pass - - def __index__(self, *args): #cannot find CLR method - """ __index__(x: SByte) -> int """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(x: SByte) -> int """ - pass - - def __invert__(self, *args): #cannot find CLR method - """ __invert__(x: SByte) -> SByte """ - pass - - def __lshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x< x< x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*y """ - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) -> object - __new__(cls: type, value: object) -> object - """ - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(x: SByte) -> bool """ - pass - - def __or__(self, *args): #cannot find CLR method - """ __or__(x: SByte, y: SByte) -> SByte """ - pass - - def __pos__(self, *args): #cannot find CLR method - """ __pos__(x: SByte) -> SByte """ - pass - - def __pow__(self, *args): #cannot find CLR method - """ x.__pow__(y[, z]) <==> pow(x, y[, z]) """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ __radd__(x: SByte, y: SByte) -> object """ - pass - - def __rand__(self, *args): #cannot find CLR method - """ __rand__(x: SByte, y: SByte) -> SByte """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ __rdiv__(x: SByte, y: SByte) -> object """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(x: SByte) -> str """ - pass - - def __rfloordiv__(self, *args): #cannot find CLR method - """ __rfloordiv__(x: SByte, y: SByte) -> object """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ __rmod__(x: SByte, y: SByte) -> SByte """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ __rmul__(x: SByte, y: SByte) -> object """ - pass - - def __ror__(self, *args): #cannot find CLR method - """ __ror__(x: SByte, y: SByte) -> SByte """ - pass - - def __rpow__(self, *args): #cannot find CLR method - """ __rpow__(x: SByte, y: SByte) -> object """ - pass - - def __rshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x>>yx.__rshift__(y) <==> x>>y """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ __rsub__(x: SByte, y: SByte) -> object """ - pass - - def __rtruediv__(self, *args): #cannot find CLR method - """ __rtruediv__(x: SByte, y: SByte) -> float """ - pass - - def __rxor__(self, *args): #cannot find CLR method - """ __rxor__(x: SByte, y: SByte) -> SByte """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - def __truediv__(self, *args): #cannot find CLR method - """ x.__truediv__(y) <==> x/y """ - pass - - def __trunc__(self, *args): #cannot find CLR method - """ __trunc__(x: SByte) -> SByte """ - pass - - def __xor__(self, *args): #cannot find CLR method - """ __xor__(x: SByte, y: SByte) -> SByte """ - pass - - denominator = None - imag = None - MaxValue = None - MinValue = None - numerator = None - real = None - - -class SerializableAttribute(Attribute, _Attribute): - """ - Indicates that a class can be serialized. This class cannot be inherited. - - SerializableAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class Single(object, IComparable, IFormattable, IConvertible, IComparable[Single], IEquatable[Single]): - """ Represents a single-precision floating-point number. """ - def CompareTo(self, value): - # type: (self: Single, value: object) -> int - """ - CompareTo(self: Single, value: object) -> int - - Compares this instance to a specified object and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified object. - - value: An object to compare, or null. - Returns: A signed number indicating the relative values of this instance and value.Return Value Description Less than zero This instance is less than value.-or- This instance is not a number (System.Single.NaN) and value is a number. Zero This instance is - equal to value.-or- This instance and value are both not a number (System.Single.NaN), System.Single.PositiveInfinity, or System.Single.NegativeInfinity. Greater than zero This instance is greater than value.-or- This instance is a number and value is - not a number (System.Single.NaN).-or- value is null. - - CompareTo(self: Single, value: Single) -> int - - Compares this instance to a specified single-precision floating-point number and returns an integer that indicates whether the value of this instance is less than, equal to, or greater than the value of the specified single-precision floating-point - number. - - - value: A single-precision floating-point number to compare. - Returns: A signed number indicating the relative values of this instance and value.Return Value Description Less than zero This instance is less than value.-or- This instance is not a number (System.Single.NaN) and value is a number. Zero This instance is - equal to value.-or- Both this instance and value are not a number (System.Single.NaN), System.Single.PositiveInfinity, or System.Single.NegativeInfinity. Greater than zero This instance is greater than value.-or- This instance is a number and value is - not a number (System.Single.NaN). - """ - pass - - def conjugate(self, *args): #cannot find CLR method - # type: (x: Single) -> Single - """ conjugate(x: Single) -> Single """ - pass - - def Equals(self, obj): - # type: (self: Single, obj: object) -> bool - """ - Equals(self: Single, obj: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - obj: An object to compare with this instance. - Returns: true if obj is an instance of System.Single and equals the value of this instance; otherwise, false. - Equals(self: Single, obj: Single) -> bool - - Returns a value indicating whether this instance and a specified System.Single object represent the same value. - - obj: An object to compare with this instance. - Returns: true if obj is equal to this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: Single) -> int - """ - GetHashCode(self: Single) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetTypeCode(self): - # type: (self: Single) -> TypeCode - """ - GetTypeCode(self: Single) -> TypeCode - - Returns the System.TypeCode for value type System.Single. - Returns: The enumerated constant, System.TypeCode.Single. - """ - pass - - @staticmethod - def IsInfinity(f): - # type: (f: Single) -> bool - """ - IsInfinity(f: Single) -> bool - - Returns a value indicating whether the specified number evaluates to negative or positive infinity. - - f: A single-precision floating-point number. - Returns: true if f evaluates to System.Single.PositiveInfinity or System.Single.NegativeInfinity; otherwise, false. - """ - pass - - @staticmethod - def IsNaN(f): - # type: (f: Single) -> bool - """ - IsNaN(f: Single) -> bool - - Returns a value indicating whether the specified number evaluates to not a number (System.Single.NaN). - - f: A single-precision floating-point number. - Returns: true if f evaluates to not a number (System.Single.NaN); otherwise, false. - """ - pass - - @staticmethod - def IsNegativeInfinity(f): - # type: (f: Single) -> bool - """ - IsNegativeInfinity(f: Single) -> bool - - Returns a value indicating whether the specified number evaluates to negative infinity. - - f: A single-precision floating-point number. - Returns: true if f evaluates to System.Single.NegativeInfinity; otherwise, false. - """ - pass - - @staticmethod - def IsPositiveInfinity(f): - # type: (f: Single) -> bool - """ - IsPositiveInfinity(f: Single) -> bool - - Returns a value indicating whether the specified number evaluates to positive infinity. - - f: A single-precision floating-point number. - Returns: true if f evaluates to System.Single.PositiveInfinity; otherwise, false. - """ - pass - - @staticmethod - def Parse(s, *__args): - # type: (s: str) -> Single - """ - Parse(s: str) -> Single - - Converts the string representation of a number to its single-precision floating-point number equivalent. - - s: A string that contains a number to convert. - Returns: A single-precision floating-point number equivalent to the numeric value or symbol specified in s. - Parse(s: str, style: NumberStyles) -> Single - - Converts the string representation of a number in a specified style to its single-precision floating-point number equivalent. - - s: A string that contains a number to convert. - style: A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Float combined with System.Globalization.NumberStyles.AllowThousands. - Returns: A single-precision floating-point number that is equivalent to the numeric value or symbol specified in s. - Parse(s: str, provider: IFormatProvider) -> Single - - Converts the string representation of a number in a specified culture-specific format to its single-precision floating-point number equivalent. - - s: A string that contains a number to convert. - provider: An object that supplies culture-specific formatting information about s. - Returns: A single-precision floating-point number equivalent to the numeric value or symbol specified in s. - Parse(s: str, style: NumberStyles, provider: IFormatProvider) -> Single - - Converts the string representation of a number in a specified style and culture-specific format to its single-precision floating-point number equivalent. - - s: A string that contains a number to convert. - style: A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Float combined with System.Globalization.NumberStyles.AllowThousands. - provider: An object that supplies culture-specific formatting information about s. - Returns: A single-precision floating-point number equivalent to the numeric value or symbol specified in s. - """ - pass - - def ToString(self, *__args): - # type: (self: Single) -> str - """ - ToString(self: Single) -> str - - Converts the numeric value of this instance to its equivalent string representation. - Returns: The string representation of the value of this instance. - ToString(self: Single, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information. - - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance as specified by provider. - ToString(self: Single, format: str) -> str - - Converts the numeric value of this instance to its equivalent string representation, using the specified format. - - format: A numeric format string. - Returns: The string representation of the value of this instance as specified by format. - ToString(self: Single, format: str, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information. - - format: A numeric format string. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance as specified by format and provider. - """ - pass - - @staticmethod - def TryParse(s, *__args): - # type: (s: str) -> (bool, Single) - """ - TryParse(s: str) -> (bool, Single) - - Converts the string representation of a number to its single-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string representing a number to convert. - Returns: true if s was converted successfully; otherwise, false. - TryParse(s: str, style: NumberStyles, provider: IFormatProvider) -> (bool, Single) - - Converts the string representation of a number in a specified style and culture-specific format to its single-precision floating-point number equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string representing a number to convert. - style: A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Float combined with System.Globalization.NumberStyles.AllowThousands. - provider: An object that supplies culture-specific formatting information about s. - Returns: true if s was converted successfully; otherwise, false. - """ - pass - - def __abs__(self, *args): #cannot find CLR method - """ x.__abs__() <==> abs(x) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/y """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __float__(self, *args): #cannot find CLR method - """ __float__(x: Single) -> float """ - pass - - def __floordiv__(self, *args): #cannot find CLR method - """ x.__floordiv__(y) <==> x//y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(self: Single, formatSpec: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(x: Single) -> int """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __mod__(self, *args): #cannot find CLR method - """ x.__mod__(y) <==> x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*y """ - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) -> object - __new__(cls: type, x: object) -> object - __new__(cls: type, s: IList[Byte]) -> object - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(x: Single) -> bool """ - pass - - def __pos__(self, *args): #cannot find CLR method - """ __pos__(x: Single) -> Single """ - pass - - def __pow__(self, *args): #cannot find CLR method - """ x.__pow__(y[, z]) <==> pow(x, y[, z]) """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ __radd__(x: Single, y: Single) -> Single """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ __rdiv__(x: Single, y: Single) -> Single """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: Single) -> str """ - pass - - def __rfloordiv__(self, *args): #cannot find CLR method - """ __rfloordiv__(x: Single, y: Single) -> Single """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ __rmod__(x: Single, y: Single) -> Single """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ __rmul__(x: Single, y: Single) -> Single """ - pass - - def __rpow__(self, *args): #cannot find CLR method - """ __rpow__(x: Single, y: Single) -> Single """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ __rsub__(x: Single, y: Single) -> Single """ - pass - - def __rtruediv__(self, *args): #cannot find CLR method - """ __rtruediv__(x: Single, y: Single) -> Single """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - def __truediv__(self, *args): #cannot find CLR method - """ x.__truediv__(y) <==> x/y """ - pass - - def __trunc__(self, *args): #cannot find CLR method - """ __trunc__(x: Single) -> object """ - pass - - Epsilon = None - imag = None - MaxValue = None - MinValue = None - NaN = None - NegativeInfinity = None - PositiveInfinity = None - real = None - - -class StackOverflowException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when the execution stack overflows because it contains too many nested method calls. This class cannot be inherited. - - StackOverflowException() - StackOverflowException(message: str) - StackOverflowException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class STAThreadAttribute(Attribute, _Attribute): - # type: (STA). - """ - Indicates that the COM threading model for an application is single-threaded apartment (STA). - - STAThreadAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class String(object): - """ - Represents text as a series of Unicode characters. - - str(value: Char*) - str(value: Char*, startIndex: int, length: int) - str(value: SByte*) - str(value: SByte*, startIndex: int, length: int) - str(value: SByte*, startIndex: int, length: int, enc: Encoding) - str(value: Array[Char], startIndex: int, length: int) - str(value: Array[Char]) - str(c: Char, count: int) - """ - def capitalize(self, *args): #cannot find CLR method - # type: (self: str) -> str - """ capitalize(self: str) -> str """ - pass - - def center(self, *args): #cannot find CLR method - # type: (self: str, width: int) -> str - """ - center(self: str, width: int) -> str - center(self: str, width: int, fillchar: Char) -> str - """ - pass - - def count(self, *args): #cannot find CLR method - # type: (self: str, sub: str) -> int - """ - count(self: str, sub: str) -> int - count(self: str, sub: str, start: int) -> int - count(self: str, ssub: str, start: int, end: int) -> int - """ - pass - - def decode(self, *args): #cannot find CLR method - # type: (s: str) -> str - """ - decode(s: str) -> str - decode(s: str, encoding: object, errors: str) -> str - """ - pass - - def encode(self, *args): #cannot find CLR method - # type: (s: str, encoding: object, errors: str) -> str - """ encode(s: str, encoding: object, errors: str) -> str """ - pass - - def endswith(self, *args): #cannot find CLR method - # type: (self: str, suffix: object) -> bool - """ - endswith(self: str, suffix: object) -> bool - endswith(self: str, suffix: object, start: int) -> bool - endswith(self: str, suffix: object, start: int, end: int) -> bool - endswith(self: str, suffix: str) -> bool - endswith(self: str, suffix: str, start: int) -> bool - endswith(self: str, suffix: str, start: int, end: int) -> bool - """ - pass - - def expandtabs(self, *args): #cannot find CLR method - # type: (self: str) -> str - """ - expandtabs(self: str) -> str - expandtabs(self: str, tabsize: int) -> str - """ - pass - - def find(self, *args): #cannot find CLR method - # type: (self: str, sub: str) -> int - """ - find(self: str, sub: str) -> int - find(self: str, sub: str, start: int) -> int - find(self: str, sub: str, start: long) -> int - find(self: str, sub: str, start: int, end: int) -> int - find(self: str, sub: str, start: long, end: long) -> int - find(self: str, sub: str, start: object, end: object) -> int - """ - pass - - def format(self, *args): #cannot find CLR method - # type: (format_string: str, *args: Array[object]) -> str - """ - format(format_string: str, *args: Array[object]) -> str - format(format_string�: str, **kwargs�: dict, *args�: Array[object]) -> str - """ - pass - - def index(self, *args): #cannot find CLR method - # type: (self: str, sub: str) -> int - """ - index(self: str, sub: str) -> int - index(self: str, sub: str, start: int) -> int - index(self: str, sub: str, start: int, end: int) -> int - index(self: str, sub: str, start: object, end: object) -> int - """ - pass - - def isalnum(self, *args): #cannot find CLR method - # type: (self: str) -> bool - """ isalnum(self: str) -> bool """ - pass - - def isalpha(self, *args): #cannot find CLR method - # type: (self: str) -> bool - """ isalpha(self: str) -> bool """ - pass - - def isdecimal(self, *args): #cannot find CLR method - # type: (self: str) -> bool - """ isdecimal(self: str) -> bool """ - pass - - def isdigit(self, *args): #cannot find CLR method - # type: (self: str) -> bool - """ isdigit(self: str) -> bool """ - pass - - def islower(self, *args): #cannot find CLR method - # type: (self: str) -> bool - """ islower(self: str) -> bool """ - pass - - def isnumeric(self, *args): #cannot find CLR method - # type: (self: str) -> bool - """ isnumeric(self: str) -> bool """ - pass - - def isspace(self, *args): #cannot find CLR method - # type: (self: str) -> bool - """ isspace(self: str) -> bool """ - pass - - def istitle(self, *args): #cannot find CLR method - # type: (self: str) -> bool - """ istitle(self: str) -> bool """ - pass - - def isunicode(self, *args): #cannot find CLR method - # type: (self: str) -> bool - """ isunicode(self: str) -> bool """ - pass - - def isupper(self, *args): #cannot find CLR method - # type: (self: str) -> bool - """ isupper(self: str) -> bool """ - pass - - def join(self, *args): #cannot find CLR method - # type: (self: str, sequence: object) -> str - """ - join(self: str, sequence: object) -> str - join(self: str, sequence: list) -> str - """ - pass - - def ljust(self, *args): #cannot find CLR method - # type: (self: str, width: int) -> str - """ - ljust(self: str, width: int) -> str - ljust(self: str, width: int, fillchar: Char) -> str - """ - pass - - def lower(self, *args): #cannot find CLR method - # type: (self: str) -> str - """ lower(self: str) -> str """ - pass - - def lstrip(self, *args): #cannot find CLR method - # type: (self: str) -> str - """ - lstrip(self: str) -> str - lstrip(self: str, chars: str) -> str - """ - pass - - def partition(self, *args): #cannot find CLR method - # type: (self: str, sep: str) -> tuple (of str) - """ partition(self: str, sep: str) -> tuple (of str) """ - pass - - def replace(self, *args): #cannot find CLR method - # type: (self: str, old: str, new: str, count: int) -> str - """ replace(self: str, old: str, new: str, count: int) -> str """ - pass - - def rfind(self, *args): #cannot find CLR method - # type: (self: str, sub: str) -> int - """ - rfind(self: str, sub: str) -> int - rfind(self: str, sub: str, start: int) -> int - rfind(self: str, sub: str, start: long) -> int - rfind(self: str, sub: str, start: int, end: int) -> int - rfind(self: str, sub: str, start: long, end: long) -> int - rfind(self: str, sub: str, start: object, end: object) -> int - """ - pass - - def rindex(self, *args): #cannot find CLR method - # type: (self: str, sub: str) -> int - """ - rindex(self: str, sub: str) -> int - rindex(self: str, sub: str, start: int) -> int - rindex(self: str, sub: str, start: int, end: int) -> int - rindex(self: str, sub: str, start: object, end: object) -> int - """ - pass - - def rjust(self, *args): #cannot find CLR method - # type: (self: str, width: int) -> str - """ - rjust(self: str, width: int) -> str - rjust(self: str, width: int, fillchar: Char) -> str - """ - pass - - def rpartition(self, *args): #cannot find CLR method - # type: (self: str, sep: str) -> tuple (of str) - """ rpartition(self: str, sep: str) -> tuple (of str) """ - pass - - def rsplit(self, *args): #cannot find CLR method - # type: (self: str) -> list - """ - rsplit(self: str) -> list - rsplit(self: str, sep: str) -> list - rsplit(self: str, sep: str, maxsplit: int) -> list - """ - pass - - def rstrip(self, *args): #cannot find CLR method - # type: (self: str) -> str - """ - rstrip(self: str) -> str - rstrip(self: str, chars: str) -> str - """ - pass - - def split(self, *args): #cannot find CLR method - # type: (self: str) -> list - """ - split(self: str) -> list - split(self: str, sep: str) -> list - split(self: str, sep: str, maxsplit: int) -> list - """ - pass - - def splitlines(self, *args): #cannot find CLR method - # type: (self: str) -> list - """ - splitlines(self: str) -> list - splitlines(self: str, keepends: bool) -> list - """ - pass - - def startswith(self, *args): #cannot find CLR method - # type: (self: str, prefix: object) -> bool - """ - startswith(self: str, prefix: object) -> bool - startswith(self: str, prefix: object, start: int) -> bool - startswith(self: str, prefix: object, start: int, end: int) -> bool - startswith(self: str, prefix: str) -> bool - startswith(self: str, prefix: str, start: int) -> bool - startswith(self: str, prefix: str, start: int, end: int) -> bool - """ - pass - - def strip(self, *args): #cannot find CLR method - # type: (self: str) -> str - """ - strip(self: str) -> str - strip(self: str, chars: str) -> str - """ - pass - - def swapcase(self, *args): #cannot find CLR method - # type: (self: str) -> str - """ swapcase(self: str) -> str """ - pass - - def title(self, *args): #cannot find CLR method - # type: (self: str) -> str - """ title(self: str) -> str """ - pass - - def translate(self, *args): #cannot find CLR method - # type: (self: str, table: dict) -> str - """ - translate(self: str, table: dict) -> str - translate(self: str, table: str) -> str - translate(self: str, table: str, deletechars: str) -> str - """ - pass - - def upper(self, *args): #cannot find CLR method - # type: (self: str) -> str - """ upper(self: str) -> str """ - pass - - def zfill(self, *args): #cannot find CLR method - # type: (self: str, width: int) -> str - """ zfill(self: str, width: int) -> str """ - pass - - def _formatter_field_name_split(self, *args): #cannot find CLR method - # type: (self: str) -> tuple - """ _formatter_field_name_split(self: str) -> tuple """ - pass - - def _formatter_parser(self, *args): #cannot find CLR method - # type: (self: str) -> IEnumerable[tuple] - """ _formatter_parser(self: str) -> IEnumerable[tuple] """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+yx.__add__(y) <==> x+y """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ - __contains__(s: str, item: str) -> bool - __contains__(s: str, item: Char) -> bool - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y]x.__getitem__(y) <==> x[y]x.__getitem__(y) <==> x[y] """ - pass - - def __getnewargs__(self, *args): #cannot find CLR method - """ __getnewargs__(self: str) -> object """ - pass - - def __getslice__(self, *args): #cannot find CLR method - """ __getslice__(self: str, x: int, y: int) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __len__(self, *args): #cannot find CLR method - """ x.__len__() <==> len(x) """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __mod__(self, *args): #cannot find CLR method - """ x.__mod__(y) <==> x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*yx.__mul__(y) <==> x*yx.__mul__(y) <==> x*y """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) -> object - __new__(cls: type, object: object) -> object - __new__(cls: type, object: str) -> object - __new__(cls: type, object: ExtensibleString) -> object - __new__(cls: type, object: Char) -> object - __new__(cls: type, object: long) -> object - __new__(cls: type, object: Extensible[long]) -> object - __new__(cls: type, object: int) -> object - __new__(cls: type, object: bool) -> object - __new__(cls: type, object: float) -> object - __new__(cls: type, object: Extensible[float]) -> object - __new__(cls: type, object: Single) -> object - __new__(cls: type, string: object, encoding: str, errors: str) -> object - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __radd__(self, *args): #cannot find CLR method - """ - __radd__(self: str, other: str) -> str - __radd__(self: Char, other: str) -> str - """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ __rmod__(other: object, self: str) -> object """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ - __rmul__(other: int, self: str) -> str - __rmul__(count: Index, self: str) -> object - __rmul__(count: object, self: str) -> object - """ - pass - - -class StringComparer(object, IComparer, IEqualityComparer, IComparer[str], IEqualityComparer[str]): - """ Represents a string comparison operation that uses specific case and culture-based or ordinal comparison rules. """ - def Compare(self, x, y): - # type: (self: StringComparer, x: object, y: object) -> int - """ - Compare(self: StringComparer, x: object, y: object) -> int - - When overridden in a derived class, compares two objects and returns an indication of their relative sort order. - - x: An object to compare to y. - y: An object to compare to x. - Returns: A signed integer that indicates the relative values of x and y, as shown in the following table.ValueMeaningLess than zerox is less than y. -or-x is null.Zerox is equal to y.Greater than zerox is greater than y.-or-y is null. - Compare(self: StringComparer, x: str, y: str) -> int - - When overridden in a derived class, compares two strings and returns an indication of their relative sort order. - - x: A string to compare to y. - y: A string to compare to x. - Returns: A signed integer that indicates the relative values of x and y, as shown in the following table.ValueMeaningLess than zerox is less than y.-or-x is null.Zerox is equal to y.Greater than zerox is greater than y.-or-y is null. - """ - pass - - @staticmethod - def Create(culture, ignoreCase): - # type: (culture: CultureInfo, ignoreCase: bool) -> StringComparer - """ - Create(culture: CultureInfo, ignoreCase: bool) -> StringComparer - - Creates a System.StringComparer object that compares strings according to the rules of a specified culture. - - culture: A culture whose linguistic rules are used to perform a string comparison. - ignoreCase: true to specify that comparison operations be case-insensitive; false to specify that comparison operations be case-sensitive. - Returns: A new System.StringComparer object that performs string comparisons according to the comparison rules used by the culture parameter and the case rule specified by the ignoreCase parameter. - """ - pass - - def Equals(self, *__args): - # type: (self: StringComparer, x: object, y: object) -> bool - """ - Equals(self: StringComparer, x: object, y: object) -> bool - - When overridden in a derived class, indicates whether two objects are equal. - - x: An object to compare to y. - y: An object to compare to x. - Returns: true if x and y refer to the same object, or x and y are both the same type of object and those objects are equal; otherwise, false. - Equals(self: StringComparer, x: str, y: str) -> bool - - When overridden in a derived class, indicates whether two strings are equal. - - x: A string to compare to y. - y: A string to compare to x. - Returns: true if x and y refer to the same object, or x and y are equal; otherwise, false. - """ - pass - - def GetHashCode(self, obj=None): - # type: (self: StringComparer, obj: object) -> int - """ - GetHashCode(self: StringComparer, obj: object) -> int - - When overridden in a derived class, gets the hash code for the specified object. - - obj: An object. - Returns: A 32-bit signed hash code calculated from the value of the obj parameter. - GetHashCode(self: StringComparer, obj: str) -> int - - When overridden in a derived class, gets the hash code for the specified string. - - obj: A string. - Returns: A 32-bit signed hash code calculated from the value of the obj parameter. - """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y)x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - CurrentCulture = None - CurrentCultureIgnoreCase = None - InvariantCulture = None - InvariantCultureIgnoreCase = None - Ordinal = None - OrdinalIgnoreCase = None - - -class StringComparison(Enum, IComparable, IFormattable, IConvertible): - # type: (System.String,System.String) and System.String.Equals(System.Object) methods. - """ - Specifies the culture, case, and sort rules to be used by certain overloads of the System.String.Compare(System.String,System.String) and System.String.Equals(System.Object) methods. - - enum StringComparison, values: CurrentCulture (0), CurrentCultureIgnoreCase (1), InvariantCulture (2), InvariantCultureIgnoreCase (3), Ordinal (4), OrdinalIgnoreCase (5) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CurrentCulture = None - CurrentCultureIgnoreCase = None - InvariantCulture = None - InvariantCultureIgnoreCase = None - Ordinal = None - OrdinalIgnoreCase = None - value__ = None - - -class StringNormalizationExtensions(object): - # no doc - @staticmethod - def IsNormalized(value, normalizationForm=None): - # type: (value: str) -> bool - """ - IsNormalized(value: str) -> bool - IsNormalized(value: str, normalizationForm: NormalizationForm) -> bool - """ - pass - - @staticmethod - def Normalize(value, normalizationForm=None): - # type: (value: str) -> str - """ - Normalize(value: str) -> str - Normalize(value: str, normalizationForm: NormalizationForm) -> str - """ - pass - - __all__ = [ - 'IsNormalized', - 'Normalize', - ] - - -class StringSplitOptions(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies whether applicable erload:System.String.Split method overloads include or omit empty substrings from the return value. - - enum (flags) StringSplitOptions, values: None (0), RemoveEmptyEntries (1) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - None = None - RemoveEmptyEntries = None - value__ = None - - -class ThreadStaticAttribute(Attribute, _Attribute): - """ - Indicates that the value of a static field is unique for each thread. - - ThreadStaticAttribute() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class TimeoutException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when the time allotted for a process or operation has expired. - - TimeoutException() - TimeoutException(message: str) - TimeoutException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class TimeSpan(object, IComparable, IComparable[TimeSpan], IEquatable[TimeSpan], IFormattable): - """ - Represents a time interval. - - TimeSpan(ticks: Int64) - TimeSpan(hours: int, minutes: int, seconds: int) - TimeSpan(days: int, hours: int, minutes: int, seconds: int) - TimeSpan(days: int, hours: int, minutes: int, seconds: int, milliseconds: int) - """ - def Add(self, ts): - # type: (self: TimeSpan, ts: TimeSpan) -> TimeSpan - """ - Add(self: TimeSpan, ts: TimeSpan) -> TimeSpan - - Returns a new System.TimeSpan object whose value is the sum of the specified System.TimeSpan object and this instance. - - ts: The time interval to add. - Returns: A new object that represents the value of this instance plus the value of ts. - """ - pass - - @staticmethod - def Compare(t1, t2): - # type: (t1: TimeSpan, t2: TimeSpan) -> int - """ - Compare(t1: TimeSpan, t2: TimeSpan) -> int - - Compares two System.TimeSpan values and returns an integer that indicates whether the first value is shorter than, equal to, or longer than the second value. - - t1: The first time interval to compare. - t2: The second time interval to compare. - Returns: One of the following values.Value Description -1 t1 is shorter than t2. 0 t1 is equal to t2. 1 t1 is longer than t2. - """ - pass - - def CompareTo(self, value): - # type: (self: TimeSpan, value: object) -> int - """ - CompareTo(self: TimeSpan, value: object) -> int - - Compares this instance to a specified object and returns an integer that indicates whether this instance is shorter than, equal to, or longer than the specified object. - - value: An object to compare, or null. - Returns: One of the following values.Value Description -1 This instance is shorter than value. 0 This instance is equal to value. 1 This instance is longer than value.-or- value is null. - CompareTo(self: TimeSpan, value: TimeSpan) -> int - - Compares this instance to a specified System.TimeSpan object and returns an integer that indicates whether this instance is shorter than, equal to, or longer than the System.TimeSpan object. - - value: An object to compare to this instance. - Returns: A signed number indicating the relative values of this instance and value.Value Description A negative integer This instance is shorter than value. Zero This instance is equal to value. A positive integer This instance is longer than value. - """ - pass - - def Duration(self): - # type: (self: TimeSpan) -> TimeSpan - """ - Duration(self: TimeSpan) -> TimeSpan - - Returns a new System.TimeSpan object whose value is the absolute value of the current System.TimeSpan object. - Returns: A new object whose value is the absolute value of the current System.TimeSpan object. - """ - pass - - def Equals(self, *__args): - # type: (self: TimeSpan, value: object) -> bool - """ - Equals(self: TimeSpan, value: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - value: An object to compare with this instance. - Returns: true if value is a System.TimeSpan object that represents the same time interval as the current System.TimeSpan structure; otherwise, false. - Equals(self: TimeSpan, obj: TimeSpan) -> bool - - Returns a value indicating whether this instance is equal to a specified System.TimeSpan object. - - obj: An object to compare with this instance. - Returns: true if obj represents the same time interval as this instance; otherwise, false. - Equals(t1: TimeSpan, t2: TimeSpan) -> bool - - Returns a value that indicates whether two specified instances of System.TimeSpan are equal. - - t1: The first time interval to compare. - t2: The second time interval to compare. - Returns: true if the values of t1 and t2 are equal; otherwise, false. - """ - pass - - @staticmethod - def FromDays(value): - # type: (value: float) -> TimeSpan - """ - FromDays(value: float) -> TimeSpan - - Returns a System.TimeSpan that represents a specified number of days, where the specification is accurate to the nearest millisecond. - - value: A number of days, accurate to the nearest millisecond. - Returns: An object that represents value. - """ - pass - - @staticmethod - def FromHours(value): - # type: (value: float) -> TimeSpan - """ - FromHours(value: float) -> TimeSpan - - Returns a System.TimeSpan that represents a specified number of hours, where the specification is accurate to the nearest millisecond. - - value: A number of hours accurate to the nearest millisecond. - Returns: An object that represents value. - """ - pass - - @staticmethod - def FromMilliseconds(value): - # type: (value: float) -> TimeSpan - """ - FromMilliseconds(value: float) -> TimeSpan - - Returns a System.TimeSpan that represents a specified number of milliseconds. - - value: A number of milliseconds. - Returns: An object that represents value. - """ - pass - - @staticmethod - def FromMinutes(value): - # type: (value: float) -> TimeSpan - """ - FromMinutes(value: float) -> TimeSpan - - Returns a System.TimeSpan that represents a specified number of minutes, where the specification is accurate to the nearest millisecond. - - value: A number of minutes, accurate to the nearest millisecond. - Returns: An object that represents value. - """ - pass - - @staticmethod - def FromSeconds(value): - # type: (value: float) -> TimeSpan - """ - FromSeconds(value: float) -> TimeSpan - - Returns a System.TimeSpan that represents a specified number of seconds, where the specification is accurate to the nearest millisecond. - - value: A number of seconds, accurate to the nearest millisecond. - Returns: An object that represents value. - """ - pass - - @staticmethod - def FromTicks(value): - # type: (value: Int64) -> TimeSpan - """ - FromTicks(value: Int64) -> TimeSpan - - Returns a System.TimeSpan that represents a specified time, where the specification is in units of ticks. - - value: A number of ticks that represent a time. - Returns: An object that represents value. - """ - pass - - def GetHashCode(self): - # type: (self: TimeSpan) -> int - """ - GetHashCode(self: TimeSpan) -> int - - Returns a hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def Negate(self): - # type: (self: TimeSpan) -> TimeSpan - """ - Negate(self: TimeSpan) -> TimeSpan - - Returns a new System.TimeSpan object whose value is the negated value of this instance. - Returns: A new object with the same numeric value as this instance, but with the opposite sign. - """ - pass - - @staticmethod - def Parse(*__args): - # type: (s: str) -> TimeSpan - """ - Parse(s: str) -> TimeSpan - - Converts the string representation of a time interval to its System.TimeSpan equivalent. - - s: A string that specifies the time interval to convert. - Returns: A time interval that corresponds to s. - Parse(input: str, formatProvider: IFormatProvider) -> TimeSpan - - Converts the string representation of a time interval to its System.TimeSpan equivalent by using the specified culture-specific format information. - - input: A string that specifies the time interval to convert. - formatProvider: An object that supplies culture-specific formatting information. - Returns: A time interval that corresponds to input, as specified by formatProvider. - """ - pass - - @staticmethod - def ParseExact(input, *__args): - # type: (input: str, format: str, formatProvider: IFormatProvider) -> TimeSpan - """ - ParseExact(input: str, format: str, formatProvider: IFormatProvider) -> TimeSpan - - Converts the string representation of a time interval to its System.TimeSpan equivalent by using the specified format and culture-specific format information. The format of the string representation must match the specified format exactly. - - input: A string that specifies the time interval to convert. - format: A standard or custom format string that defines the required format of input. - formatProvider: An object that provides culture-specific formatting information. - Returns: A time interval that corresponds to input, as specified by format and formatProvider. - ParseExact(input: str, formats: Array[str], formatProvider: IFormatProvider) -> TimeSpan - - Converts the string representation of a time interval to its System.TimeSpan equivalent by using the specified array of format strings and culture-specific format information. The format of the string representation must match one of the specified - formats exactly. - - - input: A string that specifies the time interval to convert. - formats: A array of standard or custom format strings that defines the required format of input. - formatProvider: An object that provides culture-specific formatting information. - Returns: A time interval that corresponds to input, as specified by formats and formatProvider. - ParseExact(input: str, format: str, formatProvider: IFormatProvider, styles: TimeSpanStyles) -> TimeSpan - - Converts the string representation of a time interval to its System.TimeSpan equivalent by using the specified format, culture-specific format information, and styles. The format of the string representation must match the specified format exactly. - - input: A string that specifies the time interval to convert. - format: A standard or custom format string that defines the required format of input. - formatProvider: An object that provides culture-specific formatting information. - styles: A bitwise combination of enumeration values that defines the style elements that may be present in input. - Returns: A time interval that corresponds to input, as specified by format, formatProvider, and styles. - ParseExact(input: str, formats: Array[str], formatProvider: IFormatProvider, styles: TimeSpanStyles) -> TimeSpan - - Converts the string representation of a time interval to its System.TimeSpan equivalent by using the specified formats, culture-specific format information, and styles. The format of the string representation must match one of the specified formats - exactly. - - - input: A string that specifies the time interval to convert. - formats: A array of standard or custom format strings that define the required format of input. - formatProvider: An object that provides culture-specific formatting information. - styles: A bitwise combination of enumeration values that defines the style elements that may be present in input. - Returns: A time interval that corresponds to input, as specified by formats, formatProvider, and styles. - """ - pass - - def Subtract(self, ts): - # type: (self: TimeSpan, ts: TimeSpan) -> TimeSpan - """ - Subtract(self: TimeSpan, ts: TimeSpan) -> TimeSpan - - Returns a new System.TimeSpan object whose value is the difference between the specified System.TimeSpan object and this instance. - - ts: The time interval to be subtracted. - Returns: A new time interval whose value is the result of the value of this instance minus the value of ts. - """ - pass - - def ToString(self, format=None, formatProvider=None): - # type: (self: TimeSpan) -> str - """ - ToString(self: TimeSpan) -> str - - Converts the value of the current System.TimeSpan object to its equivalent string representation. - Returns: The string representation of the current System.TimeSpan value. - ToString(self: TimeSpan, format: str) -> str - - Converts the value of the current System.TimeSpan object to its equivalent string representation by using the specified format. - - format: A standard or custom System.TimeSpan format string. - Returns: The string representation of the current System.TimeSpan value in the format specified by the format parameter. - ToString(self: TimeSpan, format: str, formatProvider: IFormatProvider) -> str - - Converts the value of the current System.TimeSpan object to its equivalent string representation by using the specified format and culture-specific formatting information. - - format: A standard or custom System.TimeSpan format string. - formatProvider: An object that supplies culture-specific formatting information. - Returns: The string representation of the current System.TimeSpan value, as specified by format and formatProvider. - """ - pass - - @staticmethod - def TryParse(*__args): - # type: (s: str) -> (bool, TimeSpan) - """ - TryParse(s: str) -> (bool, TimeSpan) - - Converts the string representation of a time interval to its System.TimeSpan equivalent and returns a value that indicates whether the conversion succeeded. - - s: A string that specifies the time interval to convert. - Returns: true if s was converted successfully; otherwise, false. This operation returns false if the s parameter is null or System.String.Empty, has an invalid format, represents a time interval that is less than System.TimeSpan.MinValue or greater than - System.TimeSpan.MaxValue, or has at least one days, hours, minutes, or seconds component outside its valid range. - - TryParse(input: str, formatProvider: IFormatProvider) -> (bool, TimeSpan) - - Converts the string representation of a time interval to its System.TimeSpan equivalent by using the specified culture-specific formatting information, and returns a value that indicates whether the conversion succeeded. - - input: A string that specifies the time interval to convert. - formatProvider: An object that supplies culture-specific formatting information. - Returns: true if input was converted successfully; otherwise, false. This operation returns false if the input parameter is null or System.String.Empty, has an invalid format, represents a time interval that is less than System.TimeSpan.MinValue or greater - than System.TimeSpan.MaxValue, or has at least one days, hours, minutes, or seconds component outside its valid range. - """ - pass - - @staticmethod - def TryParseExact(input, *__args): - # type: (input: str, format: str, formatProvider: IFormatProvider) -> (bool, TimeSpan) - """ - TryParseExact(input: str, format: str, formatProvider: IFormatProvider) -> (bool, TimeSpan) - - Converts the string representation of a time interval to its System.TimeSpan equivalent by using the specified format and culture-specific format information, and returns a value that indicates whether the conversion succeeded. The format of the - string representation must match the specified format exactly. - - - input: A string that specifies the time interval to convert. - format: A standard or custom format string that defines the required format of input. - formatProvider: An object that supplies culture-specific formatting information. - Returns: true if input was converted successfully; otherwise, false. - TryParseExact(input: str, formats: Array[str], formatProvider: IFormatProvider) -> (bool, TimeSpan) - - Converts the specified string representation of a time interval to its System.TimeSpan equivalent by using the specified formats and culture-specific format information, and returns a value that indicates whether the conversion succeeded. The format - of the string representation must match one of the specified formats exactly. - - - input: A string that specifies the time interval to convert. - formats: A array of standard or custom format strings that define the acceptable formats of input. - formatProvider: An object that provides culture-specific formatting information. - Returns: true if input was converted successfully; otherwise, false. - TryParseExact(input: str, format: str, formatProvider: IFormatProvider, styles: TimeSpanStyles) -> (bool, TimeSpan) - - Converts the string representation of a time interval to its System.TimeSpan equivalent by using the specified format, culture-specific format information, and styles, and returns a value that indicates whether the conversion succeeded. The format of - the string representation must match the specified format exactly. - - - input: A string that specifies the time interval to convert. - format: A standard or custom format string that defines the required format of input. - formatProvider: An object that provides culture-specific formatting information. - styles: One or more enumeration values that indicate the style of input. - Returns: true if input was converted successfully; otherwise, false. - TryParseExact(input: str, formats: Array[str], formatProvider: IFormatProvider, styles: TimeSpanStyles) -> (bool, TimeSpan) - - Converts the specified string representation of a time interval to its System.TimeSpan equivalent by using the specified formats, culture-specific format information, and styles, and returns a value that indicates whether the conversion succeeded. The - format of the string representation must match one of the specified formats exactly. - - - input: A string that specifies the time interval to convert. - formats: A array of standard or custom format strings that define the acceptable formats of input. - formatProvider: An object that supplies culture-specific formatting information. - styles: One or more enumeration values that indicate the style of input. - Returns: true if input was converted successfully; otherwise, false. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__[TimeSpan]() -> TimeSpan - - __new__(cls: type, ticks: Int64) - __new__(cls: type, hours: int, minutes: int, seconds: int) - __new__(cls: type, days: int, hours: int, minutes: int, seconds: int) - __new__(cls: type, days: int, hours: int, minutes: int, seconds: int, milliseconds: int) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __pos__(self, *args): #cannot find CLR method - """ - __pos__(t: TimeSpan) -> TimeSpan - - Returns the specified instance of System.TimeSpan. - - t: The time interval to return. - Returns: The time interval specified by t. - """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ - __radd__(t1: TimeSpan, t2: TimeSpan) -> TimeSpan - - Adds two specified System.TimeSpan instances. - - t1: The first time interval to add. - t2: The second time interval to add. - Returns: An object whose value is the sum of the values of t1 and t2. - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ - __rsub__(t1: TimeSpan, t2: TimeSpan) -> TimeSpan - - Subtracts a specified System.TimeSpan from another specified System.TimeSpan. - - t1: The minuend. - t2: The subtrahend. - Returns: An object whose value is the result of the value of t1 minus the value of t2. - """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - Days = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the days component of the time interval represented by the current System.TimeSpan structure. - - Get: Days(self: TimeSpan) -> int - """ - - Hours = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the hours component of the time interval represented by the current System.TimeSpan structure. - - Get: Hours(self: TimeSpan) -> int - """ - - Milliseconds = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the milliseconds component of the time interval represented by the current System.TimeSpan structure. - - Get: Milliseconds(self: TimeSpan) -> int - """ - - Minutes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the minutes component of the time interval represented by the current System.TimeSpan structure. - - Get: Minutes(self: TimeSpan) -> int - """ - - Seconds = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the seconds component of the time interval represented by the current System.TimeSpan structure. - - Get: Seconds(self: TimeSpan) -> int - """ - - Ticks = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the number of ticks that represent the value of the current System.TimeSpan structure. - - Get: Ticks(self: TimeSpan) -> Int64 - """ - - TotalDays = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the current System.TimeSpan structure expressed in whole and fractional days. - - Get: TotalDays(self: TimeSpan) -> float - """ - - TotalHours = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the current System.TimeSpan structure expressed in whole and fractional hours. - - Get: TotalHours(self: TimeSpan) -> float - """ - - TotalMilliseconds = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the current System.TimeSpan structure expressed in whole and fractional milliseconds. - - Get: TotalMilliseconds(self: TimeSpan) -> float - """ - - TotalMinutes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the current System.TimeSpan structure expressed in whole and fractional minutes. - - Get: TotalMinutes(self: TimeSpan) -> float - """ - - TotalSeconds = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the current System.TimeSpan structure expressed in whole and fractional seconds. - - Get: TotalSeconds(self: TimeSpan) -> float - """ - - - MaxValue = None - MinValue = None - TicksPerDay = None - TicksPerHour = None - TicksPerMillisecond = None - TicksPerMinute = None - TicksPerSecond = None - Zero = None - - -class TimeZone(object): - """ Represents a time zone. """ - def GetDaylightChanges(self, year): - # type: (self: TimeZone, year: int) -> DaylightTime - """ - GetDaylightChanges(self: TimeZone, year: int) -> DaylightTime - - Returns the daylight saving time period for a particular year. - - year: The year that the daylight saving time period applies to. - Returns: A System.Globalization.DaylightTime object that contains the start and end date for daylight saving time in year. - """ - pass - - def GetUtcOffset(self, time): - # type: (self: TimeZone, time: DateTime) -> TimeSpan - """ - GetUtcOffset(self: TimeZone, time: DateTime) -> TimeSpan - - Returns the Coordinated Universal Time (UTC) offset for the specified local time. - - time: A date and time value. - Returns: The Coordinated Universal Time (UTC) offset from Time. - """ - pass - - def IsDaylightSavingTime(self, time, daylightTimes=None): - # type: (self: TimeZone, time: DateTime) -> bool - """ - IsDaylightSavingTime(self: TimeZone, time: DateTime) -> bool - - Returns a value indicating whether the specified date and time is within a daylight saving time period. - - time: A date and time. - Returns: true if time is in a daylight saving time period; otherwise, false. - IsDaylightSavingTime(time: DateTime, daylightTimes: DaylightTime) -> bool - - Returns a value indicating whether the specified date and time is within the specified daylight saving time period. - - time: A date and time. - daylightTimes: A daylight saving time period. - Returns: true if time is in daylightTimes; otherwise, false. - """ - pass - - def ToLocalTime(self, time): - # type: (self: TimeZone, time: DateTime) -> DateTime - """ - ToLocalTime(self: TimeZone, time: DateTime) -> DateTime - - Returns the local time that corresponds to a specified date and time value. - - time: A Coordinated Universal Time (UTC) time. - Returns: A System.DateTime object whose value is the local time that corresponds to time. - """ - pass - - def ToUniversalTime(self, time): - # type: (self: TimeZone, time: DateTime) -> DateTime - """ - ToUniversalTime(self: TimeZone, time: DateTime) -> DateTime - - Returns the Coordinated Universal Time (UTC) that corresponds to a specified time. - - time: A date and time. - Returns: A System.DateTime object whose value is the Coordinated Universal Time (UTC) that corresponds to time. - """ - pass - - DaylightName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the daylight saving time zone name. - - Get: DaylightName(self: TimeZone) -> str - """ - - StandardName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the standard time zone name. - - Get: StandardName(self: TimeZone) -> str - """ - - - CurrentTimeZone = None - - -class TimeZoneInfo(object, IEquatable[TimeZoneInfo], ISerializable, IDeserializationCallback): - """ Represents any time zone in the world. """ - @staticmethod - def ClearCachedData(): - # type: () - """ - ClearCachedData() - Clears cached time zone data. - """ - pass - - @staticmethod - def ConvertTime(*__args): - # type: (dateTimeOffset: DateTimeOffset, destinationTimeZone: TimeZoneInfo) -> DateTimeOffset - """ - ConvertTime(dateTimeOffset: DateTimeOffset, destinationTimeZone: TimeZoneInfo) -> DateTimeOffset - - Converts a time to the time in a particular time zone. - - dateTimeOffset: The date and time to convert. - destinationTimeZone: The time zone to convert dateTime to. - Returns: The date and time in the destination time zone. - ConvertTime(dateTime: DateTime, destinationTimeZone: TimeZoneInfo) -> DateTime - - Converts a time to the time in a particular time zone. - - dateTime: The date and time to convert. - destinationTimeZone: The time zone to convert dateTime to. - Returns: The date and time in the destination time zone. - ConvertTime(dateTime: DateTime, sourceTimeZone: TimeZoneInfo, destinationTimeZone: TimeZoneInfo) -> DateTime - - Converts a time from one time zone to another. - - dateTime: The date and time to convert. - sourceTimeZone: The time zone of dateTime. - destinationTimeZone: The time zone to convert dateTime to. - Returns: The date and time in the destination time zone that corresponds to the dateTime parameter in the source time zone. - """ - pass - - @staticmethod - def ConvertTimeBySystemTimeZoneId(*__args): - # type: (dateTimeOffset: DateTimeOffset, destinationTimeZoneId: str) -> DateTimeOffset - """ - ConvertTimeBySystemTimeZoneId(dateTimeOffset: DateTimeOffset, destinationTimeZoneId: str) -> DateTimeOffset - - Converts a time to the time in another time zone based on the time zone's identifier. - - dateTimeOffset: The date and time to convert. - destinationTimeZoneId: The identifier of the destination time zone. - Returns: The date and time in the destination time zone. - ConvertTimeBySystemTimeZoneId(dateTime: DateTime, destinationTimeZoneId: str) -> DateTime - - Converts a time to the time in another time zone based on the time zone's identifier. - - dateTime: The date and time to convert. - destinationTimeZoneId: The identifier of the destination time zone. - Returns: The date and time in the destination time zone. - ConvertTimeBySystemTimeZoneId(dateTime: DateTime, sourceTimeZoneId: str, destinationTimeZoneId: str) -> DateTime - - Converts a time from one time zone to another based on time zone identifiers. - - dateTime: The date and time to convert. - sourceTimeZoneId: The identifier of the source time zone. - destinationTimeZoneId: The identifier of the destination time zone. - Returns: The date and time in the destination time zone that corresponds to the dateTime parameter in the source time zone. - """ - pass - - @staticmethod - def ConvertTimeFromUtc(dateTime, destinationTimeZone): - # type: (dateTime: DateTime, destinationTimeZone: TimeZoneInfo) -> DateTime - """ - ConvertTimeFromUtc(dateTime: DateTime, destinationTimeZone: TimeZoneInfo) -> DateTime - - Converts a Coordinated Universal Time (UTC) to the time in a specified time zone. - - dateTime: The Coordinated Universal Time (UTC). - destinationTimeZone: The time zone to convert dateTime to. - Returns: The date and time in the destination time zone. Its System.DateTime.Kind property is System.DateTimeKind.Utc if destinationTimeZone is System.TimeZoneInfo.Utc; otherwise, its System.DateTime.Kind property is System.DateTimeKind.Unspecified. - """ - pass - - @staticmethod - def ConvertTimeToUtc(dateTime, sourceTimeZone=None): - # type: (dateTime: DateTime) -> DateTime - """ - ConvertTimeToUtc(dateTime: DateTime) -> DateTime - - Converts the current date and time to Coordinated Universal Time (UTC). - - dateTime: The date and time to convert. - Returns: The Coordinated Universal Time (UTC) that corresponds to the dateTime parameter. The System.DateTime value's System.DateTime.Kind property is always set to System.DateTimeKind.Utc. - ConvertTimeToUtc(dateTime: DateTime, sourceTimeZone: TimeZoneInfo) -> DateTime - - Converts the time in a specified time zone to Coordinated Universal Time (UTC). - - dateTime: The date and time to convert. - sourceTimeZone: The time zone of dateTime. - Returns: The Coordinated Universal Time (UTC) that corresponds to the dateTime parameter. The System.DateTime object's System.DateTime.Kind property is always set to System.DateTimeKind.Utc. - """ - pass - - @staticmethod - def CreateCustomTimeZone(id, baseUtcOffset, displayName, standardDisplayName, daylightDisplayName=None, adjustmentRules=None, disableDaylightSavingTime=None): - # type: (id: str, baseUtcOffset: TimeSpan, displayName: str, standardDisplayName: str) -> TimeZoneInfo - """ - CreateCustomTimeZone(id: str, baseUtcOffset: TimeSpan, displayName: str, standardDisplayName: str) -> TimeZoneInfo - - Creates a custom time zone with a specified identifier, an offset from Coordinated Universal Time (UTC), a display name, and a standard time display name. - - id: The time zone's identifier. - baseUtcOffset: An object that represents the time difference between this time zone and Coordinated Universal Time (UTC). - displayName: The display name of the new time zone. - standardDisplayName: The name of the new time zone's standard time. - Returns: The new time zone. - CreateCustomTimeZone(id: str, baseUtcOffset: TimeSpan, displayName: str, standardDisplayName: str, daylightDisplayName: str, adjustmentRules: Array[AdjustmentRule]) -> TimeZoneInfo - CreateCustomTimeZone(id: str, baseUtcOffset: TimeSpan, displayName: str, standardDisplayName: str, daylightDisplayName: str, adjustmentRules: Array[AdjustmentRule], disableDaylightSavingTime: bool) -> TimeZoneInfo - """ - pass - - def Equals(self, *__args): - # type: (self: TimeZoneInfo, other: TimeZoneInfo) -> bool - """ - Equals(self: TimeZoneInfo, other: TimeZoneInfo) -> bool - - Determines whether the current System.TimeZoneInfo object and another System.TimeZoneInfo object are equal. - - other: A second object to compare with the current object. - Returns: true if the two System.TimeZoneInfo objects are equal; otherwise, false. - Equals(self: TimeZoneInfo, obj: object) -> bool - """ - pass - - @staticmethod - def FindSystemTimeZoneById(id): - # type: (id: str) -> TimeZoneInfo - """ - FindSystemTimeZoneById(id: str) -> TimeZoneInfo - - Retrieves a System.TimeZoneInfo object from the registry based on its identifier. - - id: The time zone identifier, which corresponds to the System.TimeZoneInfo.Id property. - Returns: An object whose identifier is the value of the id parameter. - """ - pass - - @staticmethod - def FromSerializedString(source): - # type: (source: str) -> TimeZoneInfo - """ - FromSerializedString(source: str) -> TimeZoneInfo - - Deserializes a string to re-create an original serialized System.TimeZoneInfo object. - - source: The string representation of the serialized System.TimeZoneInfo object. - Returns: The original serialized object. - """ - pass - - def GetAdjustmentRules(self): - # type: (self: TimeZoneInfo) -> Array[AdjustmentRule] - """ - GetAdjustmentRules(self: TimeZoneInfo) -> Array[AdjustmentRule] - - Retrieves an array of System.TimeZoneInfo.AdjustmentRule objects that apply to the current System.TimeZoneInfo object. - Returns: An array of objects for this time zone. - """ - pass - - def GetAmbiguousTimeOffsets(self, *__args): - # type: (self: TimeZoneInfo, dateTimeOffset: DateTimeOffset) -> Array[TimeSpan] - """ - GetAmbiguousTimeOffsets(self: TimeZoneInfo, dateTimeOffset: DateTimeOffset) -> Array[TimeSpan] - - Returns information about the possible dates and times that an ambiguous date and time can be mapped to. - - dateTimeOffset: A date and time. - Returns: An array of objects that represents possible Coordinated Universal Time (UTC) offsets that a particular date and time can be mapped to. - GetAmbiguousTimeOffsets(self: TimeZoneInfo, dateTime: DateTime) -> Array[TimeSpan] - - Returns information about the possible dates and times that an ambiguous date and time can be mapped to. - - dateTime: A date and time. - Returns: An array of objects that represents possible Coordinated Universal Time (UTC) offsets that a particular date and time can be mapped to. - """ - pass - - def GetHashCode(self): - # type: (self: TimeZoneInfo) -> int - """ - GetHashCode(self: TimeZoneInfo) -> int - - Serves as a hash function for hashing algorithms and data structures such as hash tables. - Returns: A 32-bit signed integer that serves as the hash code for this System.TimeZoneInfo object. - """ - pass - - @staticmethod - def GetSystemTimeZones(): - # type: () -> ReadOnlyCollection[TimeZoneInfo] - """ - GetSystemTimeZones() -> ReadOnlyCollection[TimeZoneInfo] - - Returns a sorted collection of all the time zones about which information is available on the local system. - Returns: A read-only collection of System.TimeZoneInfo objects. - """ - pass - - def GetUtcOffset(self, *__args): - # type: (self: TimeZoneInfo, dateTimeOffset: DateTimeOffset) -> TimeSpan - """ - GetUtcOffset(self: TimeZoneInfo, dateTimeOffset: DateTimeOffset) -> TimeSpan - - Calculates the offset or difference between the time in this time zone and Coordinated Universal Time (UTC) for a particular date and time. - - dateTimeOffset: The date and time to determine the offset for. - Returns: An object that indicates the time difference between Coordinated Universal Time (UTC) and the current time zone. - GetUtcOffset(self: TimeZoneInfo, dateTime: DateTime) -> TimeSpan - - Calculates the offset or difference between the time in this time zone and Coordinated Universal Time (UTC) for a particular date and time. - - dateTime: The date and time to determine the offset for. - Returns: An object that indicates the time difference between the two time zones. - """ - pass - - def HasSameRules(self, other): - # type: (self: TimeZoneInfo, other: TimeZoneInfo) -> bool - """ - HasSameRules(self: TimeZoneInfo, other: TimeZoneInfo) -> bool - - Indicates whether the current object and another System.TimeZoneInfo object have the same adjustment rules. - - other: A second object to compare with the current System.TimeZoneInfo object. - Returns: true if the two time zones have identical adjustment rules and an identical base offset; otherwise, false. - """ - pass - - def IsAmbiguousTime(self, *__args): - # type: (self: TimeZoneInfo, dateTimeOffset: DateTimeOffset) -> bool - """ - IsAmbiguousTime(self: TimeZoneInfo, dateTimeOffset: DateTimeOffset) -> bool - - Determines whether a particular date and time in a particular time zone is ambiguous and can be mapped to two or more Coordinated Universal Time (UTC) times. - - dateTimeOffset: A date and time. - Returns: true if the dateTimeOffset parameter is ambiguous in the current time zone; otherwise, false. - IsAmbiguousTime(self: TimeZoneInfo, dateTime: DateTime) -> bool - - Determines whether a particular date and time in a particular time zone is ambiguous and can be mapped to two or more Coordinated Universal Time (UTC) times. - - dateTime: A date and time value. - Returns: true if the dateTime parameter is ambiguous; otherwise, false. - """ - pass - - def IsDaylightSavingTime(self, *__args): - # type: (self: TimeZoneInfo, dateTimeOffset: DateTimeOffset) -> bool - """ - IsDaylightSavingTime(self: TimeZoneInfo, dateTimeOffset: DateTimeOffset) -> bool - - Indicates whether a specified date and time falls in the range of daylight saving time for the time zone of the current System.TimeZoneInfo object. - - dateTimeOffset: A date and time value. - Returns: true if the dateTimeOffset parameter is a daylight saving time; otherwise, false. - IsDaylightSavingTime(self: TimeZoneInfo, dateTime: DateTime) -> bool - - Indicates whether a specified date and time falls in the range of daylight saving time for the time zone of the current System.TimeZoneInfo object. - - dateTime: A date and time value. - Returns: true if the dateTime parameter is a daylight saving time; otherwise, false. - """ - pass - - def IsInvalidTime(self, dateTime): - # type: (self: TimeZoneInfo, dateTime: DateTime) -> bool - """ - IsInvalidTime(self: TimeZoneInfo, dateTime: DateTime) -> bool - - Indicates whether a particular date and time is invalid. - - dateTime: A date and time value. - Returns: true if dateTime is invalid; otherwise, false. - """ - pass - - def ToSerializedString(self): - # type: (self: TimeZoneInfo) -> str - """ - ToSerializedString(self: TimeZoneInfo) -> str - - Converts the current System.TimeZoneInfo object to a serialized string. - Returns: A string that represents the current System.TimeZoneInfo object. - """ - pass - - def ToString(self): - # type: (self: TimeZoneInfo) -> str - """ - ToString(self: TimeZoneInfo) -> str - - Returns the current System.TimeZoneInfo object's display name. - Returns: The value of the System.TimeZoneInfo.DisplayName property of the current System.TimeZoneInfo object. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - BaseUtcOffset = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (UTC). - """ - Gets the time difference between the current time zone's standard time and Coordinated Universal Time (UTC). - - Get: BaseUtcOffset(self: TimeZoneInfo) -> TimeSpan - """ - - DaylightName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the localized display name for the current time zone's daylight saving time. - - Get: DaylightName(self: TimeZoneInfo) -> str - """ - - DisplayName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the localized general display name that represents the time zone. - - Get: DisplayName(self: TimeZoneInfo) -> str - """ - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the time zone identifier. - - Get: Id(self: TimeZoneInfo) -> str - """ - - StandardName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the localized display name for the time zone's standard time. - - Get: StandardName(self: TimeZoneInfo) -> str - """ - - SupportsDaylightSavingTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the time zone has any daylight saving time rules. - - Get: SupportsDaylightSavingTime(self: TimeZoneInfo) -> bool - """ - - - AdjustmentRule = None - Local = None - TransitionTime = None - Utc = None - - -class TimeZoneNotFoundException(Exception, ISerializable, _Exception): - """ - The exception that is thrown when a time zone cannot be found. - - TimeZoneNotFoundException(message: str) - TimeZoneNotFoundException(message: str, innerException: Exception) - TimeZoneNotFoundException() - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - __new__(cls: type) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class TupleExtensions(object): - # no doc - @staticmethod - def Deconstruct(value, item1, item2=None, item3=None, item4=None, item5=None, item6=None, item7=None, item8=None, item9=None, item10=None, item11=None, item12=None, item13=None, item14=None, item15=None, item16=None, item17=None, item18=None, item19=None, item20=None, item21=None): - # type: (value: Tuple[T1]) -> T1 - """ - Deconstruct[T1](value: Tuple[T1]) -> T1 - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18, T19]]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18]]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17]]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16]]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15]]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18, T19, T20]]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8]]) -> (T1, T2, T3, T4, T5, T6, T7, T8) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7)](value: Tuple[T1, T2, T3, T4, T5, T6, T7]) -> (T1, T2, T3, T4, T5, T6, T7) - Deconstruct[(T1, T2, T3, T4, T5, T6)](value: Tuple[T1, T2, T3, T4, T5, T6]) -> (T1, T2, T3, T4, T5, T6) - Deconstruct[(T1, T2, T3, T4, T5)](value: Tuple[T1, T2, T3, T4, T5]) -> (T1, T2, T3, T4, T5) - Deconstruct[(T1, T2, T3, T4)](value: Tuple[T1, T2, T3, T4]) -> (T1, T2, T3, T4) - Deconstruct[(T1, T2, T3)](value: Tuple[T1, T2, T3]) -> (T1, T2, T3) - Deconstruct[(T1, T2)](value: Tuple[T1, T2]) -> (T1, T2) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10) - Deconstruct[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18, T19, T20, T21]]]) -> (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21) - """ - pass - - @staticmethod - def ToTuple(value): - # type: (value: ValueTuple[T1]) -> Tuple[T1] - """ - ToTuple[T1](value: ValueTuple[T1]) -> Tuple[T1] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16, T17, T18, T19]]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18, T19]]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16, T17, T18]]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18]]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16, T17]]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17]]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16]]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16]]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15]]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15]]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16, T17, T18, T19, T20]]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18, T19, T20]]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7]) -> Tuple[T1, T2, T3, T4, T5, T6, T7] - ToTuple[(T1, T2, T3, T4, T5, T6)](value: ValueTuple[T1, T2, T3, T4, T5, T6]) -> Tuple[T1, T2, T3, T4, T5, T6] - ToTuple[(T1, T2, T3, T4, T5)](value: ValueTuple[T1, T2, T3, T4, T5]) -> Tuple[T1, T2, T3, T4, T5] - ToTuple[(T1, T2, T3, T4)](value: ValueTuple[T1, T2, T3, T4]) -> Tuple[T1, T2, T3, T4] - ToTuple[(T1, T2, T3)](value: ValueTuple[T1, T2, T3]) -> Tuple[T1, T2, T3] - ToTuple[(T1, T2)](value: ValueTuple[T1, T2]) -> Tuple[T1, T2] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10]] - ToTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21)](value: ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16, T17, T18, T19, T20, T21]]]) -> Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18, T19, T20, T21]]] - """ - pass - - @staticmethod - def ToValueTuple(value): - # type: (value: Tuple[T1]) -> ValueTuple[T1] - """ - ToValueTuple[T1](value: Tuple[T1]) -> ValueTuple[T1] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18, T19]]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16, T17, T18, T19]]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18]]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16, T17, T18]]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17]]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16, T17]]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16]]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16]]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15]]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15]]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18, T19, T20]]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16, T17, T18, T19, T20]]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7)](value: Tuple[T1, T2, T3, T4, T5, T6, T7]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7] - ToValueTuple[(T1, T2, T3, T4, T5, T6)](value: Tuple[T1, T2, T3, T4, T5, T6]) -> ValueTuple[T1, T2, T3, T4, T5, T6] - ToValueTuple[(T1, T2, T3, T4, T5)](value: Tuple[T1, T2, T3, T4, T5]) -> ValueTuple[T1, T2, T3, T4, T5] - ToValueTuple[(T1, T2, T3, T4)](value: Tuple[T1, T2, T3, T4]) -> ValueTuple[T1, T2, T3, T4] - ToValueTuple[(T1, T2, T3)](value: Tuple[T1, T2, T3]) -> ValueTuple[T1, T2, T3] - ToValueTuple[(T1, T2)](value: Tuple[T1, T2]) -> ValueTuple[T1, T2] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10]] - ToValueTuple[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21)](value: Tuple[T1, T2, T3, T4, T5, T6, T7, Tuple[T8, T9, T10, T11, T12, T13, T14, Tuple[T15, T16, T17, T18, T19, T20, T21]]]) -> ValueTuple[T1, T2, T3, T4, T5, T6, T7, ValueTuple[T8, T9, T10, T11, T12, T13, T14, ValueTuple[T15, T16, T17, T18, T19, T20, T21]]] - """ - pass - - __all__ = [ - 'Deconstruct', - 'ToTuple', - 'ToValueTuple', - ] - - -class Type(MemberInfo, ICustomAttributeProvider, _MemberInfo, _Type, IReflect): - """ Represents type declarations: class types, interface types, array types, value types, enumeration types, type parameters, generic type definitions, and open or closed constructed generic types. """ - def Equals(self, o): - # type: (self: Type, o: object) -> bool - """ - Equals(self: Type, o: object) -> bool - - Determines if the underlying system type of the current System.Type is the same as the underlying system type of the specified System.Object. - - o: The object whose underlying system type is to be compared with the underlying system type of the current System.Type. - Returns: true if the underlying system type of o is the same as the underlying system type of the current System.Type; otherwise, false. This method also returns false if the object specified by the o parameter is not a Type. - Equals(self: Type, o: Type) -> bool - - Determines if the underlying system type of the current System.Type is the same as the underlying system type of the specified System.Type. - - o: The object whose underlying system type is to be compared with the underlying system type of the current System.Type. - Returns: true if the underlying system type of o is the same as the underlying system type of the current System.Type; otherwise, false. - """ - pass - - def FilterAttribute(self, *args): #cannot find CLR method - """ - Represents a delegate that is used to filter a list of members represented in an array of System.Reflection.MemberInfo objects. - - MemberFilter(object: object, method: IntPtr) - """ - pass - - def FilterName(self, *args): #cannot find CLR method - """ - Represents a delegate that is used to filter a list of members represented in an array of System.Reflection.MemberInfo objects. - - MemberFilter(object: object, method: IntPtr) - """ - pass - - def FilterNameIgnoreCase(self, *args): #cannot find CLR method - """ - Represents a delegate that is used to filter a list of members represented in an array of System.Reflection.MemberInfo objects. - - MemberFilter(object: object, method: IntPtr) - """ - pass - - def FindInterfaces(self, filter, filterCriteria): - # type: (self: Type, filter: TypeFilter, filterCriteria: object) -> Array[Type] - """ - FindInterfaces(self: Type, filter: TypeFilter, filterCriteria: object) -> Array[Type] - - Returns an array of System.Type objects representing a filtered list of interfaces implemented or inherited by the current System.Type. - - filter: The delegate that compares the interfaces against filterCriteria. - filterCriteria: The search criteria that determines whether an interface should be included in the returned array. - Returns: An array of System.Type objects representing a filtered list of the interfaces implemented or inherited by the current System.Type, or an empty array of type System.Type if no interfaces matching the filter are implemented or inherited by the current - System.Type. - """ - pass - - def FindMembers(self, memberType, bindingAttr, filter, filterCriteria): - # type: (self: Type, memberType: MemberTypes, bindingAttr: BindingFlags, filter: MemberFilter, filterCriteria: object) -> Array[MemberInfo] - """ - FindMembers(self: Type, memberType: MemberTypes, bindingAttr: BindingFlags, filter: MemberFilter, filterCriteria: object) -> Array[MemberInfo] - - Returns a filtered array of System.Reflection.MemberInfo objects of the specified member type. - - memberType: An object that indicates the type of member to search for. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - filter: The delegate that does the comparisons, returning true if the member currently being inspected matches the filterCriteria and false otherwise. You can use the FilterAttribute, FilterName, and FilterNameIgnoreCase delegates supplied by this class. The - first uses the fields of FieldAttributes, MethodAttributes, and MethodImplAttributes as search criteria, and the other two delegates use String objects as the search criteria. - - filterCriteria: The search criteria that determines whether a member is returned in the array of MemberInfo objects.The fields of FieldAttributes, MethodAttributes, and MethodImplAttributes can be used in conjunction with the FilterAttribute delegate supplied by this - class. - - Returns: A filtered array of System.Reflection.MemberInfo objects of the specified member type.-or- An empty array of type System.Reflection.MemberInfo, if the current System.Type does not have members of type memberType that match the filter criteria. - """ - pass - - def GetArrayRank(self): - # type: (self: Type) -> int - """ - GetArrayRank(self: Type) -> int - - Gets the number of dimensions in an System.Array. - Returns: An System.Int32 containing the number of dimensions in the current Type. - """ - pass - - def GetAttributeFlagsImpl(self, *args): #cannot find CLR method - # type: (self: Type) -> TypeAttributes - """ - GetAttributeFlagsImpl(self: Type) -> TypeAttributes - - When overridden in a derived class, implements the System.Type.Attributes property and gets a bitmask indicating the attributes associated with the System.Type. - Returns: A System.Reflection.TypeAttributes object representing the attribute set of the System.Type. - """ - pass - - def GetConstructor(self, *__args): - # type: (self: Type, bindingAttr: BindingFlags, binder: Binder, callConvention: CallingConventions, types: Array[Type], modifiers: Array[ParameterModifier]) -> ConstructorInfo - """ - GetConstructor(self: Type, bindingAttr: BindingFlags, binder: Binder, callConvention: CallingConventions, types: Array[Type], modifiers: Array[ParameterModifier]) -> ConstructorInfo - - Searches for a constructor whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention. - - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - binder: An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.-or- A null reference (Nothing in Visual Basic), to use the - System.Type.DefaultBinder. - - callConvention: The object that specifies the set of rules to use regarding the order and layout of arguments, how the return value is passed, what registers are used for arguments, and the stack is cleaned up. - types: An array of System.Type objects representing the number, order, and type of the parameters for the constructor to get.-or- An empty array of the type System.Type (that is, Type[] types = new Type[0]) to get a constructor that takes no parameters. - modifiers: An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array. The default binder does not process this parameter. - Returns: An object representing the constructor that matches the specified requirements, if found; otherwise, null. - GetConstructor(self: Type, bindingAttr: BindingFlags, binder: Binder, types: Array[Type], modifiers: Array[ParameterModifier]) -> ConstructorInfo - - Searches for a constructor whose parameters match the specified argument types and modifiers, using the specified binding constraints. - - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - binder: An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.-or- A null reference (Nothing in Visual Basic), to use the - System.Type.DefaultBinder. - - types: An array of System.Type objects representing the number, order, and type of the parameters for the constructor to get.-or- An empty array of the type System.Type (that is, Type[] types = new Type[0]) to get a constructor that takes no parameters.-or- - System.Type.EmptyTypes. - - modifiers: An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the parameter type array. The default binder does not process this parameter. - Returns: A System.Reflection.ConstructorInfo object representing the constructor that matches the specified requirements, if found; otherwise, null. - GetConstructor(self: Type, types: Array[Type]) -> ConstructorInfo - - Searches for a public instance constructor whose parameters match the types in the specified array. - - types: An array of System.Type objects representing the number, order, and type of the parameters for the desired constructor.-or- An empty array of System.Type objects, to get a constructor that takes no parameters. Such an empty array is provided by the - static field System.Type.EmptyTypes. - - Returns: An object representing the public instance constructor whose parameters match the types in the parameter type array, if found; otherwise, null. - """ - pass - - def GetConstructorImpl(self, *args): #cannot find CLR method - # type: (self: Type, bindingAttr: BindingFlags, binder: Binder, callConvention: CallingConventions, types: Array[Type], modifiers: Array[ParameterModifier]) -> ConstructorInfo - """ - GetConstructorImpl(self: Type, bindingAttr: BindingFlags, binder: Binder, callConvention: CallingConventions, types: Array[Type], modifiers: Array[ParameterModifier]) -> ConstructorInfo - - When overridden in a derived class, searches for a constructor whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention. - - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - binder: An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.-or- A null reference (Nothing in Visual Basic), to use the - System.Type.DefaultBinder. - - callConvention: The object that specifies the set of rules to use regarding the order and layout of arguments, how the return value is passed, what registers are used for arguments, and the stack is cleaned up. - types: An array of System.Type objects representing the number, order, and type of the parameters for the constructor to get.-or- An empty array of the type System.Type (that is, Type[] types = new Type[0]) to get a constructor that takes no parameters. - modifiers: An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array. The default binder does not process this parameter. - Returns: A System.Reflection.ConstructorInfo object representing the constructor that matches the specified requirements, if found; otherwise, null. - """ - pass - - def GetConstructors(self, bindingAttr=None): - # type: (self: Type, bindingAttr: BindingFlags) -> Array[ConstructorInfo] - """ - GetConstructors(self: Type, bindingAttr: BindingFlags) -> Array[ConstructorInfo] - - When overridden in a derived class, searches for the constructors defined for the current System.Type, using the specified BindingFlags. - - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: An array of System.Reflection.ConstructorInfo objects representing all constructors defined for the current System.Type that match the specified binding constraints, including the type initializer if it is defined. Returns an empty array of type - System.Reflection.ConstructorInfo if no constructors are defined for the current System.Type, if none of the defined constructors match the binding constraints, or if the current System.Type represents a type parameter in the definition of a generic - type or generic method. - - GetConstructors(self: Type) -> Array[ConstructorInfo] - - Returns all the public constructors defined for the current System.Type. - Returns: An array of System.Reflection.ConstructorInfo objects representing all the public instance constructors defined for the current System.Type, but not including the type initializer (static constructor). If no public instance constructors are defined - for the current System.Type, or if the current System.Type represents a type parameter in the definition of a generic type or generic method, an empty array of type System.Reflection.ConstructorInfo is returned. - """ - pass - - def GetDefaultMembers(self): - # type: (self: Type) -> Array[MemberInfo] - """ - GetDefaultMembers(self: Type) -> Array[MemberInfo] - - Searches for the members defined for the current System.Type whose System.Reflection.DefaultMemberAttribute is set. - Returns: An array of System.Reflection.MemberInfo objects representing all default members of the current System.Type.-or- An empty array of type System.Reflection.MemberInfo, if the current System.Type does not have default members. - """ - pass - - def GetElementType(self): - # type: (self: Type) -> Type - """ - GetElementType(self: Type) -> Type - - When overridden in a derived class, returns the System.Type of the object encompassed or referred to by the current array, pointer or reference type. - Returns: The System.Type of the object encompassed or referred to by the current array, pointer, or reference type, or null if the current System.Type is not an array or a pointer, or is not passed by reference, or represents a generic type or a type parameter - in the definition of a generic type or generic method. - """ - pass - - def GetEnumName(self, value): - # type: (self: Type, value: object) -> str - """ - GetEnumName(self: Type, value: object) -> str - - Returns the name of the constant that has the specified value, for the current enumeration type. - - value: The value whose name is to be retrieved. - Returns: The name of the member of the current enumeration type that has the specified value, or null if no such constant is found. - """ - pass - - def GetEnumNames(self): - # type: (self: Type) -> Array[str] - """ - GetEnumNames(self: Type) -> Array[str] - - Returns the names of the members of the current enumeration type. - Returns: An array that contains the names of the members of the enumeration. - """ - pass - - def GetEnumUnderlyingType(self): - # type: (self: Type) -> Type - """ - GetEnumUnderlyingType(self: Type) -> Type - - Returns the underlying type of the current enumeration type. - Returns: The underlying type of the current enumeration. - """ - pass - - def GetEnumValues(self): - # type: (self: Type) -> Array - """ - GetEnumValues(self: Type) -> Array - - Returns an array of the values of the constants in the current enumeration type. - Returns: An array that contains the values. The elements of the array are sorted by the binary values (that is, the unsigned values) of the enumeration constants. - """ - pass - - def GetEvent(self, name, bindingAttr=None): - # type: (self: Type, name: str) -> EventInfo - """ - GetEvent(self: Type, name: str) -> EventInfo - - Returns the System.Reflection.EventInfo object representing the specified public event. - - name: The string containing the name of an event that is declared or inherited by the current System.Type. - Returns: The object representing the specified public event that is declared or inherited by the current System.Type, if found; otherwise, null. - GetEvent(self: Type, name: str, bindingAttr: BindingFlags) -> EventInfo - - When overridden in a derived class, returns the System.Reflection.EventInfo object representing the specified event, using the specified binding constraints. - - name: The string containing the name of an event which is declared or inherited by the current System.Type. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: The object representing the specified event that is declared or inherited by the current System.Type, if found; otherwise, null. - """ - pass - - def GetEvents(self, bindingAttr=None): - # type: (self: Type) -> Array[EventInfo] - """ - GetEvents(self: Type) -> Array[EventInfo] - - Returns all the public events that are declared or inherited by the current System.Type. - Returns: An array of System.Reflection.EventInfo objects representing all the public events which are declared or inherited by the current System.Type.-or- An empty array of type System.Reflection.EventInfo, if the current System.Type does not have public - events. - - GetEvents(self: Type, bindingAttr: BindingFlags) -> Array[EventInfo] - - When overridden in a derived class, searches for events that are declared or inherited by the current System.Type, using the specified binding constraints. - - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: An array of System.Reflection.EventInfo objects representing all events that are declared or inherited by the current System.Type that match the specified binding constraints.-or- An empty array of type System.Reflection.EventInfo, if the current - System.Type does not have events, or if none of the events match the binding constraints. - """ - pass - - def GetField(self, name, bindingAttr=None): - # type: (self: Type, name: str, bindingAttr: BindingFlags) -> FieldInfo - """ - GetField(self: Type, name: str, bindingAttr: BindingFlags) -> FieldInfo - - Searches for the specified field, using the specified binding constraints. - - name: The string containing the name of the data field to get. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: An object representing the field that matches the specified requirements, if found; otherwise, null. - GetField(self: Type, name: str) -> FieldInfo - - Searches for the public field with the specified name. - - name: The string containing the name of the data field to get. - Returns: An object representing the public field with the specified name, if found; otherwise, null. - """ - pass - - def GetFields(self, bindingAttr=None): - # type: (self: Type) -> Array[FieldInfo] - """ - GetFields(self: Type) -> Array[FieldInfo] - - Returns all the public fields of the current System.Type. - Returns: An array of System.Reflection.FieldInfo objects representing all the public fields defined for the current System.Type.-or- An empty array of type System.Reflection.FieldInfo, if no public fields are defined for the current System.Type. - GetFields(self: Type, bindingAttr: BindingFlags) -> Array[FieldInfo] - - When overridden in a derived class, searches for the fields defined for the current System.Type, using the specified binding constraints. - - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: An array of System.Reflection.FieldInfo objects representing all fields defined for the current System.Type that match the specified binding constraints.-or- An empty array of type System.Reflection.FieldInfo, if no fields are defined for the current - System.Type, or if none of the defined fields match the binding constraints. - """ - pass - - def GetGenericArguments(self): - # type: (self: Type) -> Array[Type] - """ - GetGenericArguments(self: Type) -> Array[Type] - - Returns an array of System.Type objects that represent the type arguments of a generic type or the type parameters of a generic type definition. - Returns: An array of System.Type objects that represent the type arguments of a generic type. Returns an empty array if the current type is not a generic type. - """ - pass - - def GetGenericParameterConstraints(self): - # type: (self: Type) -> Array[Type] - """ - GetGenericParameterConstraints(self: Type) -> Array[Type] - - Returns an array of System.Type objects that represent the constraints on the current generic type parameter. - Returns: An array of System.Type objects that represent the constraints on the current generic type parameter. - """ - pass - - def GetGenericTypeDefinition(self): - # type: (self: Type) -> Type - """ - GetGenericTypeDefinition(self: Type) -> Type - - Returns a System.Type object that represents a generic type definition from which the current generic type can be constructed. - Returns: A System.Type object representing a generic type from which the current type can be constructed. - """ - pass - - def GetHashCode(self): - # type: (self: Type) -> int - """ - GetHashCode(self: Type) -> int - - Returns the hash code for this instance. - Returns: The hash code for this instance. - """ - pass - - def GetInterface(self, name, ignoreCase=None): - # type: (self: Type, name: str) -> Type - """ - GetInterface(self: Type, name: str) -> Type - - Searches for the interface with the specified name. - - name: The string containing the name of the interface to get. For generic interfaces, this is the mangled name. - Returns: An object representing the interface with the specified name, implemented or inherited by the current System.Type, if found; otherwise, null. - GetInterface(self: Type, name: str, ignoreCase: bool) -> Type - - When overridden in a derived class, searches for the specified interface, specifying whether to do a case-insensitive search for the interface name. - - name: The string containing the name of the interface to get. For generic interfaces, this is the mangled name. - ignoreCase: true to ignore the case of that part of name that specifies the simple interface name (the part that specifies the namespace must be correctly cased).-or- false to perform a case-sensitive search for all parts of name. - Returns: An object representing the interface with the specified name, implemented or inherited by the current System.Type, if found; otherwise, null. - """ - pass - - def GetInterfaceMap(self, interfaceType): - # type: (self: Type, interfaceType: Type) -> InterfaceMapping - """ - GetInterfaceMap(self: Type, interfaceType: Type) -> InterfaceMapping - - Returns an interface mapping for the specified interface type. - - interfaceType: The interface type to retrieve a mapping for. - Returns: An object that represents the interface mapping for interfaceType. - """ - pass - - def GetInterfaces(self): - # type: (self: Type) -> Array[Type] - """ - GetInterfaces(self: Type) -> Array[Type] - - When overridden in a derived class, gets all the interfaces implemented or inherited by the current System.Type. - Returns: An array of System.Type objects representing all the interfaces implemented or inherited by the current System.Type.-or- An empty array of type System.Type, if no interfaces are implemented or inherited by the current System.Type. - """ - pass - - def GetMember(self, name, *__args): - # type: (self: Type, name: str) -> Array[MemberInfo] - """ - GetMember(self: Type, name: str) -> Array[MemberInfo] - - Searches for the public members with the specified name. - - name: The string containing the name of the public members to get. - Returns: An array of System.Reflection.MemberInfo objects representing the public members with the specified name, if found; otherwise, an empty array. - GetMember(self: Type, name: str, bindingAttr: BindingFlags) -> Array[MemberInfo] - - Searches for the specified members, using the specified binding constraints. - - name: The string containing the name of the members to get. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return an empty array. - Returns: An array of System.Reflection.MemberInfo objects representing the public members with the specified name, if found; otherwise, an empty array. - GetMember(self: Type, name: str, type: MemberTypes, bindingAttr: BindingFlags) -> Array[MemberInfo] - - Searches for the specified members of the specified member type, using the specified binding constraints. - - name: The string containing the name of the members to get. - type: The value to search for. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return an empty array. - Returns: An array of System.Reflection.MemberInfo objects representing the public members with the specified name, if found; otherwise, an empty array. - """ - pass - - def GetMembers(self, bindingAttr=None): - # type: (self: Type) -> Array[MemberInfo] - """ - GetMembers(self: Type) -> Array[MemberInfo] - - Returns all the public members of the current System.Type. - Returns: An array of System.Reflection.MemberInfo objects representing all the public members of the current System.Type.-or- An empty array of type System.Reflection.MemberInfo, if the current System.Type does not have public members. - GetMembers(self: Type, bindingAttr: BindingFlags) -> Array[MemberInfo] - - When overridden in a derived class, searches for the members defined for the current System.Type, using the specified binding constraints. - - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: An array of System.Reflection.MemberInfo objects representing all members defined for the current System.Type that match the specified binding constraints.-or- An empty array of type System.Reflection.MemberInfo, if no members are defined for the - current System.Type, or if none of the defined members match the binding constraints. - """ - pass - - def GetMethod(self, name, *__args): - # type: (self: Type, name: str, bindingAttr: BindingFlags, binder: Binder, callConvention: CallingConventions, types: Array[Type], modifiers: Array[ParameterModifier]) -> MethodInfo - """ - GetMethod(self: Type, name: str, bindingAttr: BindingFlags, binder: Binder, callConvention: CallingConventions, types: Array[Type], modifiers: Array[ParameterModifier]) -> MethodInfo - - Searches for the specified method whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention. - - name: The string containing the name of the method to get. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - binder: An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.-or- A null reference (Nothing in Visual Basic), to use the - System.Type.DefaultBinder. - - callConvention: The object that specifies the set of rules to use regarding the order and layout of arguments, how the return value is passed, what registers are used for arguments, and how the stack is cleaned up. - types: An array of System.Type objects representing the number, order, and type of the parameters for the method to get.-or- An empty array of System.Type objects (as provided by the System.Type.EmptyTypes field) to get a method that takes no parameters. - modifiers: An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array. To be only used when calling through COM interop, and only parameters that are passed by reference are - handled. The default binder does not process this parameter. - - Returns: An object representing the method that matches the specified requirements, if found; otherwise, null. - GetMethod(self: Type, name: str, bindingAttr: BindingFlags, binder: Binder, types: Array[Type], modifiers: Array[ParameterModifier]) -> MethodInfo - - Searches for the specified method whose parameters match the specified argument types and modifiers, using the specified binding constraints. - - name: The string containing the name of the method to get. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - binder: An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.-or- A null reference (Nothing in Visual Basic), to use the - System.Type.DefaultBinder. - - types: An array of System.Type objects representing the number, order, and type of the parameters for the method to get.-or- An empty array of System.Type objects (as provided by the System.Type.EmptyTypes field) to get a method that takes no parameters. - modifiers: An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array. To be only used when calling through COM interop, and only parameters that are passed by reference are - handled. The default binder does not process this parameter. - - Returns: An object representing the method that matches the specified requirements, if found; otherwise, null. - GetMethod(self: Type, name: str, types: Array[Type], modifiers: Array[ParameterModifier]) -> MethodInfo - - Searches for the specified public method whose parameters match the specified argument types and modifiers. - - name: The string containing the name of the public method to get. - types: An array of System.Type objects representing the number, order, and type of the parameters for the method to get.-or- An empty array of System.Type objects (as provided by the System.Type.EmptyTypes field) to get a method that takes no parameters. - modifiers: An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array. To be only used when calling through COM interop, and only parameters that are passed by reference are - handled. The default binder does not process this parameter. - - Returns: An object representing the public method that matches the specified requirements, if found; otherwise, null. - GetMethod(self: Type, name: str, types: Array[Type]) -> MethodInfo - - Searches for the specified public method whose parameters match the specified argument types. - - name: The string containing the name of the public method to get. - types: An array of System.Type objects representing the number, order, and type of the parameters for the method to get.-or- An empty array of System.Type objects (as provided by the System.Type.EmptyTypes field) to get a method that takes no parameters. - Returns: An object representing the public method whose parameters match the specified argument types, if found; otherwise, null. - GetMethod(self: Type, name: str, bindingAttr: BindingFlags) -> MethodInfo - - Searches for the specified method, using the specified binding constraints. - - name: The string containing the name of the method to get. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: An object representing the method that matches the specified requirements, if found; otherwise, null. - GetMethod(self: Type, name: str) -> MethodInfo - - Searches for the public method with the specified name. - - name: The string containing the name of the public method to get. - Returns: An object that represents the public method with the specified name, if found; otherwise, null. - """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: Type, name: str, bindingAttr: BindingFlags, binder: Binder, callConvention: CallingConventions, types: Array[Type], modifiers: Array[ParameterModifier]) -> MethodInfo - """ - GetMethodImpl(self: Type, name: str, bindingAttr: BindingFlags, binder: Binder, callConvention: CallingConventions, types: Array[Type], modifiers: Array[ParameterModifier]) -> MethodInfo - - When overridden in a derived class, searches for the specified method whose parameters match the specified argument types and modifiers, using the specified binding constraints and the specified calling convention. - - name: The string containing the name of the method to get. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - binder: An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.-or- A null reference (Nothing in Visual Basic), to use the - System.Type.DefaultBinder. - - callConvention: The object that specifies the set of rules to use regarding the order and layout of arguments, how the return value is passed, what registers are used for arguments, and what process cleans up the stack. - types: An array of System.Type objects representing the number, order, and type of the parameters for the method to get.-or- An empty array of the type System.Type (that is, Type[] types = new Type[0]) to get a method that takes no parameters.-or- null. If - types is null, arguments are not matched. - - modifiers: An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array. The default binder does not process this parameter. - Returns: An object representing the method that matches the specified requirements, if found; otherwise, null. - """ - pass - - def GetMethods(self, bindingAttr=None): - # type: (self: Type, bindingAttr: BindingFlags) -> Array[MethodInfo] - """ - GetMethods(self: Type, bindingAttr: BindingFlags) -> Array[MethodInfo] - - When overridden in a derived class, searches for the methods defined for the current System.Type, using the specified binding constraints. - - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: An array of System.Reflection.MethodInfo objects representing all methods defined for the current System.Type that match the specified binding constraints.-or- An empty array of type System.Reflection.MethodInfo, if no methods are defined for the - current System.Type, or if none of the defined methods match the binding constraints. - - GetMethods(self: Type) -> Array[MethodInfo] - - Returns all the public methods of the current System.Type. - Returns: An array of System.Reflection.MethodInfo objects representing all the public methods defined for the current System.Type.-or- An empty array of type System.Reflection.MethodInfo, if no public methods are defined for the current System.Type. - """ - pass - - def GetNestedType(self, name, bindingAttr=None): - # type: (self: Type, name: str) -> Type - """ - GetNestedType(self: Type, name: str) -> Type - - Searches for the public nested type with the specified name. - - name: The string containing the name of the nested type to get. - Returns: An object representing the public nested type with the specified name, if found; otherwise, null. - GetNestedType(self: Type, name: str, bindingAttr: BindingFlags) -> Type - - When overridden in a derived class, searches for the specified nested type, using the specified binding constraints. - - name: The string containing the name of the nested type to get. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: An object representing the nested type that matches the specified requirements, if found; otherwise, null. - """ - pass - - def GetNestedTypes(self, bindingAttr=None): - # type: (self: Type) -> Array[Type] - """ - GetNestedTypes(self: Type) -> Array[Type] - - Returns the public types nested in the current System.Type. - Returns: An array of System.Type objects representing the public types nested in the current System.Type (the search is not recursive), or an empty array of type System.Type if no public types are nested in the current System.Type. - GetNestedTypes(self: Type, bindingAttr: BindingFlags) -> Array[Type] - - When overridden in a derived class, searches for the types nested in the current System.Type, using the specified binding constraints. - - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: An array of System.Type objects representing all the types nested in the current System.Type that match the specified binding constraints (the search is not recursive), or an empty array of type System.Type, if no nested types are found that match the - binding constraints. - """ - pass - - def GetProperties(self, bindingAttr=None): - # type: (self: Type, bindingAttr: BindingFlags) -> Array[PropertyInfo] - """ - GetProperties(self: Type, bindingAttr: BindingFlags) -> Array[PropertyInfo] - - When overridden in a derived class, searches for the properties of the current System.Type, using the specified binding constraints. - - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: An array of System.Reflection.PropertyInfo objects representing all properties of the current System.Type that match the specified binding constraints.-or- An empty array of type System.Reflection.PropertyInfo, if the current System.Type does not have - properties, or if none of the properties match the binding constraints. - - GetProperties(self: Type) -> Array[PropertyInfo] - - Returns all the public properties of the current System.Type. - Returns: An array of System.Reflection.PropertyInfo objects representing all public properties of the current System.Type.-or- An empty array of type System.Reflection.PropertyInfo, if the current System.Type does not have public properties. - """ - pass - - def GetProperty(self, name, *__args): - # type: (self: Type, name: str, bindingAttr: BindingFlags, binder: Binder, returnType: Type, types: Array[Type], modifiers: Array[ParameterModifier]) -> PropertyInfo - """ - GetProperty(self: Type, name: str, bindingAttr: BindingFlags, binder: Binder, returnType: Type, types: Array[Type], modifiers: Array[ParameterModifier]) -> PropertyInfo - - Searches for the specified property whose parameters match the specified argument types and modifiers, using the specified binding constraints. - - name: The string containing the name of the property to get. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - binder: An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.-or- A null reference (Nothing in Visual Basic), to use the - System.Type.DefaultBinder. - - returnType: The return type of the property. - types: An array of System.Type objects representing the number, order, and type of the parameters for the indexed property to get.-or- An empty array of the type System.Type (that is, Type[] types = new Type[0]) to get a property that is not indexed. - modifiers: An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array. The default binder does not process this parameter. - Returns: An object representing the property that matches the specified requirements, if found; otherwise, null. - GetProperty(self: Type, name: str, returnType: Type, types: Array[Type], modifiers: Array[ParameterModifier]) -> PropertyInfo - - Searches for the specified public property whose parameters match the specified argument types and modifiers. - - name: The string containing the name of the public property to get. - returnType: The return type of the property. - types: An array of System.Type objects representing the number, order, and type of the parameters for the indexed property to get.-or- An empty array of the type System.Type (that is, Type[] types = new Type[0]) to get a property that is not indexed. - modifiers: An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array. The default binder does not process this parameter. - Returns: An object representing the public property that matches the specified requirements, if found; otherwise, null. - GetProperty(self: Type, name: str, bindingAttr: BindingFlags) -> PropertyInfo - - Searches for the specified property, using the specified binding constraints. - - name: The string containing the name of the property to get. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - Returns: An object representing the property that matches the specified requirements, if found; otherwise, null. - GetProperty(self: Type, name: str, returnType: Type, types: Array[Type]) -> PropertyInfo - - Searches for the specified public property whose parameters match the specified argument types. - - name: The string containing the name of the public property to get. - returnType: The return type of the property. - types: An array of System.Type objects representing the number, order, and type of the parameters for the indexed property to get.-or- An empty array of the type System.Type (that is, Type[] types = new Type[0]) to get a property that is not indexed. - Returns: An object representing the public property whose parameters match the specified argument types, if found; otherwise, null. - GetProperty(self: Type, name: str, types: Array[Type]) -> PropertyInfo - - Searches for the specified public property whose parameters match the specified argument types. - - name: The string containing the name of the public property to get. - types: An array of System.Type objects representing the number, order, and type of the parameters for the indexed property to get.-or- An empty array of the type System.Type (that is, Type[] types = new Type[0]) to get a property that is not indexed. - Returns: An object representing the public property whose parameters match the specified argument types, if found; otherwise, null. - GetProperty(self: Type, name: str, returnType: Type) -> PropertyInfo - - Searches for the public property with the specified name and return type. - - name: The string containing the name of the public property to get. - returnType: The return type of the property. - Returns: An object representing the public property with the specified name, if found; otherwise, null. - GetProperty(self: Type, name: str) -> PropertyInfo - - Searches for the public property with the specified name. - - name: The string containing the name of the public property to get. - Returns: An object representing the public property with the specified name, if found; otherwise, null. - """ - pass - - def GetPropertyImpl(self, *args): #cannot find CLR method - # type: (self: Type, name: str, bindingAttr: BindingFlags, binder: Binder, returnType: Type, types: Array[Type], modifiers: Array[ParameterModifier]) -> PropertyInfo - """ - GetPropertyImpl(self: Type, name: str, bindingAttr: BindingFlags, binder: Binder, returnType: Type, types: Array[Type], modifiers: Array[ParameterModifier]) -> PropertyInfo - - When overridden in a derived class, searches for the specified property whose parameters match the specified argument types and modifiers, using the specified binding constraints. - - name: The string containing the name of the property to get. - bindingAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted.-or- Zero, to return null. - binder: An object that defines a set of properties and enables binding, which can involve selection of an overloaded member, coercion of argument types, and invocation of a member through reflection.-or- A null reference (Nothing in Visual Basic), to use the - System.Type.DefaultBinder. - - returnType: The return type of the property. - types: An array of System.Type objects representing the number, order, and type of the parameters for the indexed property to get.-or- An empty array of the type System.Type (that is, Type[] types = new Type[0]) to get a property that is not indexed. - modifiers: An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the types array. The default binder does not process this parameter. - Returns: An object representing the property that matches the specified requirements, if found; otherwise, null. - """ - pass - - def GetType(self, typeName=None, *__args): - # type: (typeName: str, throwOnError: bool, ignoreCase: bool) -> Type - """ - GetType(typeName: str, throwOnError: bool, ignoreCase: bool) -> Type - - Gets the System.Type with the specified name, specifying whether to perform a case-sensitive search and whether to throw an exception if the type is not found. - - typeName: The assembly-qualified name of the type to get. See System.Type.AssemblyQualifiedName. If the type is in the currently executing assembly or in Mscorlib.dll, it is sufficient to supply the type name qualified by its namespace. - throwOnError: true to throw an exception if the type cannot be found; false to return null.Specifying false also suppresses some other exception conditions, but not all of them. See the Exceptions section. - ignoreCase: true to perform a case-insensitive search for typeName, false to perform a case-sensitive search for typeName. - Returns: The type with the specified name. If the type is not found, the throwOnError parameter specifies whether null is returned or an exception is thrown. In some cases, an exception is thrown regardless of the value of throwOnError. See the Exceptions - section. - - GetType(typeName: str, throwOnError: bool) -> Type - - Gets the System.Type with the specified name, performing a case-sensitive search and specifying whether to throw an exception if the type is not found. - - typeName: The assembly-qualified name of the type to get. See System.Type.AssemblyQualifiedName. If the type is in the currently executing assembly or in Mscorlib.dll, it is sufficient to supply the type name qualified by its namespace. - throwOnError: true to throw an exception if the type cannot be found; false to return null. Specifying false also suppresses some other exception conditions, but not all of them. See the Exceptions section. - Returns: The type with the specified name. If the type is not found, the throwOnError parameter specifies whether null is returned or an exception is thrown. In some cases, an exception is thrown regardless of the value of throwOnError. See the Exceptions - section. - - GetType(typeName: str) -> Type - - Gets the System.Type with the specified name, performing a case-sensitive search. - - typeName: The assembly-qualified name of the type to get. See System.Type.AssemblyQualifiedName. If the type is in the currently executing assembly or in Mscorlib.dll, it is sufficient to supply the type name qualified by its namespace. - Returns: The type with the specified name, if found; otherwise, null. - GetType(typeName: str, assemblyResolver: Func[AssemblyName, Assembly], typeResolver: Func[Assembly, str, bool, Type]) -> Type - GetType(typeName: str, assemblyResolver: Func[AssemblyName, Assembly], typeResolver: Func[Assembly, str, bool, Type], throwOnError: bool) -> Type - GetType(typeName: str, assemblyResolver: Func[AssemblyName, Assembly], typeResolver: Func[Assembly, str, bool, Type], throwOnError: bool, ignoreCase: bool) -> Type - GetType(self: Type) -> Type - - Gets the current System.Type. - Returns: The current System.Type. - """ - pass - - @staticmethod - def GetTypeArray(args): - # type: (args: Array[object]) -> Array[Type] - """ - GetTypeArray(args: Array[object]) -> Array[Type] - - Gets the types of the objects in the specified array. - - args: An array of objects whose types to determine. - Returns: An array of System.Type objects representing the types of the corresponding elements in args. - """ - pass - - @staticmethod - def GetTypeCode(type): - # type: (type: Type) -> TypeCode - """ - GetTypeCode(type: Type) -> TypeCode - - Gets the underlying type code of the specified System.Type. - - type: The type whose underlying type code to get. - Returns: The code of the underlying type. - """ - pass - - def GetTypeCodeImpl(self, *args): #cannot find CLR method - # type: (self: Type) -> TypeCode - """ - GetTypeCodeImpl(self: Type) -> TypeCode - - Returns the underlying type code of the specified System.Type. - Returns: The code of the underlying type. - """ - pass - - @staticmethod - def GetTypeFromCLSID(clsid, *__args): - # type: (clsid: Guid) -> Type - """ - GetTypeFromCLSID(clsid: Guid) -> Type - - Gets the type associated with the specified class identifier (CLSID). - - clsid: The CLSID of the type to get. - Returns: System.__ComObject regardless of whether the CLSID is valid. - GetTypeFromCLSID(clsid: Guid, throwOnError: bool) -> Type - - Gets the type associated with the specified class identifier (CLSID), specifying whether to throw an exception if an error occurs while loading the type. - - clsid: The CLSID of the type to get. - throwOnError: true to throw any exception that occurs.-or- false to ignore any exception that occurs. - Returns: System.__ComObject regardless of whether the CLSID is valid. - GetTypeFromCLSID(clsid: Guid, server: str) -> Type - - Gets the type associated with the specified class identifier (CLSID) from the specified server. - - clsid: The CLSID of the type to get. - server: The server from which to load the type. If the server name is null, this method automatically reverts to the local machine. - Returns: System.__ComObject regardless of whether the CLSID is valid. - GetTypeFromCLSID(clsid: Guid, server: str, throwOnError: bool) -> Type - - Gets the type associated with the specified class identifier (CLSID) from the specified server, specifying whether to throw an exception if an error occurs while loading the type. - - clsid: The CLSID of the type to get. - server: The server from which to load the type. If the server name is null, this method automatically reverts to the local machine. - throwOnError: true to throw any exception that occurs.-or- false to ignore any exception that occurs. - Returns: System.__ComObject regardless of whether the CLSID is valid. - """ - pass - - @staticmethod - def GetTypeFromHandle(handle): - # type: (handle: RuntimeTypeHandle) -> Type - """ - GetTypeFromHandle(handle: RuntimeTypeHandle) -> Type - - Gets the type referenced by the specified type handle. - - handle: The object that refers to the type. - Returns: The type referenced by the specified System.RuntimeTypeHandle, or null if the System.RuntimeTypeHandle.Value property of handle is null. - """ - pass - - @staticmethod - def GetTypeFromProgID(progID, *__args): - # type: (progID: str) -> Type - """ - GetTypeFromProgID(progID: str) -> Type - - Gets the type associated with the specified program identifier (ProgID), returning null if an error is encountered while loading the System.Type. - - progID: The ProgID of the type to get. - Returns: The type associated with the specified ProgID, if progID is a valid entry in the registry and a type is associated with it; otherwise, null. - GetTypeFromProgID(progID: str, throwOnError: bool) -> Type - - Gets the type associated with the specified program identifier (ProgID), specifying whether to throw an exception if an error occurs while loading the type. - - progID: The ProgID of the type to get. - throwOnError: true to throw any exception that occurs.-or- false to ignore any exception that occurs. - Returns: The type associated with the specified program identifier (ProgID), if progID is a valid entry in the registry and a type is associated with it; otherwise, null. - GetTypeFromProgID(progID: str, server: str) -> Type - - Gets the type associated with the specified program identifier (progID) from the specified server, returning null if an error is encountered while loading the type. - - progID: The progID of the type to get. - server: The server from which to load the type. If the server name is null, this method automatically reverts to the local machine. - Returns: The type associated with the specified program identifier (progID), if progID is a valid entry in the registry and a type is associated with it; otherwise, null. - GetTypeFromProgID(progID: str, server: str, throwOnError: bool) -> Type - - Gets the type associated with the specified program identifier (progID) from the specified server, specifying whether to throw an exception if an error occurs while loading the type. - - progID: The progID of the System.Type to get. - server: The server from which to load the type. If the server name is null, this method automatically reverts to the local machine. - throwOnError: true to throw any exception that occurs.-or- false to ignore any exception that occurs. - Returns: The type associated with the specified program identifier (progID), if progID is a valid entry in the registry and a type is associated with it; otherwise, null. - """ - pass - - @staticmethod - def GetTypeHandle(o): - # type: (o: object) -> RuntimeTypeHandle - """ - GetTypeHandle(o: object) -> RuntimeTypeHandle - - Gets the handle for the System.Type of a specified object. - - o: The object for which to get the type handle. - Returns: The handle for the System.Type of the specified System.Object. - """ - pass - - def HasElementTypeImpl(self, *args): #cannot find CLR method - # type: (self: Type) -> bool - """ - HasElementTypeImpl(self: Type) -> bool - - When overridden in a derived class, implements the System.Type.HasElementType property and determines whether the current System.Type encompasses or refers to another type; that is, whether the current System.Type is an array, a pointer, or is passed - by reference. - - Returns: true if the System.Type is an array, a pointer, or is passed by reference; otherwise, false. - """ - pass - - def InvokeMember(self, name, invokeAttr, binder, target, args, *__args): - # type: (self: Type, name: str, invokeAttr: BindingFlags, binder: Binder, target: object, args: Array[object], modifiers: Array[ParameterModifier], culture: CultureInfo, namedParameters: Array[str]) -> object - """ - InvokeMember(self: Type, name: str, invokeAttr: BindingFlags, binder: Binder, target: object, args: Array[object], modifiers: Array[ParameterModifier], culture: CultureInfo, namedParameters: Array[str]) -> object - - When overridden in a derived class, invokes the specified member, using the specified binding constraints and matching the specified argument list, modifiers and culture. - - name: The string containing the name of the constructor, method, property, or field member to invoke.-or- An empty string ("") to invoke the default member. -or-For IDispatch members, a string representing the DispID, for example "[DispID=3]". - invokeAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. The access can be one of the BindingFlags such as Public, NonPublic, Private, InvokeMethod, GetField, and so on. The type of lookup need not be - specified. If the type of lookup is omitted, BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static are used. - - binder: An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.-or- A null reference (Nothing in Visual Basic), to use the - System.Type.DefaultBinder. Note that explicitly defining a System.Reflection.Binder object may be required for successfully invoking method overloads with variable arguments. - - target: The object on which to invoke the specified member. - args: An array containing the arguments to pass to the member to invoke. - modifiers: An array of System.Reflection.ParameterModifier objects representing the attributes associated with the corresponding element in the args array. A parameter's associated attributes are stored in the member's signature. The default binder processes - this parameter only when calling a COM component. - - culture: The System.Globalization.CultureInfo object representing the globalization locale to use, which may be necessary for locale-specific conversions, such as converting a numeric String to a Double.-or- A null reference (Nothing in Visual Basic) to use - the current thread's System.Globalization.CultureInfo. - - namedParameters: An array containing the names of the parameters to which the values in the args array are passed. - Returns: An object representing the return value of the invoked member. - InvokeMember(self: Type, name: str, invokeAttr: BindingFlags, binder: Binder, target: object, args: Array[object], culture: CultureInfo) -> object - - Invokes the specified member, using the specified binding constraints and matching the specified argument list and culture. - - name: The string containing the name of the constructor, method, property, or field member to invoke.-or- An empty string ("") to invoke the default member. -or-For IDispatch members, a string representing the DispID, for example "[DispID=3]". - invokeAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. The access can be one of the BindingFlags such as Public, NonPublic, Private, InvokeMethod, GetField, and so on. The type of lookup need not be - specified. If the type of lookup is omitted, BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static are used. - - binder: An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.-or- A null reference (Nothing in Visual Basic), to use the - System.Type.DefaultBinder. Note that explicitly defining a System.Reflection.Binder object may be required for successfully invoking method overloads with variable arguments. - - target: The object on which to invoke the specified member. - args: An array containing the arguments to pass to the member to invoke. - culture: The object representing the globalization locale to use, which may be necessary for locale-specific conversions, such as converting a numeric System.String to a System.Double.-or- A null reference (Nothing in Visual Basic) to use the current thread's - System.Globalization.CultureInfo. - - Returns: An object representing the return value of the invoked member. - InvokeMember(self: Type, name: str, invokeAttr: BindingFlags, binder: Binder, target: object, args: Array[object]) -> object - - Invokes the specified member, using the specified binding constraints and matching the specified argument list. - - name: The string containing the name of the constructor, method, property, or field member to invoke.-or- An empty string ("") to invoke the default member. -or-For IDispatch members, a string representing the DispID, for example "[DispID=3]". - invokeAttr: A bitmask comprised of one or more System.Reflection.BindingFlags that specify how the search is conducted. The access can be one of the BindingFlags such as Public, NonPublic, Private, InvokeMethod, GetField, and so on. The type of lookup need not be - specified. If the type of lookup is omitted, BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static are used. - - binder: An object that defines a set of properties and enables binding, which can involve selection of an overloaded method, coercion of argument types, and invocation of a member through reflection.-or- A null reference (Nothing in Visual Basic), to use the - System.Type.DefaultBinder. Note that explicitly defining a System.Reflection.Binder object may be required for successfully invoking method overloads with variable arguments. - - target: The object on which to invoke the specified member. - args: An array containing the arguments to pass to the member to invoke. - Returns: An object representing the return value of the invoked member. - """ - pass - - def IsArrayImpl(self, *args): #cannot find CLR method - # type: (self: Type) -> bool - """ - IsArrayImpl(self: Type) -> bool - - When overridden in a derived class, implements the System.Type.IsArray property and determines whether the System.Type is an array. - Returns: true if the System.Type is an array; otherwise, false. - """ - pass - - def IsAssignableFrom(self, c): - # type: (self: Type, c: Type) -> bool - """ - IsAssignableFrom(self: Type, c: Type) -> bool - - Determines whether an instance of the current System.Type can be assigned from an instance of the specified Type. - - c: The type to compare with the current type. - Returns: true if c and the current Type represent the same type, or if the current Type is in the inheritance hierarchy of c, or if the current Type is an interface that c implements, or if c is a generic type parameter and the current Type represents one of - the constraints of c. false if none of these conditions are true, or if c is null. - """ - pass - - def IsByRefImpl(self, *args): #cannot find CLR method - # type: (self: Type) -> bool - """ - IsByRefImpl(self: Type) -> bool - - When overridden in a derived class, implements the System.Type.IsByRef property and determines whether the System.Type is passed by reference. - Returns: true if the System.Type is passed by reference; otherwise, false. - """ - pass - - def IsCOMObjectImpl(self, *args): #cannot find CLR method - # type: (self: Type) -> bool - """ - IsCOMObjectImpl(self: Type) -> bool - - When overridden in a derived class, implements the System.Type.IsCOMObject property and determines whether the System.Type is a COM object. - Returns: true if the System.Type is a COM object; otherwise, false. - """ - pass - - def IsContextfulImpl(self, *args): #cannot find CLR method - # type: (self: Type) -> bool - """ - IsContextfulImpl(self: Type) -> bool - - Implements the System.Type.IsContextful property and determines whether the System.Type can be hosted in a context. - Returns: true if the System.Type can be hosted in a context; otherwise, false. - """ - pass - - def IsEnumDefined(self, value): - # type: (self: Type, value: object) -> bool - """ - IsEnumDefined(self: Type, value: object) -> bool - - Returns a value that indicates whether the specified value exists in the current enumeration type. - - value: The value to be tested. - Returns: true if the specified value is a member of the current enumeration type; otherwise, false. - """ - pass - - def IsEquivalentTo(self, other): - # type: (self: Type, other: Type) -> bool - """ - IsEquivalentTo(self: Type, other: Type) -> bool - - Determines whether two COM types have the same identity and are eligible for type equivalence. - - other: The COM type that is tested for equivalence with the current type. - Returns: true if the COM types are equivalent; otherwise, false. This method also returns false if one type is in an assembly that is loaded for execution, and the other is in an assembly that is loaded into the reflection-only context. - """ - pass - - def IsInstanceOfType(self, o): - # type: (self: Type, o: object) -> bool - """ - IsInstanceOfType(self: Type, o: object) -> bool - - Determines whether the specified object is an instance of the current System.Type. - - o: The object to compare with the current type. - Returns: true if the current Type is in the inheritance hierarchy of the object represented by o, or if the current Type is an interface that o supports. false if neither of these conditions is the case, or if o is null, or if the current Type is an open - generic type (that is, System.Type.ContainsGenericParameters returns true). - """ - pass - - def IsMarshalByRefImpl(self, *args): #cannot find CLR method - # type: (self: Type) -> bool - """ - IsMarshalByRefImpl(self: Type) -> bool - - Implements the System.Type.IsMarshalByRef property and determines whether the System.Type is marshaled by reference. - Returns: true if the System.Type is marshaled by reference; otherwise, false. - """ - pass - - def IsPointerImpl(self, *args): #cannot find CLR method - # type: (self: Type) -> bool - """ - IsPointerImpl(self: Type) -> bool - - When overridden in a derived class, implements the System.Type.IsPointer property and determines whether the System.Type is a pointer. - Returns: true if the System.Type is a pointer; otherwise, false. - """ - pass - - def IsPrimitiveImpl(self, *args): #cannot find CLR method - # type: (self: Type) -> bool - """ - IsPrimitiveImpl(self: Type) -> bool - - When overridden in a derived class, implements the System.Type.IsPrimitive property and determines whether the System.Type is one of the primitive types. - Returns: true if the System.Type is one of the primitive types; otherwise, false. - """ - pass - - def IsSubclassOf(self, c): - # type: (self: Type, c: Type) -> bool - """ - IsSubclassOf(self: Type, c: Type) -> bool - - Determines whether the class represented by the current System.Type derives from the class represented by the specified System.Type. - - c: The type to compare with the current type. - Returns: true if the Type represented by the c parameter and the current Type represent classes, and the class represented by the current Type derives from the class represented by c; otherwise, false. This method also returns false if c and the current Type - represent the same class. - """ - pass - - def IsValueTypeImpl(self, *args): #cannot find CLR method - # type: (self: Type) -> bool - """ - IsValueTypeImpl(self: Type) -> bool - - Implements the System.Type.IsValueType property and determines whether the System.Type is a value type; that is, not a class or an interface. - Returns: true if the System.Type is a value type; otherwise, false. - """ - pass - - def MakeArrayType(self, rank=None): - # type: (self: Type) -> Type - """ - MakeArrayType(self: Type) -> Type - - Returns a System.Type object representing a one-dimensional array of the current type, with a lower bound of zero. - Returns: A System.Type object representing a one-dimensional array of the current type, with a lower bound of zero. - MakeArrayType(self: Type, rank: int) -> Type - - Returns a System.Type object representing an array of the current type, with the specified number of dimensions. - - rank: The number of dimensions for the array. This number must be less than or equal to 32. - Returns: An object representing an array of the current type, with the specified number of dimensions. - """ - pass - - def MakeByRefType(self): - # type: (self: Type) -> Type - """ - MakeByRefType(self: Type) -> Type - - Returns a System.Type object that represents the current type when passed as a ref parameter (ByRef parameter in Visual Basic). - Returns: A System.Type object that represents the current type when passed as a ref parameter (ByRef parameter in Visual Basic). - """ - pass - - def MakeGenericType(self, typeArguments): - # type: (self: Type, *typeArguments: Array[Type]) -> Type - """ - MakeGenericType(self: Type, *typeArguments: Array[Type]) -> Type - - Substitutes the elements of an array of types for the type parameters of the current generic type definition and returns a System.Type object representing the resulting constructed type. - - typeArguments: An array of types to be substituted for the type parameters of the current generic type. - Returns: A System.Type representing the constructed type formed by substituting the elements of typeArguments for the type parameters of the current generic type. - """ - pass - - def MakePointerType(self): - # type: (self: Type) -> Type - """ - MakePointerType(self: Type) -> Type - - Returns a System.Type object that represents a pointer to the current type. - Returns: A System.Type object that represents a pointer to the current type. - """ - pass - - @staticmethod - def ReflectionOnlyGetType(typeName, throwIfNotFound, ignoreCase): - # type: (typeName: str, throwIfNotFound: bool, ignoreCase: bool) -> Type - """ - ReflectionOnlyGetType(typeName: str, throwIfNotFound: bool, ignoreCase: bool) -> Type - - Gets the System.Type with the specified name, specifying whether to perform a case-sensitive search and whether to throw an exception if the type is not found. The type is loaded for reflection only, not for execution. - - typeName: The assembly-qualified name of the System.Type to get. - throwIfNotFound: true to throw a System.TypeLoadException if the type cannot be found; false to return null if the type cannot be found. Specifying false also suppresses some other exception conditions, but not all of them. See the Exceptions section. - ignoreCase: true to perform a case-insensitive search for typeName; false to perform a case-sensitive search for typeName. - Returns: The type with the specified name, if found; otherwise, null. If the type is not found, the throwIfNotFound parameter specifies whether null is returned or an exception is thrown. In some cases, an exception is thrown regardless of the value of - throwIfNotFound. See the Exceptions section. - """ - pass - - def ToString(self): - # type: (self: Type) -> str - """ - ToString(self: Type) -> str - - Returns a String representing the name of the current Type. - Returns: A System.String representing the name of the current System.Type. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Assembly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the System.Reflection.Assembly in which the type is declared. For generic types, gets the System.Reflection.Assembly in which the generic type is defined. - - Get: Assembly(self: Type) -> Assembly - """ - - AssemblyQualifiedName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the assembly-qualified name of the System.Type, which includes the name of the assembly from which the System.Type was loaded. - - Get: AssemblyQualifiedName(self: Type) -> str - """ - - Attributes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the attributes associated with the System.Type. - - Get: Attributes(self: Type) -> TypeAttributes - """ - - BaseType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the type from which the current System.Type directly inherits. - - Get: BaseType(self: Type) -> Type - """ - - ContainsGenericParameters = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the current System.Type object has type parameters that have not been replaced by specific types. - - Get: ContainsGenericParameters(self: Type) -> bool - """ - - DeclaringMethod = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.Reflection.MethodBase that represents the declaring method, if the current System.Type represents a type parameter of a generic method. - - Get: DeclaringMethod(self: Type) -> MethodBase - """ - - DeclaringType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the type that declares the current nested type or generic type parameter. - - Get: DeclaringType(self: Type) -> Type - """ - - FullName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the fully qualified name of the System.Type, including the namespace of the System.Type but not the assembly. - - Get: FullName(self: Type) -> str - """ - - GenericParameterAttributes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a combination of System.Reflection.GenericParameterAttributes flags that describe the covariance and special constraints of the current generic type parameter. - - Get: GenericParameterAttributes(self: Type) -> GenericParameterAttributes - """ - - GenericParameterPosition = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the position of the type parameter in the type parameter list of the generic type or method that declared the parameter, when the System.Type object represents a type parameter of a generic type or a generic method. - - Get: GenericParameterPosition(self: Type) -> int - """ - - GenericTypeArguments = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Type) -> Array[Type] - """ Get: GenericTypeArguments(self: Type) -> Array[Type] """ - - GUID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the GUID associated with the System.Type. - - Get: GUID(self: Type) -> Guid - """ - - HasElementType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the current System.Type encompasses or refers to another type; that is, whether the current System.Type is an array, a pointer, or is passed by reference. - - Get: HasElementType(self: Type) -> bool - """ - - IsAbstract = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is abstract and must be overridden. - - Get: IsAbstract(self: Type) -> bool - """ - - IsAnsiClass = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the string format attribute AnsiClass is selected for the System.Type. - - Get: IsAnsiClass(self: Type) -> bool - """ - - IsArray = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is an array. - - Get: IsArray(self: Type) -> bool - """ - - IsAutoClass = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the string format attribute AutoClass is selected for the System.Type. - - Get: IsAutoClass(self: Type) -> bool - """ - - IsAutoLayout = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the class layout attribute AutoLayout is selected for the System.Type. - - Get: IsAutoLayout(self: Type) -> bool - """ - - IsByRef = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is passed by reference. - - Get: IsByRef(self: Type) -> bool - """ - - IsClass = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is a class; that is, not a value type or interface. - - Get: IsClass(self: Type) -> bool - """ - - IsCOMObject = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is a COM object. - - Get: IsCOMObject(self: Type) -> bool - """ - - IsConstructedGenericType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Type) -> bool - """ Get: IsConstructedGenericType(self: Type) -> bool """ - - IsContextful = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type can be hosted in a context. - - Get: IsContextful(self: Type) -> bool - """ - - IsEnum = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the current System.Type represents an enumeration. - - Get: IsEnum(self: Type) -> bool - """ - - IsExplicitLayout = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the class layout attribute ExplicitLayout is selected for the System.Type. - - Get: IsExplicitLayout(self: Type) -> bool - """ - - IsGenericParameter = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the current System.Type represents a type parameter in the definition of a generic type or method. - - Get: IsGenericParameter(self: Type) -> bool - """ - - IsGenericType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the current type is a generic type. - - Get: IsGenericType(self: Type) -> bool - """ - - IsGenericTypeDefinition = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the current System.Type represents a generic type definition, from which other generic types can be constructed. - - Get: IsGenericTypeDefinition(self: Type) -> bool - """ - - IsImport = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type has a System.Runtime.InteropServices.ComImportAttribute attribute applied, indicating that it was imported from a COM type library. - - Get: IsImport(self: Type) -> bool - """ - - IsInterface = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is an interface; that is, not a class or a value type. - - Get: IsInterface(self: Type) -> bool - """ - - IsLayoutSequential = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the class layout attribute SequentialLayout is selected for the System.Type. - - Get: IsLayoutSequential(self: Type) -> bool - """ - - IsMarshalByRef = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is marshaled by reference. - - Get: IsMarshalByRef(self: Type) -> bool - """ - - IsNested = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the current System.Type object represents a type whose definition is nested inside the definition of another type. - - Get: IsNested(self: Type) -> bool - """ - - IsNestedAssembly = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is nested and visible only within its own assembly. - - Get: IsNestedAssembly(self: Type) -> bool - """ - - IsNestedFamANDAssem = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is nested and visible only to classes that belong to both its own family and its own assembly. - - Get: IsNestedFamANDAssem(self: Type) -> bool - """ - - IsNestedFamily = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is nested and visible only within its own family. - - Get: IsNestedFamily(self: Type) -> bool - """ - - IsNestedFamORAssem = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is nested and visible only to classes that belong to either its own family or to its own assembly. - - Get: IsNestedFamORAssem(self: Type) -> bool - """ - - IsNestedPrivate = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is nested and declared private. - - Get: IsNestedPrivate(self: Type) -> bool - """ - - IsNestedPublic = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether a class is nested and declared public. - - Get: IsNestedPublic(self: Type) -> bool - """ - - IsNotPublic = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is not declared public. - - Get: IsNotPublic(self: Type) -> bool - """ - - IsPointer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is a pointer. - - Get: IsPointer(self: Type) -> bool - """ - - IsPrimitive = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is one of the primitive types. - - Get: IsPrimitive(self: Type) -> bool - """ - - IsPublic = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is declared public. - - Get: IsPublic(self: Type) -> bool - """ - - IsSealed = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is declared sealed. - - Get: IsSealed(self: Type) -> bool - """ - - IsSecurityCritical = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the current type is security-critical or security-safe-critical at the current trust level, and therefore can perform critical operations. - - Get: IsSecurityCritical(self: Type) -> bool - """ - - IsSecuritySafeCritical = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the current type is security-safe-critical at the current trust level; that is, whether it can perform critical operations and can be accessed by transparent code. - - Get: IsSecuritySafeCritical(self: Type) -> bool - """ - - IsSecurityTransparent = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value that indicates whether the current type is transparent at the current trust level, and therefore cannot perform critical operations. - - Get: IsSecurityTransparent(self: Type) -> bool - """ - - IsSerializable = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is serializable. - - Get: IsSerializable(self: Type) -> bool - """ - - IsSpecialName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type has a name that requires special handling. - - Get: IsSpecialName(self: Type) -> bool - """ - - IsUnicodeClass = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the string format attribute UnicodeClass is selected for the System.Type. - - Get: IsUnicodeClass(self: Type) -> bool - """ - - IsValueType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type is a value type. - - Get: IsValueType(self: Type) -> bool - """ - - IsVisible = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the System.Type can be accessed by code outside the assembly. - - Get: IsVisible(self: Type) -> bool - """ - - MemberType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.Reflection.MemberTypes value indicating that this member is a type or a nested type. - - Get: MemberType(self: Type) -> MemberTypes - """ - - Module = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (the DLL) in which the current System.Type is defined. - """ - Gets the module (the DLL) in which the current System.Type is defined. - - Get: Module(self: Type) -> Module - """ - - Namespace = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the namespace of the System.Type. - - Get: Namespace(self: Type) -> str - """ - - ReflectedType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the class object that was used to obtain this member. - - Get: ReflectedType(self: Type) -> Type - """ - - StructLayoutAttribute = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a System.Runtime.InteropServices.StructLayoutAttribute that describes the layout of the current type. - - Get: StructLayoutAttribute(self: Type) -> StructLayoutAttribute - """ - - TypeHandle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the handle for the current System.Type. - - Get: TypeHandle(self: Type) -> RuntimeTypeHandle - """ - - TypeInitializer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the initializer for the System.Type. - - Get: TypeInitializer(self: Type) -> ConstructorInfo - """ - - UnderlyingSystemType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Indicates the type provided by the common language runtime that represents this type. - - Get: UnderlyingSystemType(self: Type) -> Type - """ - - - DefaultBinder = None - Delimiter = None - EmptyTypes = None - Missing = None - - -class TypeAccessException(TypeLoadException, ISerializable, _Exception): - """ - The exception that is thrown when a method attempts to use a type that it does not have access to. - - TypeAccessException() - TypeAccessException(message: str) - TypeAccessException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class TypeCode(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies the type of an object. - - enum TypeCode, values: Boolean (3), Byte (6), Char (4), DateTime (16), DBNull (2), Decimal (15), Double (14), Empty (0), Int16 (7), Int32 (9), Int64 (11), Object (1), SByte (5), Single (13), String (18), UInt16 (8), UInt32 (10), UInt64 (12) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Boolean = None - Byte = None - Char = None - DateTime = None - DBNull = None - Decimal = None - Double = None - Empty = None - Int16 = None - Int32 = None - Int64 = None - Object = None - SByte = None - Single = None - String = None - UInt16 = None - UInt32 = None - UInt64 = None - value__ = None - - -class TypedReference(object): - """ Describes objects that contain both a managed pointer to a location and a runtime representation of the type that may be stored at that location. """ - def Equals(self, o): - # type: (self: TypedReference, o: object) -> bool - """ - Equals(self: TypedReference, o: object) -> bool - - Checks if this object is equal to the specified object. - - o: The object with which to compare the current object. - Returns: true if this object is equal to the specified object; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: TypedReference) -> int - """ - GetHashCode(self: TypedReference) -> int - - Returns the hash code of this object. - Returns: The hash code of this object. - """ - pass - - @staticmethod - def GetTargetType(value): - # type: (value: TypedReference) -> Type - """ - GetTargetType(value: TypedReference) -> Type - - Returns the type of the target of the specified TypedReference. - - value: The value whose target's type is to be returned. - Returns: The type of the target of the specified TypedReference. - """ - pass - - @staticmethod - def MakeTypedReference(target, flds): - # type: (target: object, flds: Array[FieldInfo]) -> TypedReference - """ - MakeTypedReference(target: object, flds: Array[FieldInfo]) -> TypedReference - - Makes a TypedReference for a field identified by a specified object and list of field descriptions. - - target: An object that contains the field described by the first element of flds. - flds: A list of field descriptions where each element describes a field that contains the field described by the succeeding element. Each described field must be a value type. The field descriptions must be RuntimeFieldInfo objects supplied by the type - system. - - Returns: A System.TypedReference for the field described by the last element of flds. - """ - pass - - @staticmethod - def SetTypedReference(target, value): - # type: (target: TypedReference, value: object) - """ - SetTypedReference(target: TypedReference, value: object) - Converts the specified value to a TypedReference. This method is not supported. - - target: The target of the conversion. - value: The value to be converted. - """ - pass - - @staticmethod - def TargetTypeToken(value): - # type: (value: TypedReference) -> RuntimeTypeHandle - """ - TargetTypeToken(value: TypedReference) -> RuntimeTypeHandle - - Returns the internal metadata type handle for the specified TypedReference. - - value: The TypedReference for which the type handle is requested. - Returns: The internal metadata type handle for the specified TypedReference. - """ - pass - - @staticmethod - def ToObject(value): - # type: (value: TypedReference) -> object - """ - ToObject(value: TypedReference) -> object - - Converts the specified TypedReference to an Object. - - value: The TypedReference to be converted. - Returns: An System.Object converted from a TypedReference. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - -class TypeInitializationException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown as a wrapper around the exception thrown by the class initializer. This class cannot be inherited. - - TypeInitializationException(fullTypeName: str, innerException: Exception) - """ - def GetObjectData(self, info, context): - # type: (self: TypeInitializationException, info: SerializationInfo, context: StreamingContext) - """ - GetObjectData(self: TypeInitializationException, info: SerializationInfo, context: StreamingContext) - Sets the System.Runtime.Serialization.SerializationInfo object with the type name and additional exception information. - - info: The System.Runtime.Serialization.SerializationInfo that holds the serialized object data about the exception being thrown. - context: The System.Runtime.Serialization.StreamingContext that contains contextual information about the source or destination. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, fullTypeName, innerException): - """ __new__(cls: type, fullTypeName: str, innerException: Exception) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - TypeName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the fully qualified name of the type that fails to initialize. - - Get: TypeName(self: TypeInitializationException) -> str - """ - - - SerializeObjectState = None - - -class TypeUnloadedException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when there is an attempt to access an unloaded class. - - TypeUnloadedException() - TypeUnloadedException(message: str) - TypeUnloadedException(message: str, innerException: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, innerException=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, innerException: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class UInt16(object, IComparable, IFormattable, IConvertible, IComparable[UInt16], IEquatable[UInt16]): - """ Represents a 16-bit unsigned integer. """ - def bit_length(self, *args): #cannot find CLR method - # type: (value: UInt16) -> int - """ bit_length(value: UInt16) -> int """ - pass - - def CompareTo(self, value): - # type: (self: UInt16, value: object) -> int - """ - CompareTo(self: UInt16, value: object) -> int - - Compares this instance to a specified object and returns an indication of their relative values. - - value: An object to compare, or null. - Returns: A signed number indicating the relative values of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.-or- value - is null. - - CompareTo(self: UInt16, value: UInt16) -> int - - Compares this instance to a specified 16-bit unsigned integer and returns an indication of their relative values. - - value: An unsigned integer to compare. - Returns: A signed number indicating the relative values of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value. - """ - pass - - def conjugate(self, *args): #cannot find CLR method - # type: (x: UInt16) -> UInt16 - """ conjugate(x: UInt16) -> UInt16 """ - pass - - def Equals(self, obj): - # type: (self: UInt16, obj: object) -> bool - """ - Equals(self: UInt16, obj: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - obj: An object to compare to this instance. - Returns: true if obj is an instance of System.UInt16 and equals the value of this instance; otherwise, false. - Equals(self: UInt16, obj: UInt16) -> bool - - Returns a value indicating whether this instance is equal to a specified System.UInt16 value. - - obj: A 16-bit unsigned integer to compare to this instance. - Returns: true if obj has the same value as this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: UInt16) -> int - """ - GetHashCode(self: UInt16) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetTypeCode(self): - # type: (self: UInt16) -> TypeCode - """ - GetTypeCode(self: UInt16) -> TypeCode - - Returns the System.TypeCode for value type System.UInt16. - Returns: The enumerated constant, System.TypeCode.UInt16. - """ - pass - - @staticmethod - def Parse(s, *__args): - # type: (s: str) -> UInt16 - """ - Parse(s: str) -> UInt16 - - Converts the string representation of a number to its 16-bit unsigned integer equivalent. - - s: A string that represents the number to convert. - Returns: A 16-bit unsigned integer equivalent to the number contained in s. - Parse(s: str, style: NumberStyles) -> UInt16 - - Converts the string representation of a number in a specified style to its 16-bit unsigned integer equivalent. - - s: A string that represents the number to convert. The string is interpreted by using the style specified by the style parameter. - style: A bitwise combination of the enumeration values that specify the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Integer. - Returns: A 16-bit unsigned integer equivalent to the number specified in s. - Parse(s: str, provider: IFormatProvider) -> UInt16 - - Converts the string representation of a number in a specified culture-specific format to its 16-bit unsigned integer equivalent. - - s: A string that represents the number to convert. - provider: An object that supplies culture-specific formatting information about s. - Returns: A 16-bit unsigned integer equivalent to the number specified in s. - Parse(s: str, style: NumberStyles, provider: IFormatProvider) -> UInt16 - - Converts the string representation of a number in a specified style and culture-specific format to its 16-bit unsigned integer equivalent. - - s: A string that represents the number to convert. The string is interpreted by using the style specified by the style parameter. - style: A bitwise combination of enumeration values that indicate the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific formatting information about s. - Returns: A 16-bit unsigned integer equivalent to the number specified in s. - """ - pass - - def ToString(self, *__args): - # type: (self: UInt16) -> str - """ - ToString(self: UInt16) -> str - - Converts the numeric value of this instance to its equivalent string representation. - Returns: The string representation of the value of this instance, which consists of a sequence of digits ranging from 0 to 9, without a sign or leading zeros. - ToString(self: UInt16, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information. - - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance, which consists of a sequence of digits ranging from 0 to 9, without a sign or leading zeros. - ToString(self: UInt16, format: str) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified format. - - format: A numeric format string. - Returns: The string representation of the value of this instance as specified by format. - ToString(self: UInt16, format: str, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information. - - format: A numeric format string. - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance, as specified by format and provider. - """ - pass - - @staticmethod - def TryParse(s, *__args): - # type: (s: str) -> (bool, UInt16) - """ - TryParse(s: str) -> (bool, UInt16) - - Tries to convert the string representation of a number to its 16-bit unsigned integer equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string that represents the number to convert. - Returns: true if s was converted successfully; otherwise, false. - TryParse(s: str, style: NumberStyles, provider: IFormatProvider) -> (bool, UInt16) - - Tries to convert the string representation of a number in a specified style and culture-specific format to its 16-bit unsigned integer equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string that represents the number to convert. The string is interpreted by using the style specified by the style parameter. - style: A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific formatting information about s. - Returns: true if s was converted successfully; otherwise, false. - """ - pass - - def __abs__(self, *args): #cannot find CLR method - """ x.__abs__() <==> abs(x) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+yx.__add__(y) <==> x+y """ - pass - - def __and__(self, *args): #cannot find CLR method - """ - __and__(x: UInt16, y: UInt16) -> UInt16 - __and__(x: UInt16, y: Int16) -> int - """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y)x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/yx.__div__(y) <==> x/y """ - pass - - def __float__(self, *args): #cannot find CLR method - """ __float__(x: UInt16) -> float """ - pass - - def __floordiv__(self, *args): #cannot find CLR method - """ x.__floordiv__(y) <==> x//yx.__floordiv__(y) <==> x//y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __hex__(self, *args): #cannot find CLR method - """ __hex__(value: UInt16) -> str """ - pass - - def __index__(self, *args): #cannot find CLR method - """ __index__(x: UInt16) -> int """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(x: UInt16) -> int """ - pass - - def __invert__(self, *args): #cannot find CLR method - """ __invert__(x: UInt16) -> object """ - pass - - def __lshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x< x< x%yx.__mod__(y) <==> x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*yx.__mul__(y) <==> x*y """ - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) -> object - __new__(cls: type, value: object) -> object - """ - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(x: UInt16) -> bool """ - pass - - def __or__(self, *args): #cannot find CLR method - """ - __or__(x: UInt16, y: UInt16) -> UInt16 - __or__(x: UInt16, y: Int16) -> int - """ - pass - - def __pos__(self, *args): #cannot find CLR method - """ __pos__(x: UInt16) -> UInt16 """ - pass - - def __pow__(self, *args): #cannot find CLR method - """ x.__pow__(y[, z]) <==> pow(x, y[, z])x.__pow__(y[, z]) <==> pow(x, y[, z]) """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ - __radd__(x: UInt16, y: UInt16) -> object - __radd__(x: Int16, y: UInt16) -> object - """ - pass - - def __rand__(self, *args): #cannot find CLR method - """ - __rand__(x: UInt16, y: UInt16) -> UInt16 - __rand__(x: Int16, y: UInt16) -> int - """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ - __rdiv__(x: UInt16, y: UInt16) -> object - __rdiv__(x: Int16, y: UInt16) -> object - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(x: UInt16) -> str """ - pass - - def __rfloordiv__(self, *args): #cannot find CLR method - """ - __rfloordiv__(x: UInt16, y: UInt16) -> UInt16 - __rfloordiv__(x: Int16, y: UInt16) -> object - """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ - __rmod__(x: UInt16, y: UInt16) -> UInt16 - __rmod__(x: Int16, y: UInt16) -> int - """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ - __rmul__(x: UInt16, y: UInt16) -> object - __rmul__(x: Int16, y: UInt16) -> object - """ - pass - - def __ror__(self, *args): #cannot find CLR method - """ - __ror__(x: UInt16, y: UInt16) -> UInt16 - __ror__(x: Int16, y: UInt16) -> int - """ - pass - - def __rpow__(self, *args): #cannot find CLR method - """ - __rpow__(x: UInt16, y: UInt16) -> object - __rpow__(x: Int16, y: UInt16) -> object - """ - pass - - def __rshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x>>yx.__rshift__(y) <==> x>>y """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ - __rsub__(x: UInt16, y: UInt16) -> object - __rsub__(x: Int16, y: UInt16) -> object - """ - pass - - def __rtruediv__(self, *args): #cannot find CLR method - """ - __rtruediv__(x: UInt16, y: UInt16) -> float - __rtruediv__(x: Int16, y: UInt16) -> float - """ - pass - - def __rxor__(self, *args): #cannot find CLR method - """ - __rxor__(x: UInt16, y: UInt16) -> UInt16 - __rxor__(x: Int16, y: UInt16) -> int - """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-yx.__sub__(y) <==> x-y """ - pass - - def __truediv__(self, *args): #cannot find CLR method - """ x.__truediv__(y) <==> x/yx.__truediv__(y) <==> x/y """ - pass - - def __trunc__(self, *args): #cannot find CLR method - """ __trunc__(x: UInt16) -> UInt16 """ - pass - - def __xor__(self, *args): #cannot find CLR method - """ - __xor__(x: UInt16, y: UInt16) -> UInt16 - __xor__(x: UInt16, y: Int16) -> int - """ - pass - - denominator = None - imag = None - MaxValue = None - MinValue = None - numerator = None - real = None - - -class UInt32(object, IComparable, IFormattable, IConvertible, IComparable[UInt32], IEquatable[UInt32]): - """ Represents a 32-bit unsigned integer. """ - def bit_length(self, *args): #cannot find CLR method - # type: (value: UInt32) -> int - """ bit_length(value: UInt32) -> int """ - pass - - def CompareTo(self, value): - # type: (self: UInt32, value: object) -> int - """ - CompareTo(self: UInt32, value: object) -> int - - Compares this instance to a specified object and returns an indication of their relative values. - - value: An object to compare, or null. - Returns: A signed number indicating the relative values of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.-or- value - is null. - - CompareTo(self: UInt32, value: UInt32) -> int - - Compares this instance to a specified 32-bit unsigned integer and returns an indication of their relative values. - - value: An unsigned integer to compare. - Returns: A signed number indicating the relative values of this instance and value.Return value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value. - """ - pass - - def conjugate(self, *args): #cannot find CLR method - # type: (x: UInt32) -> UInt32 - """ conjugate(x: UInt32) -> UInt32 """ - pass - - def Equals(self, obj): - # type: (self: UInt32, obj: object) -> bool - """ - Equals(self: UInt32, obj: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - obj: An object to compare with this instance. - Returns: true if obj is an instance of System.UInt32 and equals the value of this instance; otherwise, false. - Equals(self: UInt32, obj: UInt32) -> bool - - Returns a value indicating whether this instance is equal to a specified System.UInt32. - - obj: A value to compare to this instance. - Returns: true if obj has the same value as this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: UInt32) -> int - """ - GetHashCode(self: UInt32) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetTypeCode(self): - # type: (self: UInt32) -> TypeCode - """ - GetTypeCode(self: UInt32) -> TypeCode - - Returns the System.TypeCode for value type System.UInt32. - Returns: The enumerated constant, System.TypeCode.UInt32. - """ - pass - - @staticmethod - def Parse(s, *__args): - # type: (s: str) -> UInt32 - """ - Parse(s: str) -> UInt32 - - Converts the string representation of a number to its 32-bit unsigned integer equivalent. - - s: A string representing the number to convert. - Returns: A 32-bit unsigned integer equivalent to the number contained in s. - Parse(s: str, style: NumberStyles) -> UInt32 - - Converts the string representation of a number in a specified style to its 32-bit unsigned integer equivalent. - - s: A string representing the number to convert. The string is interpreted by using the style specified by the style parameter. - style: A bitwise combination of the enumeration values that specify the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Integer. - Returns: A 32-bit unsigned integer equivalent to the number specified in s. - Parse(s: str, provider: IFormatProvider) -> UInt32 - - Converts the string representation of a number in a specified culture-specific format to its 32-bit unsigned integer equivalent. - - s: A string that represents the number to convert. - provider: An object that supplies culture-specific formatting information about s. - Returns: A 32-bit unsigned integer equivalent to the number specified in s. - Parse(s: str, style: NumberStyles, provider: IFormatProvider) -> UInt32 - - Converts the string representation of a number in a specified style and culture-specific format to its 32-bit unsigned integer equivalent. - - s: A string representing the number to convert. The string is interpreted by using the style specified by the style parameter. - style: A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific formatting information about s. - Returns: A 32-bit unsigned integer equivalent to the number specified in s. - """ - pass - - def ToString(self, *__args): - # type: (self: UInt32) -> str - """ - ToString(self: UInt32) -> str - - Converts the numeric value of this instance to its equivalent string representation. - Returns: The string representation of the value of this instance, consisting of a sequence of digits ranging from 0 to 9, without a sign or leading zeroes. - ToString(self: UInt32, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information. - - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance, which consists of a sequence of digits ranging from 0 to 9, without a sign or leading zeros. - ToString(self: UInt32, format: str) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified format. - - format: A numeric format string. - Returns: The string representation of the value of this instance as specified by format. - ToString(self: UInt32, format: str, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information. - - format: A numeric format string. - provider: An object that supplies culture-specific formatting information about this instance. - Returns: The string representation of the value of this instance as specified by format and provider. - """ - pass - - @staticmethod - def TryParse(s, *__args): - # type: (s: str) -> (bool, UInt32) - """ - TryParse(s: str) -> (bool, UInt32) - - Tries to convert the string representation of a number to its 32-bit unsigned integer equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string that represents the number to convert. - Returns: true if s was converted successfully; otherwise, false. - TryParse(s: str, style: NumberStyles, provider: IFormatProvider) -> (bool, UInt32) - - Tries to convert the string representation of a number in a specified style and culture-specific format to its 32-bit unsigned integer equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string that represents the number to convert. The string is interpreted by using the style specified by the style parameter. - style: A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific formatting information about s. - Returns: true if s was converted successfully; otherwise, false. - """ - pass - - def __abs__(self, *args): #cannot find CLR method - """ x.__abs__() <==> abs(x) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+yx.__add__(y) <==> x+y """ - pass - - def __and__(self, *args): #cannot find CLR method - """ - __and__(x: UInt32, y: UInt32) -> UInt32 - __and__(x: UInt32, y: int) -> Int64 - """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y)x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/yx.__div__(y) <==> x/y """ - pass - - def __float__(self, *args): #cannot find CLR method - """ __float__(x: UInt32) -> float """ - pass - - def __floordiv__(self, *args): #cannot find CLR method - """ x.__floordiv__(y) <==> x//yx.__floordiv__(y) <==> x//y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __hex__(self, *args): #cannot find CLR method - """ __hex__(value: UInt32) -> str """ - pass - - def __index__(self, *args): #cannot find CLR method - """ __index__(x: UInt32) -> int """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(x: UInt32) -> int """ - pass - - def __invert__(self, *args): #cannot find CLR method - """ __invert__(x: UInt32) -> object """ - pass - - def __lshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x< x%yx.__mod__(y) <==> x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*yx.__mul__(y) <==> x*y """ - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) -> object - __new__(cls: type, value: object) -> object - """ - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(x: UInt32) -> bool """ - pass - - def __or__(self, *args): #cannot find CLR method - """ - __or__(x: UInt32, y: UInt32) -> UInt32 - __or__(x: UInt32, y: int) -> Int64 - """ - pass - - def __pos__(self, *args): #cannot find CLR method - """ __pos__(x: UInt32) -> UInt32 """ - pass - - def __pow__(self, *args): #cannot find CLR method - """ x.__pow__(y[, z]) <==> pow(x, y[, z])x.__pow__(y[, z]) <==> pow(x, y[, z]) """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ - __radd__(x: UInt32, y: UInt32) -> object - __radd__(x: int, y: UInt32) -> object - """ - pass - - def __rand__(self, *args): #cannot find CLR method - """ - __rand__(x: UInt32, y: UInt32) -> UInt32 - __rand__(x: int, y: UInt32) -> Int64 - """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ - __rdiv__(x: UInt32, y: UInt32) -> object - __rdiv__(x: int, y: UInt32) -> object - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(x: UInt32) -> str """ - pass - - def __rfloordiv__(self, *args): #cannot find CLR method - """ - __rfloordiv__(x: UInt32, y: UInt32) -> UInt32 - __rfloordiv__(x: int, y: UInt32) -> object - """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ - __rmod__(x: UInt32, y: UInt32) -> UInt32 - __rmod__(x: int, y: UInt32) -> Int64 - """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ - __rmul__(x: UInt32, y: UInt32) -> object - __rmul__(x: int, y: UInt32) -> object - """ - pass - - def __ror__(self, *args): #cannot find CLR method - """ - __ror__(x: UInt32, y: UInt32) -> UInt32 - __ror__(x: int, y: UInt32) -> Int64 - """ - pass - - def __rpow__(self, *args): #cannot find CLR method - """ - __rpow__(x: UInt32, y: UInt32) -> object - __rpow__(x: int, y: UInt32) -> object - """ - pass - - def __rshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x>>y """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ - __rsub__(x: UInt32, y: UInt32) -> object - __rsub__(x: int, y: UInt32) -> object - """ - pass - - def __rtruediv__(self, *args): #cannot find CLR method - """ - __rtruediv__(x: UInt32, y: UInt32) -> float - __rtruediv__(x: int, y: UInt32) -> float - """ - pass - - def __rxor__(self, *args): #cannot find CLR method - """ - __rxor__(x: UInt32, y: UInt32) -> UInt32 - __rxor__(x: int, y: UInt32) -> Int64 - """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-yx.__sub__(y) <==> x-y """ - pass - - def __truediv__(self, *args): #cannot find CLR method - """ x.__truediv__(y) <==> x/yx.__truediv__(y) <==> x/y """ - pass - - def __trunc__(self, *args): #cannot find CLR method - """ __trunc__(x: UInt32) -> UInt32 """ - pass - - def __xor__(self, *args): #cannot find CLR method - """ - __xor__(x: UInt32, y: UInt32) -> UInt32 - __xor__(x: UInt32, y: int) -> Int64 - """ - pass - - denominator = None - imag = None - MaxValue = None - MinValue = None - numerator = None - real = None - - -class UInt64(object, IComparable, IFormattable, IConvertible, IComparable[UInt64], IEquatable[UInt64]): - """ Represents a 64-bit unsigned integer. """ - def bit_length(self, *args): #cannot find CLR method - # type: (value: UInt64) -> int - """ bit_length(value: UInt64) -> int """ - pass - - def CompareTo(self, value): - # type: (self: UInt64, value: object) -> int - """ - CompareTo(self: UInt64, value: object) -> int - - Compares this instance to a specified object and returns an indication of their relative values. - - value: An object to compare, or null. - Returns: A signed number indicating the relative values of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value.-or- value - is null. - - CompareTo(self: UInt64, value: UInt64) -> int - - Compares this instance to a specified 64-bit unsigned integer and returns an indication of their relative values. - - value: An unsigned integer to compare. - Returns: A signed number indicating the relative values of this instance and value.Return Value Description Less than zero This instance is less than value. Zero This instance is equal to value. Greater than zero This instance is greater than value. - """ - pass - - def conjugate(self, *args): #cannot find CLR method - # type: (x: UInt64) -> UInt64 - """ conjugate(x: UInt64) -> UInt64 """ - pass - - def Equals(self, obj): - # type: (self: UInt64, obj: object) -> bool - """ - Equals(self: UInt64, obj: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - obj: An object to compare to this instance. - Returns: true if obj is an instance of System.UInt64 and equals the value of this instance; otherwise, false. - Equals(self: UInt64, obj: UInt64) -> bool - - Returns a value indicating whether this instance is equal to a specified System.UInt64 value. - - obj: A System.UInt64 value to compare to this instance. - Returns: true if obj has the same value as this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: UInt64) -> int - """ - GetHashCode(self: UInt64) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - def GetTypeCode(self): - # type: (self: UInt64) -> TypeCode - """ - GetTypeCode(self: UInt64) -> TypeCode - - Returns the System.TypeCode for value type System.UInt64. - Returns: The enumerated constant, System.TypeCode.UInt64. - """ - pass - - @staticmethod - def Parse(s, *__args): - # type: (s: str) -> UInt64 - """ - Parse(s: str) -> UInt64 - - Converts the string representation of a number to its 64-bit unsigned integer equivalent. - - s: A string that represents the number to convert. - Returns: A 64-bit unsigned integer equivalent to the number contained in s. - Parse(s: str, style: NumberStyles) -> UInt64 - - Converts the string representation of a number in a specified style to its 64-bit unsigned integer equivalent. - - s: A string that represents the number to convert. The string is interpreted by using the style specified by the style parameter. - style: A bitwise combination of the enumeration values that specifies the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Integer. - Returns: A 64-bit unsigned integer equivalent to the number specified in s. - Parse(s: str, provider: IFormatProvider) -> UInt64 - - Converts the string representation of a number in a specified culture-specific format to its 64-bit unsigned integer equivalent. - - s: A string that represents the number to convert. - provider: An object that supplies culture-specific formatting information about s. - Returns: A 64-bit unsigned integer equivalent to the number specified in s. - Parse(s: str, style: NumberStyles, provider: IFormatProvider) -> UInt64 - - Converts the string representation of a number in a specified style and culture-specific format to its 64-bit unsigned integer equivalent. - - s: A string that represents the number to convert. The string is interpreted by using the style specified by the style parameter. - style: A bitwise combination of enumeration values that indicates the style elements that can be present in s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific formatting information about s. - Returns: A 64-bit unsigned integer equivalent to the number specified in s. - """ - pass - - def ToString(self, *__args): - # type: (self: UInt64) -> str - """ - ToString(self: UInt64) -> str - - Converts the numeric value of this instance to its equivalent string representation. - Returns: The string representation of the value of this instance, consisting of a sequence of digits ranging from 0 to 9, without a sign or leading zeroes. - ToString(self: UInt64, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified culture-specific format information. - - provider: An object that supplies culture-specific formatting information. - Returns: The string representation of the value of this instance as specified by provider. - ToString(self: UInt64, format: str) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified format. - - format: A numeric format string. - Returns: The string representation of the value of this instance as specified by format. - ToString(self: UInt64, format: str, provider: IFormatProvider) -> str - - Converts the numeric value of this instance to its equivalent string representation using the specified format and culture-specific format information. - - format: A numeric format string. - provider: An object that supplies culture-specific formatting information about this instance. - Returns: The string representation of the value of this instance as specified by format and provider. - """ - pass - - @staticmethod - def TryParse(s, *__args): - # type: (s: str) -> (bool, UInt64) - """ - TryParse(s: str) -> (bool, UInt64) - - Tries to convert the string representation of a number to its 64-bit unsigned integer equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string that represents the number to convert. - Returns: true if s was converted successfully; otherwise, false. - TryParse(s: str, style: NumberStyles, provider: IFormatProvider) -> (bool, UInt64) - - Tries to convert the string representation of a number in a specified style and culture-specific format to its 64-bit unsigned integer equivalent. A return value indicates whether the conversion succeeded or failed. - - s: A string that represents the number to convert. The string is interpreted by using the style specified by the style parameter. - style: A bitwise combination of enumeration values that indicates the permitted format of s. A typical value to specify is System.Globalization.NumberStyles.Integer. - provider: An object that supplies culture-specific formatting information about s. - Returns: true if s was converted successfully; otherwise, false. - """ - pass - - def __abs__(self, *args): #cannot find CLR method - """ x.__abs__() <==> abs(x) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+yx.__add__(y) <==> x+y """ - pass - - def __and__(self, *args): #cannot find CLR method - """ - __and__(x: UInt64, y: UInt64) -> UInt64 - __and__(x: UInt64, y: Int64) -> long - """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y)x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/yx.__div__(y) <==> x/y """ - pass - - def __float__(self, *args): #cannot find CLR method - """ __float__(x: UInt64) -> float """ - pass - - def __floordiv__(self, *args): #cannot find CLR method - """ x.__floordiv__(y) <==> x//yx.__floordiv__(y) <==> x//y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __hash__(self, *args): #cannot find CLR method - """ x.__hash__() <==> hash(x) """ - pass - - def __hex__(self, *args): #cannot find CLR method - """ __hex__(value: UInt64) -> str """ - pass - - def __index__(self, *args): #cannot find CLR method - """ __index__(x: UInt64) -> long """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(x: UInt64) -> int """ - pass - - def __invert__(self, *args): #cannot find CLR method - """ __invert__(x: UInt64) -> object """ - pass - - def __lshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x< x%yx.__mod__(y) <==> x%y """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*yx.__mul__(y) <==> x*y """ - pass - - def __neg__(self, *args): #cannot find CLR method - """ x.__neg__() <==> -x """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *args): #cannot find CLR constructor - """ - __new__(cls: type) -> object - __new__(cls: type, value: object) -> object - """ - pass - - def __nonzero__(self, *args): #cannot find CLR method - """ __nonzero__(x: UInt64) -> bool """ - pass - - def __or__(self, *args): #cannot find CLR method - """ - __or__(x: UInt64, y: UInt64) -> UInt64 - __or__(x: UInt64, y: Int64) -> long - """ - pass - - def __pos__(self, *args): #cannot find CLR method - """ __pos__(x: UInt64) -> UInt64 """ - pass - - def __pow__(self, *args): #cannot find CLR method - """ x.__pow__(y[, z]) <==> pow(x, y[, z])x.__pow__(y[, z]) <==> pow(x, y[, z]) """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ - __radd__(x: UInt64, y: UInt64) -> object - __radd__(x: Int64, y: UInt64) -> object - """ - pass - - def __rand__(self, *args): #cannot find CLR method - """ - __rand__(x: UInt64, y: UInt64) -> UInt64 - __rand__(x: Int64, y: UInt64) -> long - """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ - __rdiv__(x: UInt64, y: UInt64) -> object - __rdiv__(x: Int64, y: UInt64) -> object - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(x: UInt64) -> str """ - pass - - def __rfloordiv__(self, *args): #cannot find CLR method - """ - __rfloordiv__(x: UInt64, y: UInt64) -> UInt64 - __rfloordiv__(x: Int64, y: UInt64) -> object - """ - pass - - def __rmod__(self, *args): #cannot find CLR method - """ - __rmod__(x: UInt64, y: UInt64) -> UInt64 - __rmod__(x: Int64, y: UInt64) -> long - """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ - __rmul__(x: UInt64, y: UInt64) -> object - __rmul__(x: Int64, y: UInt64) -> object - """ - pass - - def __ror__(self, *args): #cannot find CLR method - """ - __ror__(x: UInt64, y: UInt64) -> UInt64 - __ror__(x: Int64, y: UInt64) -> long - """ - pass - - def __rpow__(self, *args): #cannot find CLR method - """ - __rpow__(x: UInt64, y: UInt64) -> object - __rpow__(x: Int64, y: UInt64) -> object - """ - pass - - def __rshift__(self, *args): #cannot find CLR method - """ x.__rshift__(y) <==> x>>y """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ - __rsub__(x: UInt64, y: UInt64) -> object - __rsub__(x: Int64, y: UInt64) -> object - """ - pass - - def __rtruediv__(self, *args): #cannot find CLR method - """ - __rtruediv__(x: UInt64, y: UInt64) -> float - __rtruediv__(x: Int64, y: UInt64) -> float - """ - pass - - def __rxor__(self, *args): #cannot find CLR method - """ - __rxor__(x: UInt64, y: UInt64) -> UInt64 - __rxor__(x: Int64, y: UInt64) -> long - """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-yx.__sub__(y) <==> x-y """ - pass - - def __truediv__(self, *args): #cannot find CLR method - """ x.__truediv__(y) <==> x/yx.__truediv__(y) <==> x/y """ - pass - - def __trunc__(self, *args): #cannot find CLR method - """ __trunc__(x: UInt64) -> UInt64 """ - pass - - def __xor__(self, *args): #cannot find CLR method - """ - __xor__(x: UInt64, y: UInt64) -> UInt64 - __xor__(x: UInt64, y: Int64) -> long - """ - pass - - denominator = None - imag = None - MaxValue = None - MinValue = None - numerator = None - real = None - - -class UIntPtr(object, ISerializable): - """ - A platform-specific type that is used to represent a pointer or a handle. - - UIntPtr(value: UInt32) - UIntPtr(value: UInt64) - UIntPtr(value: Void*) - """ - @staticmethod - def Add(pointer, offset): - # type: (pointer: UIntPtr, offset: int) -> UIntPtr - """ - Add(pointer: UIntPtr, offset: int) -> UIntPtr - - Adds an offset to the value of an unsigned pointer. - - pointer: The unsigned pointer to add the offset to. - offset: The offset to add. - Returns: A new unsigned pointer that reflects the addition of offset to pointer. - """ - pass - - def Equals(self, obj): - # type: (self: UIntPtr, obj: object) -> bool - """ - Equals(self: UIntPtr, obj: object) -> bool - - Returns a value indicating whether this instance is equal to a specified object. - - obj: An object to compare with this instance or null. - Returns: true if obj is an instance of System.UIntPtr and equals the value of this instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: UIntPtr) -> int - """ - GetHashCode(self: UIntPtr) -> int - - Returns the hash code for this instance. - Returns: A 32-bit signed integer hash code. - """ - pass - - @staticmethod - def Subtract(pointer, offset): - # type: (pointer: UIntPtr, offset: int) -> UIntPtr - """ - Subtract(pointer: UIntPtr, offset: int) -> UIntPtr - - Subtracts an offset from the value of an unsigned pointer. - - pointer: The unsigned pointer to subtract the offset from. - offset: The offset to subtract. - Returns: A new unsigned pointer that reflects the subtraction of offset from pointer. - """ - pass - - def ToPointer(self): - # type: (self: UIntPtr) -> Void* - """ - ToPointer(self: UIntPtr) -> Void* - - Converts the value of this instance to a pointer to an unspecified type. - Returns: A pointer to System.Void; that is, a pointer to memory containing data of an unspecified type. - """ - pass - - def ToString(self): - # type: (self: UIntPtr) -> str - """ - ToString(self: UIntPtr) -> str - - Converts the numeric value of this instance to its equivalent string representation. - Returns: The string representation of the value of this instance. - """ - pass - - def ToUInt32(self): - # type: (self: UIntPtr) -> UInt32 - """ - ToUInt32(self: UIntPtr) -> UInt32 - - Converts the value of this instance to a 32-bit unsigned integer. - Returns: A 32-bit unsigned integer equal to the value of this instance. - """ - pass - - def ToUInt64(self): - # type: (self: UIntPtr) -> UInt64 - """ - ToUInt64(self: UIntPtr) -> UInt64 - - Converts the value of this instance to a 64-bit unsigned integer. - Returns: A 64-bit unsigned integer equal to the value of this instance. - """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, value): - """ - __new__[UIntPtr]() -> UIntPtr - - __new__(cls: type, value: UInt32) - __new__(cls: type, value: UInt64) - __new__(cls: type, value: Void*) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - Size = 8 - Zero = None - - -class UnauthorizedAccessException(SystemException, ISerializable, _Exception): - """ - The exception that is thrown when the operating system denies access because of an I/O error or a specific type of security error. - - UnauthorizedAccessException() - UnauthorizedAccessException(message: str) - UnauthorizedAccessException(message: str, inner: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, message=None, inner=None): - """ - __new__(cls: type) - __new__(cls: type, message: str) - __new__(cls: type, message: str, inner: Exception) - __new__(cls: type, info: SerializationInfo, context: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class UnhandledExceptionEventArgs(EventArgs): - """ - Provides data for the event that is raised when there is an exception that is not handled in any application domain. - - UnhandledExceptionEventArgs(exception: object, isTerminating: bool) - """ - @staticmethod # known case of __new__ - def __new__(self, exception, isTerminating): - """ __new__(cls: type, exception: object, isTerminating: bool) """ - pass - - ExceptionObject = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the unhandled exception object. - - Get: ExceptionObject(self: UnhandledExceptionEventArgs) -> object - """ - - IsTerminating = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Indicates whether the common language runtime is terminating. - - Get: IsTerminating(self: UnhandledExceptionEventArgs) -> bool - """ - - - -class UnhandledExceptionEventHandler(MulticastDelegate, ICloneable, ISerializable): - """ - Represents the method that will handle the event raised by an exception that is not handled by the application domain. - - UnhandledExceptionEventHandler(object: object, method: IntPtr) - """ - def BeginInvoke(self, sender, e, callback, object): - # type: (self: UnhandledExceptionEventHandler, sender: object, e: UnhandledExceptionEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult - """ BeginInvoke(self: UnhandledExceptionEventHandler, sender: object, e: UnhandledExceptionEventArgs, callback: AsyncCallback, object: object) -> IAsyncResult """ - pass - - def CombineImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, follow: Delegate) -> Delegate - """ - CombineImpl(self: MulticastDelegate, follow: Delegate) -> Delegate - - Combines this System.Delegate with the specified System.Delegate to form a new delegate. - - follow: The delegate to combine with this delegate. - Returns: A delegate that is the new root of the System.MulticastDelegate invocation list. - """ - pass - - def DynamicInvokeImpl(self, *args): #cannot find CLR method - # type: (self: Delegate, args: Array[object]) -> object - """ - DynamicInvokeImpl(self: Delegate, args: Array[object]) -> object - - Dynamically invokes (late-bound) the method represented by the current delegate. - - args: An array of objects that are the arguments to pass to the method represented by the current delegate.-or- null, if the method represented by the current delegate does not require arguments. - Returns: The object returned by the method represented by the delegate. - """ - pass - - def EndInvoke(self, result): - # type: (self: UnhandledExceptionEventHandler, result: IAsyncResult) - """ EndInvoke(self: UnhandledExceptionEventHandler, result: IAsyncResult) """ - pass - - def GetMethodImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate) -> MethodInfo - """ - GetMethodImpl(self: MulticastDelegate) -> MethodInfo - - Returns a static method represented by the current System.MulticastDelegate. - Returns: A static method represented by the current System.MulticastDelegate. - """ - pass - - def Invoke(self, sender, e): - # type: (self: UnhandledExceptionEventHandler, sender: object, e: UnhandledExceptionEventArgs) - """ Invoke(self: UnhandledExceptionEventHandler, sender: object, e: UnhandledExceptionEventArgs) """ - pass - - def RemoveImpl(self, *args): #cannot find CLR method - # type: (self: MulticastDelegate, value: Delegate) -> Delegate - """ - RemoveImpl(self: MulticastDelegate, value: Delegate) -> Delegate - - Removes an element from the invocation list of this System.MulticastDelegate that is equal to the specified delegate. - - value: The delegate to search for in the invocation list. - Returns: If value is found in the invocation list for this instance, then a new System.Delegate without value in its invocation list; otherwise, this instance with its original invocation list. - """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, object, method): - """ __new__(cls: type, object: object, method: IntPtr) """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - -class Uri(object, ISerializable): - # type: (URI) and easy access to the parts of the URI. - """ - Provides an object representation of a uniform resource identifier (URI) and easy access to the parts of the URI. - - Uri(uriString: str) - Uri(uriString: str, dontEscape: bool) - Uri(baseUri: Uri, relativeUri: str, dontEscape: bool) - Uri(uriString: str, uriKind: UriKind) - Uri(baseUri: Uri, relativeUri: str) - Uri(baseUri: Uri, relativeUri: Uri) - """ - def Canonicalize(self, *args): #cannot find CLR method - # type: (self: Uri) - """ - Canonicalize(self: Uri) - Converts the internally stored URI to canonical form. - """ - pass - - @staticmethod - def CheckHostName(name): - # type: (name: str) -> UriHostNameType - """ - CheckHostName(name: str) -> UriHostNameType - - Determines whether the specified host name is a valid DNS name. - - name: The host name to validate. This can be an IPv4 or IPv6 address or an Internet host name. - Returns: A System.UriHostNameType that indicates the type of the host name. If the type of the host name cannot be determined or if the host name is null or a zero-length string, this method returns System.UriHostNameType.Unknown. - """ - pass - - @staticmethod - def CheckSchemeName(schemeName): - # type: (schemeName: str) -> bool - """ - CheckSchemeName(schemeName: str) -> bool - - Determines whether the specified scheme name is valid. - - schemeName: The scheme name to validate. - Returns: A System.Boolean value that is true if the scheme name is valid; otherwise, false. - """ - pass - - def CheckSecurity(self, *args): #cannot find CLR method - # type: (self: Uri) - """ - CheckSecurity(self: Uri) - Calling this method has no effect. - """ - pass - - @staticmethod - def Compare(uri1, uri2, partsToCompare, compareFormat, comparisonType): - # type: (uri1: Uri, uri2: Uri, partsToCompare: UriComponents, compareFormat: UriFormat, comparisonType: StringComparison) -> int - """ - Compare(uri1: Uri, uri2: Uri, partsToCompare: UriComponents, compareFormat: UriFormat, comparisonType: StringComparison) -> int - - Compares the specified parts of two URIs using the specified comparison rules. - - uri1: The first System.Uri. - uri2: The second System.Uri. - partsToCompare: A bitwise combination of the System.UriComponents values that specifies the parts of uri1 and uri2 to compare. - compareFormat: One of the System.UriFormat values that specifies the character escaping used when the URI components are compared. - comparisonType: One of the System.StringComparison values. - Returns: An System.Int32 value that indicates the lexical relationship between the compared System.Uri components.ValueMeaningLess than zerouri1 is less than uri2.Zerouri1 equals uri2.Greater than zerouri1 is greater than uri2. - """ - pass - - def Equals(self, comparand): - # type: (self: Uri, comparand: object) -> bool - """ - Equals(self: Uri, comparand: object) -> bool - - Compares two System.Uri instances for equality. - - comparand: The System.Uri instance or a URI identifier to compare with the current instance. - Returns: A System.Boolean value that is true if the two instances represent the same URI; otherwise, false. - """ - pass - - def Escape(self, *args): #cannot find CLR method - # type: (self: Uri) - """ - Escape(self: Uri) - Converts any unsafe or reserved characters in the path component to their hexadecimal character representations. - """ - pass - - @staticmethod - def EscapeDataString(stringToEscape): - # type: (stringToEscape: str) -> str - """ - EscapeDataString(stringToEscape: str) -> str - - Converts a string to its escaped representation. - - stringToEscape: The string to escape. - Returns: A System.String that contains the escaped representation of stringToEscape. - """ - pass - - def EscapeString(self, *args): #cannot find CLR method - # type: (str: str) -> str - """ - EscapeString(str: str) -> str - - Converts a string to its escaped representation. - - str: The string to transform to its escaped representation. - Returns: The escaped representation of the string. - """ - pass - - @staticmethod - def EscapeUriString(stringToEscape): - # type: (stringToEscape: str) -> str - """ - EscapeUriString(stringToEscape: str) -> str - - Converts a URI string to its escaped representation. - - stringToEscape: The string to escape. - Returns: A System.String that contains the escaped representation of stringToEscape. - """ - pass - - @staticmethod - def FromHex(digit): - # type: (digit: Char) -> int - """ - FromHex(digit: Char) -> int - - Gets the decimal value of a hexadecimal digit. - - digit: The hexadecimal digit (0-9, a-f, A-F) to convert. - Returns: An System.Int32 value that contains a number from 0 to 15 that corresponds to the specified hexadecimal digit. - """ - pass - - def GetComponents(self, components, format): - # type: (self: Uri, components: UriComponents, format: UriFormat) -> str - """ - GetComponents(self: Uri, components: UriComponents, format: UriFormat) -> str - - Gets the specified components of the current instance using the specified escaping for special characters. - - components: A bitwise combination of the System.UriComponents values that specifies which parts of the current instance to return to the caller. - format: One of the System.UriFormat values that controls how special characters are escaped. - Returns: A System.String that contains the components. - """ - pass - - def GetHashCode(self): - # type: (self: Uri) -> int - """ - GetHashCode(self: Uri) -> int - - Gets the hash code for the URI. - Returns: An System.Int32 containing the hash value generated for this URI. - """ - pass - - def GetLeftPart(self, part): - # type: (self: Uri, part: UriPartial) -> str - """ - GetLeftPart(self: Uri, part: UriPartial) -> str - - Gets the specified portion of a System.Uri instance. - - part: One of the System.UriPartial values that specifies the end of the URI portion to return. - Returns: A System.String that contains the specified portion of the System.Uri instance. - """ - pass - - def GetObjectData(self, *args): #cannot find CLR method - # type: (self: Uri, serializationInfo: SerializationInfo, streamingContext: StreamingContext) - """ - GetObjectData(self: Uri, serializationInfo: SerializationInfo, streamingContext: StreamingContext) - Returns the data needed to serialize the current instance. - - serializationInfo: A System.Runtime.Serialization.SerializationInfo object containing the information required to serialize the System.Uri. - streamingContext: A System.Runtime.Serialization.StreamingContext object containing the source and destination of the serialized stream associated with the System.Uri. - """ - pass - - @staticmethod - def HexEscape(character): - # type: (character: Char) -> str - """ - HexEscape(character: Char) -> str - - Converts a specified character into its hexadecimal equivalent. - - character: The character to convert to hexadecimal representation. - Returns: The hexadecimal representation of the specified character. - """ - pass - - @staticmethod - def HexUnescape(pattern, index): - # type: (pattern: str, index: int) -> (Char, int) - """ - HexUnescape(pattern: str, index: int) -> (Char, int) - - Converts a specified hexadecimal representation of a character to the character. - - pattern: The hexadecimal representation of a character. - index: The location in pattern where the hexadecimal representation of a character begins. - Returns: The character represented by the hexadecimal encoding at position index. If the character at index is not hexadecimal encoded, the character at index is returned. The value of index is incremented to point to the character following the one returned. - """ - pass - - def IsBadFileSystemCharacter(self, *args): #cannot find CLR method - # type: (self: Uri, character: Char) -> bool - """ - IsBadFileSystemCharacter(self: Uri, character: Char) -> bool - - Gets whether a character is invalid in a file system name. - - character: The System.Char to test. - Returns: A System.Boolean value that is true if the specified character is invalid; otherwise false. - """ - pass - - def IsBaseOf(self, uri): - # type: (self: Uri, uri: Uri) -> bool - """ - IsBaseOf(self: Uri, uri: Uri) -> bool - - Determines whether the current System.Uri instance is a base of the specified System.Uri instance. - - uri: The specified System.Uri instance to test. - Returns: true if the current System.Uri instance is a base of uri; otherwise, false. - """ - pass - - def IsExcludedCharacter(self, *args): #cannot find CLR method - # type: (character: Char) -> bool - """ - IsExcludedCharacter(character: Char) -> bool - - Gets whether the specified character should be escaped. - - character: The System.Char to test. - Returns: A System.Boolean value that is true if the specified character should be escaped; otherwise, false. - """ - pass - - @staticmethod - def IsHexDigit(character): - # type: (character: Char) -> bool - """ - IsHexDigit(character: Char) -> bool - - Determines whether a specified character is a valid hexadecimal digit. - - character: The character to validate. - Returns: A System.Boolean value that is true if the character is a valid hexadecimal digit; otherwise false. - """ - pass - - @staticmethod - def IsHexEncoding(pattern, index): - # type: (pattern: str, index: int) -> bool - """ - IsHexEncoding(pattern: str, index: int) -> bool - - Determines whether a character in a string is hexadecimal encoded. - - pattern: The string to check. - index: The location in pattern to check for hexadecimal encoding. - Returns: A System.Boolean value that is true if pattern is hexadecimal encoded at the specified location; otherwise, false. - """ - pass - - def IsReservedCharacter(self, *args): #cannot find CLR method - # type: (self: Uri, character: Char) -> bool - """ - IsReservedCharacter(self: Uri, character: Char) -> bool - - Gets whether the specified character is a reserved character. - - character: The System.Char to test. - Returns: A System.Boolean value that is true if the specified character is a reserved character otherwise, false. - """ - pass - - def IsWellFormedOriginalString(self): - # type: (self: Uri) -> bool - """ - IsWellFormedOriginalString(self: Uri) -> bool - - Indicates whether the string used to construct this System.Uri was well-formed and is not required to be further escaped. - Returns: A System.Boolean value that is true if the string was well-formed; else false. - """ - pass - - @staticmethod - def IsWellFormedUriString(uriString, uriKind): - # type: (uriString: str, uriKind: UriKind) -> bool - """ - IsWellFormedUriString(uriString: str, uriKind: UriKind) -> bool - - Indicates whether the string is well-formed by attempting to construct a URI with the string and ensures that the string does not require further escaping. - - uriString: The string used to attempt to construct a System.Uri. - uriKind: The type of the System.Uri in uriString. - Returns: A System.Boolean value that is true if the string was well-formed; else false. - """ - pass - - def MakeRelative(self, toUri): - # type: (self: Uri, toUri: Uri) -> str - """ - MakeRelative(self: Uri, toUri: Uri) -> str - - Determines the difference between two System.Uri instances. - - toUri: The URI to compare to the current URI. - Returns: If the hostname and scheme of this URI instance and toUri are the same, then this method returns a System.String that represents a relative URI that, when appended to the current URI instance, yields the toUri parameter.If the hostname or scheme is - different, then this method returns a System.String that represents the toUri parameter. - """ - pass - - def MakeRelativeUri(self, uri): - # type: (self: Uri, uri: Uri) -> Uri - """ - MakeRelativeUri(self: Uri, uri: Uri) -> Uri - - Determines the difference between two System.Uri instances. - - uri: The URI to compare to the current URI. - Returns: If the hostname and scheme of this URI instance and uri are the same, then this method returns a relative System.Uri that, when appended to the current URI instance, yields uri.If the hostname or scheme is different, then this method returns a - System.Uri that represents the uri parameter. - """ - pass - - def Parse(self, *args): #cannot find CLR method - # type: (self: Uri) - """ - Parse(self: Uri) - Parses the URI of the current instance to ensure it contains all the parts required for a valid URI. - """ - pass - - def ToString(self): - # type: (self: Uri) -> str - """ - ToString(self: Uri) -> str - - Gets a canonical string representation for the specified System.Uri instance. - Returns: A System.String instance that contains the unescaped canonical representation of the System.Uri instance. All characters are unescaped except #, ?, and %. - """ - pass - - @staticmethod - def TryCreate(*__args): - # type: (uriString: str, uriKind: UriKind) -> (bool, Uri) - """ - TryCreate(uriString: str, uriKind: UriKind) -> (bool, Uri) - - Creates a new System.Uri using the specified System.String instance and a System.UriKind. - - uriString: The System.String representing the System.Uri. - uriKind: The type of the Uri. - Returns: A System.Boolean value that is true if the System.Uri was successfully created; otherwise, false. - TryCreate(baseUri: Uri, relativeUri: str) -> (bool, Uri) - - Creates a new System.Uri using the specified base and relative System.String instances. - - baseUri: The base System.Uri. - relativeUri: The relative System.Uri, represented as a System.String, to add to the base System.Uri. - Returns: A System.Boolean value that is true if the System.Uri was successfully created; otherwise, false. - TryCreate(baseUri: Uri, relativeUri: Uri) -> (bool, Uri) - - Creates a new System.Uri using the specified base and relative System.Uri instances. - - baseUri: The base System.Uri. - relativeUri: The relative System.Uri to add to the base System.Uri. - Returns: A System.Boolean value that is true if the System.Uri was successfully created; otherwise, false. - """ - pass - - def Unescape(self, *args): #cannot find CLR method - # type: (self: Uri, path: str) -> str - """ - Unescape(self: Uri, path: str) -> str - - Converts the specified string by replacing any escape sequences with their unescaped representation. - - path: The System.String to convert. - Returns: A System.String that contains the unescaped value of the path parameter. - """ - pass - - @staticmethod - def UnescapeDataString(stringToUnescape): - # type: (stringToUnescape: str) -> str - """ - UnescapeDataString(stringToUnescape: str) -> str - - Converts a string to its unescaped representation. - - stringToUnescape: The string to unescape. - Returns: A System.String that contains the unescaped representation of stringToUnescape. - """ - pass - - def __cmp__(self, *args): #cannot find CLR method - """ x.__cmp__(y) <==> cmp(x,y) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, uriString: str) - __new__(cls: type, uriString: str, dontEscape: bool) - __new__(cls: type, baseUri: Uri, relativeUri: str, dontEscape: bool) - __new__(cls: type, uriString: str, uriKind: UriKind) - __new__(cls: type, baseUri: Uri, relativeUri: str) - __new__(cls: type, baseUri: Uri, relativeUri: Uri) - __new__(cls: type, serializationInfo: SerializationInfo, streamingContext: StreamingContext) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - AbsolutePath = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the absolute path of the URI. - - Get: AbsolutePath(self: Uri) -> str - """ - - AbsoluteUri = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the absolute URI. - - Get: AbsoluteUri(self: Uri) -> str - """ - - Authority = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (DNS) host name or IP address and the port number for a server. - """ - Gets the Domain Name System (DNS) host name or IP address and the port number for a server. - - Get: Authority(self: Uri) -> str - """ - - DnsSafeHost = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an unescaped host name that is safe to use for DNS resolution. - - Get: DnsSafeHost(self: Uri) -> str - """ - - Fragment = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the escaped URI fragment. - - Get: Fragment(self: Uri) -> str - """ - - Host = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the host component of this instance. - - Get: Host(self: Uri) -> str - """ - - HostNameType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the type of the host name specified in the URI. - - Get: HostNameType(self: Uri) -> UriHostNameType - """ - - IdnHost = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Uri) -> str - """ Get: IdnHost(self: Uri) -> str """ - - IsAbsoluteUri = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets whether the System.Uri instance is absolute. - - Get: IsAbsoluteUri(self: Uri) -> bool - """ - - IsDefaultPort = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets whether the port value of the URI is the default for this scheme. - - Get: IsDefaultPort(self: Uri) -> bool - """ - - IsFile = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a value indicating whether the specified System.Uri is a file URI. - - Get: IsFile(self: Uri) -> bool - """ - - IsLoopback = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets whether the specified System.Uri references the local host. - - Get: IsLoopback(self: Uri) -> bool - """ - - IsUnc = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (UNC) path. - """ - Gets whether the specified System.Uri is a universal naming convention (UNC) path. - - Get: IsUnc(self: Uri) -> bool - """ - - LocalPath = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets a local operating-system representation of a file name. - - Get: LocalPath(self: Uri) -> str - """ - - OriginalString = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the original URI string that was passed to the System.Uri constructor. - - Get: OriginalString(self: Uri) -> str - """ - - PathAndQuery = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (?). - """ - Gets the System.Uri.AbsolutePath and System.Uri.Query properties separated by a question mark (?). - - Get: PathAndQuery(self: Uri) -> str - """ - - Port = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the port number of this URI. - - Get: Port(self: Uri) -> int - """ - - Query = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets any query information included in the specified URI. - - Get: Query(self: Uri) -> str - """ - - Scheme = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the scheme name for this URI. - - Get: Scheme(self: Uri) -> str - """ - - Segments = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets an array containing the path segments that make up the specified URI. - - Get: Segments(self: Uri) -> Array[str] - """ - - UserEscaped = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Indicates that the URI string was completely escaped before the System.Uri instance was created. - - Get: UserEscaped(self: Uri) -> bool - """ - - UserInfo = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the user name, password, or other user-specific information associated with the specified URI. - - Get: UserInfo(self: Uri) -> str - """ - - - SchemeDelimiter = '://' - UriSchemeFile = 'file' - UriSchemeFtp = 'ftp' - UriSchemeGopher = 'gopher' - UriSchemeHttp = 'http' - UriSchemeHttps = 'https' - UriSchemeMailto = 'mailto' - UriSchemeNetPipe = 'net.pipe' - UriSchemeNetTcp = 'net.tcp' - UriSchemeNews = 'news' - UriSchemeNntp = 'nntp' - - -class UriBuilder(object): - # type: (URIs) and modifies URIs for the System.Uri class. - """ - Provides a custom constructor for uniform resource identifiers (URIs) and modifies URIs for the System.Uri class. - - UriBuilder() - UriBuilder(uri: str) - UriBuilder(uri: Uri) - UriBuilder(schemeName: str, hostName: str) - UriBuilder(scheme: str, host: str, portNumber: int) - UriBuilder(scheme: str, host: str, port: int, pathValue: str) - UriBuilder(scheme: str, host: str, port: int, path: str, extraValue: str) - """ - def Equals(self, rparam): - # type: (self: UriBuilder, rparam: object) -> bool - """ - Equals(self: UriBuilder, rparam: object) -> bool - - Compares an existing System.Uri instance with the contents of the System.UriBuilder for equality. - - rparam: The object to compare with the current instance. - Returns: true if rparam represents the same System.Uri as the System.Uri constructed by this System.UriBuilder instance; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: UriBuilder) -> int - """ - GetHashCode(self: UriBuilder) -> int - - Returns the hash code for the URI. - Returns: The hash code generated for the URI. - """ - pass - - def ToString(self): - # type: (self: UriBuilder) -> str - """ - ToString(self: UriBuilder) -> str - - Returns the display string for the specified System.UriBuilder instance. - Returns: The string that contains the unescaped display string of the System.UriBuilder. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type) - __new__(cls: type, uri: str) - __new__(cls: type, uri: Uri) - __new__(cls: type, schemeName: str, hostName: str) - __new__(cls: type, scheme: str, host: str, portNumber: int) - __new__(cls: type, scheme: str, host: str, port: int, pathValue: str) - __new__(cls: type, scheme: str, host: str, port: int, path: str, extraValue: str) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - Fragment = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the fragment portion of the URI. - - Get: Fragment(self: UriBuilder) -> str - - Set: Fragment(self: UriBuilder) = value - """ - - Host = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (DNS) host name or IP address of a server. - """ - Gets or sets the Domain Name System (DNS) host name or IP address of a server. - - Get: Host(self: UriBuilder) -> str - - Set: Host(self: UriBuilder) = value - """ - - Password = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the password associated with the user that accesses the URI. - - Get: Password(self: UriBuilder) -> str - - Set: Password(self: UriBuilder) = value - """ - - Path = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the path to the resource referenced by the URI. - - Get: Path(self: UriBuilder) -> str - - Set: Path(self: UriBuilder) = value - """ - - Port = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the port number of the URI. - - Get: Port(self: UriBuilder) -> int - - Set: Port(self: UriBuilder) = value - """ - - Query = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets any query information included in the URI. - - Get: Query(self: UriBuilder) -> str - - Set: Query(self: UriBuilder) = value - """ - - Scheme = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets or sets the scheme name of the URI. - - Get: Scheme(self: UriBuilder) -> str - - Set: Scheme(self: UriBuilder) = value - """ - - Uri = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the System.Uri instance constructed by the specified System.UriBuilder instance. - - Get: Uri(self: UriBuilder) -> Uri - """ - - UserName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - The user name associated with the user that accesses the URI. - - Get: UserName(self: UriBuilder) -> str - - Set: UserName(self: UriBuilder) = value - """ - - - -class UriComponents(Enum, IComparable, IFormattable, IConvertible): - """ - Specifies the parts of a System.Uri. - - enum (flags) UriComponents, values: AbsoluteUri (127), Fragment (64), Host (4), HostAndPort (132), HttpRequestUrl (61), KeepDelimiter (1073741824), NormalizedHost (256), Path (16), PathAndQuery (48), Port (8), Query (32), Scheme (1), SchemeAndServer (13), SerializationInfoString (-2147483648), StrongAuthority (134), StrongPort (128), UserInfo (2) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - AbsoluteUri = None - Fragment = None - Host = None - HostAndPort = None - HttpRequestUrl = None - KeepDelimiter = None - NormalizedHost = None - Path = None - PathAndQuery = None - Port = None - Query = None - Scheme = None - SchemeAndServer = None - SerializationInfoString = None - StrongAuthority = None - StrongPort = None - UserInfo = None - value__ = None - - -class UriFormat(Enum, IComparable, IFormattable, IConvertible): - """ - Controls how URI information is escaped. - - enum UriFormat, values: SafeUnescaped (3), Unescaped (2), UriEscaped (1) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SafeUnescaped = None - Unescaped = None - UriEscaped = None - value__ = None - - -class UriFormatException(FormatException, ISerializable, _Exception): - # type: (URI) is detected. - """ - The exception that is thrown when an invalid Uniform Resource Identifier (URI) is detected. - - UriFormatException() - UriFormatException(textString: str) - UriFormatException(textString: str, e: Exception) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, textString=None, e=None): - """ - __new__(cls: type) - __new__(cls: type, textString: str) - __new__(cls: type, textString: str, e: Exception) - __new__(cls: type, serializationInfo: SerializationInfo, streamingContext: StreamingContext) - """ - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class UriHostNameType(Enum, IComparable, IFormattable, IConvertible): - # type: (System.String) method. - """ - Defines host name types for the System.Uri.CheckHostName(System.String) method. - - enum UriHostNameType, values: Basic (1), Dns (2), IPv4 (3), IPv6 (4), Unknown (0) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Basic = None - Dns = None - IPv4 = None - IPv6 = None - Unknown = None - value__ = None - - -class UriIdnScope(Enum, IComparable, IFormattable, IConvertible): - """ - Provides the possible values for the configuration setting of the System.Configuration.IdnElement in the System.Configuration namespace. - - enum UriIdnScope, values: All (2), AllExceptIntranet (1), None (0) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - All = None - AllExceptIntranet = None - None = None - value__ = None - - -class UriKind(Enum, IComparable, IFormattable, IConvertible): - # type: (System.String,System.UriKind) and several erload:System.Uri.#ctor methods. - """ - Defines the kinds of System.Uris for the System.Uri.IsWellFormedUriString(System.String,System.UriKind) and several erload:System.Uri.#ctor methods. - - enum UriKind, values: Absolute (1), Relative (2), RelativeOrAbsolute (0) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Absolute = None - Relative = None - RelativeOrAbsolute = None - value__ = None - - -class UriPartial(Enum, IComparable, IFormattable, IConvertible): - # type: (System.UriPartial) method. - """ - Defines the parts of a URI for the System.Uri.GetLeftPart(System.UriPartial) method. - - enum UriPartial, values: Authority (1), Path (2), Query (3), Scheme (0) - """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Authority = None - Path = None - Query = None - Scheme = None - value__ = None - - -class UriTypeConverter(TypeConverter): - """ - Converts a System.String type to a System.Uri type, and vice versa. - - UriTypeConverter() - """ - def CanConvertFrom(self, *__args): - # type: (self: UriTypeConverter, context: ITypeDescriptorContext, sourceType: Type) -> bool - """ - CanConvertFrom(self: UriTypeConverter, context: ITypeDescriptorContext, sourceType: Type) -> bool - - Returns whether this converter can convert an object of the given type to the type of this converter. - - context: An System.ComponentModel.ITypeDescriptorContext that provides a format context. - sourceType: A System.Type that represents the type that you want to convert from. - Returns: true if sourceType is a System.String type or a System.Uri type can be assigned from sourceType; otherwise, false. - """ - pass - - def CanConvertTo(self, *__args): - # type: (self: UriTypeConverter, context: ITypeDescriptorContext, destinationType: Type) -> bool - """ - CanConvertTo(self: UriTypeConverter, context: ITypeDescriptorContext, destinationType: Type) -> bool - - Returns whether this converter can convert the object to the specified type, using the specified context. - - context: An System.ComponentModel.ITypeDescriptorContext that provides a format context. - destinationType: A System.Type that represents the type that you want to convert to. - Returns: true if destinationType is of type System.ComponentModel.Design.Serialization.InstanceDescriptor, System.String, or System.Uri; otherwise, false. - """ - pass - - def ConvertFrom(self, *__args): - # type: (self: UriTypeConverter, context: ITypeDescriptorContext, culture: CultureInfo, value: object) -> object - """ - ConvertFrom(self: UriTypeConverter, context: ITypeDescriptorContext, culture: CultureInfo, value: object) -> object - - Converts the given object to the type of this converter, using the specified context and culture information. - - context: An System.ComponentModel.ITypeDescriptorContext that provides a format context. - culture: The System.Globalization.CultureInfo to use as the current culture. - value: The System.Object to convert. - Returns: An System.Object that represents the converted value. - """ - pass - - def ConvertTo(self, *__args): - # type: (self: UriTypeConverter, context: ITypeDescriptorContext, culture: CultureInfo, value: object, destinationType: Type) -> object - """ - ConvertTo(self: UriTypeConverter, context: ITypeDescriptorContext, culture: CultureInfo, value: object, destinationType: Type) -> object - - Converts a given value object to the specified type, using the specified context and culture information. - - context: An System.ComponentModel.ITypeDescriptorContext that provides a format context. - culture: A System.Globalization.CultureInfo. If null is passed, the current culture is assumed. - value: The System.Object to convert. - destinationType: The System.Type to convert the value parameter to. - Returns: An System.Object that represents the converted value. - """ - pass - - def IsValid(self, *__args): - # type: (self: UriTypeConverter, context: ITypeDescriptorContext, value: object) -> bool - """ - IsValid(self: UriTypeConverter, context: ITypeDescriptorContext, value: object) -> bool - - Returns whether the given value object is a System.Uri or a System.Uri can be created from it. - - context: An System.ComponentModel.ITypeDescriptorContext that provides a format context. - value: The System.Object to test for validity. - Returns: true if value is a System.Uri or a System.String from which a System.Uri can be created; otherwise, false. - """ - pass - - -class ValueType(object): - """ Provides the base class for value types. """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - -class Version(object, ICloneable, IComparable, IComparable[Version], IEquatable[Version]): - """ - Represents the version number of an assembly, operating system, or the common language runtime. This class cannot be inherited. - - Version(major: int, minor: int, build: int, revision: int) - Version(major: int, minor: int, build: int) - Version(major: int, minor: int) - Version(version: str) - Version() - """ - def Clone(self): - # type: (self: Version) -> object - """ - Clone(self: Version) -> object - - Returns a new System.Version object whose value is the same as the current System.Version object. - Returns: A new System.Object whose values are a copy of the current System.Version object. - """ - pass - - def CompareTo(self, *__args): - # type: (self: Version, version: object) -> int - """ - CompareTo(self: Version, version: object) -> int - - Compares the current System.Version object to a specified object and returns an indication of their relative values. - - version: An object to compare, or null. - Returns: A signed integer that indicates the relative values of the two objects, as shown in the following table.Return value Meaning Less than zero The current System.Version object is a version before version. Zero The current System.Version object is the - same version as version. Greater than zero The current System.Version object is a version subsequent to version.-or- version is null. - - CompareTo(self: Version, value: Version) -> int - - Compares the current System.Version object to a specified System.Version object and returns an indication of their relative values. - - value: A System.Version object to compare to the current System.Version object, or null. - Returns: A signed integer that indicates the relative values of the two objects, as shown in the following table.Return value Meaning Less than zero The current System.Version object is a version before value. Zero The current System.Version object is the same - version as value. Greater than zero The current System.Version object is a version subsequent to value. -or-value is null. - """ - pass - - def Equals(self, obj): - # type: (self: Version, obj: object) -> bool - """ - Equals(self: Version, obj: object) -> bool - - Returns a value indicating whether the current System.Version object is equal to a specified object. - - obj: An object to compare with the current System.Version object, or null. - Returns: true if the current System.Version object and obj are both System.Version objects, and every component of the current System.Version object matches the corresponding component of obj; otherwise, false. - Equals(self: Version, obj: Version) -> bool - - Returns a value indicating whether the current System.Version object and a specified System.Version object represent the same value. - - obj: A System.Version object to compare to the current System.Version object, or null. - Returns: true if every component of the current System.Version object matches the corresponding component of the obj parameter; otherwise, false. - """ - pass - - def GetHashCode(self): - # type: (self: Version) -> int - """ - GetHashCode(self: Version) -> int - - Returns a hash code for the current System.Version object. - Returns: A 32-bit signed integer hash code. - """ - pass - - @staticmethod - def Parse(input): - # type: (input: str) -> Version - """ - Parse(input: str) -> Version - - Converts the string representation of a version number to an equivalent System.Version object. - - input: A string that contains a version number to convert. - Returns: An object that is equivalent to the version number specified in the input parameter. - """ - pass - - def ToString(self, fieldCount=None): - # type: (self: Version) -> str - """ - ToString(self: Version) -> str - - Converts the value of the current System.Version object to its equivalent System.String representation. - Returns: The System.String representation of the values of the major, minor, build, and revision components of the current System.Version object, as depicted in the following format. Each component is separated by a period character ('.'). Square brackets ('[' - and ']') indicate a component that will not appear in the return value if the component is not defined: major.minor[.build[.revision]] For example, if you create a System.Version object using the constructor Version(1,1), the returned string is "1.1". - If you create a System.Version object using the constructor Version(1,3,4,2), the returned string is "1.3.4.2". - - ToString(self: Version, fieldCount: int) -> str - - Converts the value of the current System.Version object to its equivalent System.String representation. A specified count indicates the number of components to return. - - fieldCount: The number of components to return. The fieldCount ranges from 0 to 4. - Returns: The System.String representation of the values of the major, minor, build, and revision components of the current System.Version object, each separated by a period character ('.'). The fieldCount parameter determines how many components are - returned.fieldCount Return Value 0 An empty string (""). 1 major 2 major.minor 3 major.minor.build 4 major.minor.build.revision For example, if you create System.Version object using the constructor Version(1,3,5), ToString(2) returns "1.3" and - ToString(4) throws an exception. - """ - pass - - @staticmethod - def TryParse(input, result): - # type: (input: str) -> (bool, Version) - """ - TryParse(input: str) -> (bool, Version) - - Tries to convert the string representation of a version number to an equivalent System.Version object, and returns a value that indicates whether the conversion succeeded. - - input: A string that contains a version number to convert. - Returns: true if the input parameter was converted successfully; otherwise, false. - """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, major: int, minor: int, build: int, revision: int) - __new__(cls: type, major: int, minor: int, build: int) - __new__(cls: type, major: int, minor: int) - __new__(cls: type, version: str) - __new__(cls: type) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Build = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the build component of the version number for the current System.Version object. - - Get: Build(self: Version) -> int - """ - - Major = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the major component of the version number for the current System.Version object. - - Get: Major(self: Version) -> int - """ - - MajorRevision = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the high 16 bits of the revision number. - - Get: MajorRevision(self: Version) -> Int16 - """ - - Minor = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the minor component of the version number for the current System.Version object. - - Get: Minor(self: Version) -> int - """ - - MinorRevision = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the low 16 bits of the revision number. - - Get: MinorRevision(self: Version) -> Int16 - """ - - Revision = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - """ - Gets the value of the revision component of the version number for the current System.Version object. - - Get: Revision(self: Version) -> int - """ - - - -class Void(object): - """ Specifies a return value type for a method that does not return a value. """ - -# variables with complex values - diff --git a/pyesapi/stubs/VMS/TPS/Common/Model/API.py b/pyesapi/stubs/VMS/TPS/Common/Model/API.py deleted file mode 100644 index bd46336..0000000 --- a/pyesapi/stubs/VMS/TPS/Common/Model/API.py +++ /dev/null @@ -1,6642 +0,0 @@ -# encoding: utf-8 -# module VMS.TPS.Common.Model.API calls itself API -# from VMS.TPS.Common.Model.API, Version=1.0.300.11, Culture=neutral, PublicKeyToken=305b81e210ec4b89 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class SerializableObject(object, IXmlSerializable): - # no doc - @staticmethod - def ClearSerializationHistory(): - # type: () - """ ClearSerializationHistory() """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetSchema(self): - # type: (self: SerializableObject) -> XmlSchema - """ GetSchema(self: SerializableObject) -> XmlSchema """ - pass - - def ReadXml(self, reader): - # type: (self: SerializableObject, reader: XmlReader) - """ ReadXml(self: SerializableObject, reader: XmlReader) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: SerializableObject, writer: XmlWriter) - """ WriteXml(self: SerializableObject, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - -class ApiDataObject(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def Equals(self, obj): - # type: (self: ApiDataObject, obj: object) -> bool - """ Equals(self: ApiDataObject, obj: object) -> bool """ - pass - - def GetHashCode(self): - # type: (self: ApiDataObject) -> int - """ GetHashCode(self: ApiDataObject) -> int """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def ToString(self): - # type: (self: ApiDataObject) -> str - """ ToString(self: ApiDataObject) -> str """ - pass - - def WriteXml(self, writer): - # type: (self: ApiDataObject, writer: XmlWriter) - """ WriteXml(self: ApiDataObject, writer: XmlWriter) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Comment = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApiDataObject) -> str - """ Get: Comment(self: ApiDataObject) -> str """ - - HistoryDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApiDataObject) -> DateTime - """ Get: HistoryDateTime(self: ApiDataObject) -> DateTime """ - - HistoryUserDisplayName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApiDataObject) -> str - """ Get: HistoryUserDisplayName(self: ApiDataObject) -> str """ - - HistoryUserName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApiDataObject) -> str - """ Get: HistoryUserName(self: ApiDataObject) -> str """ - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApiDataObject) -> str - """ Get: Id(self: ApiDataObject) -> str """ - - Name = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApiDataObject) -> str - """ Get: Name(self: ApiDataObject) -> str """ - - - -class AddOn(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: AddOn, writer: XmlWriter) - """ WriteXml(self: AddOn, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CreationDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: AddOn) -> Nullable[DateTime] - """ Get: CreationDateTime(self: AddOn) -> Nullable[DateTime] """ - - - -class AddOnMaterial(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: AddOnMaterial, writer: XmlWriter) - """ WriteXml(self: AddOnMaterial, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class Application(SerializableObject, IXmlSerializable, IDisposable): - # no doc - def ClosePatient(self): - # type: (self: Application) - """ ClosePatient(self: Application) """ - pass - - @staticmethod - def CreateApplication(username=None, password=None): - # type: (username: str, password: str) -> Application - """ - CreateApplication(username: str, password: str) -> Application - CreateApplication() -> Application - """ - pass - - def Dispose(self): - # type: (self: Application) - """ Dispose(self: Application) """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def OpenPatient(self, patientSummary): - # type: (self: Application, patientSummary: PatientSummary) -> Patient - """ OpenPatient(self: Application, patientSummary: PatientSummary) -> Patient """ - pass - - def OpenPatientById(self, id): - # type: (self: Application, id: str) -> Patient - """ OpenPatientById(self: Application, id: str) -> Patient """ - pass - - def SaveModifications(self): - # type: (self: Application) - """ SaveModifications(self: Application) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Application, writer: XmlWriter) - """ WriteXml(self: Application, writer: XmlWriter) """ - pass - - def __enter__(self, *args): #cannot find CLR method - """ __enter__(self: IDisposable) -> object """ - pass - - def __exit__(self, *args): #cannot find CLR method - """ __exit__(self: IDisposable, exc_type: object, exc_value: object, exc_back: object) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - CurrentUser = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Application) -> User - """ Get: CurrentUser(self: Application) -> User """ - - PatientSummaries = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Application) -> IEnumerable[PatientSummary] - """ Get: PatientSummaries(self: Application) -> IEnumerable[PatientSummary] """ - - ScriptEnvironment = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Application) -> ScriptEnvironment - """ Get: ScriptEnvironment(self: Application) -> ScriptEnvironment """ - - - -class ApplicationScript(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: ApplicationScript, writer: XmlWriter) - """ WriteXml(self: ApplicationScript, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ApprovalStatus = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScript) -> ApplicationScriptApprovalStatus - """ Get: ApprovalStatus(self: ApplicationScript) -> ApplicationScriptApprovalStatus """ - - ApprovalStatusDisplayText = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScript) -> str - """ Get: ApprovalStatusDisplayText(self: ApplicationScript) -> str """ - - AssemblyName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScript) -> AssemblyName - """ Get: AssemblyName(self: ApplicationScript) -> AssemblyName """ - - ExpirationDate = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScript) -> Nullable[DateTime] - """ Get: ExpirationDate(self: ApplicationScript) -> Nullable[DateTime] """ - - IsReadOnlyScript = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScript) -> bool - """ Get: IsReadOnlyScript(self: ApplicationScript) -> bool """ - - IsWriteableScript = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScript) -> bool - """ Get: IsWriteableScript(self: ApplicationScript) -> bool """ - - PublisherName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScript) -> str - """ Get: PublisherName(self: ApplicationScript) -> str """ - - ScriptType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScript) -> ApplicationScriptType - """ Get: ScriptType(self: ApplicationScript) -> ApplicationScriptType """ - - StatusDate = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScript) -> Nullable[DateTime] - """ Get: StatusDate(self: ApplicationScript) -> Nullable[DateTime] """ - - StatusUserIdentity = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScript) -> UserIdentity - """ Get: StatusUserIdentity(self: ApplicationScript) -> UserIdentity """ - - - -class ApplicationScriptLog(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: ApplicationScriptLog, writer: XmlWriter) - """ WriteXml(self: ApplicationScriptLog, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CourseId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScriptLog) -> str - """ Get: CourseId(self: ApplicationScriptLog) -> str """ - - PatientId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScriptLog) -> str - """ Get: PatientId(self: ApplicationScriptLog) -> str """ - - PlanSetupId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScriptLog) -> str - """ Get: PlanSetupId(self: ApplicationScriptLog) -> str """ - - PlanUID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScriptLog) -> str - """ Get: PlanUID(self: ApplicationScriptLog) -> str """ - - Script = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScriptLog) -> ApplicationScript - """ Get: Script(self: ApplicationScriptLog) -> ApplicationScript """ - - ScriptFullName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScriptLog) -> str - """ Get: ScriptFullName(self: ApplicationScriptLog) -> str """ - - StructureSetId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScriptLog) -> str - """ Get: StructureSetId(self: ApplicationScriptLog) -> str """ - - StructureSetUID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ApplicationScriptLog) -> str - """ Get: StructureSetUID(self: ApplicationScriptLog) -> str """ - - - -class Applicator(AddOn, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Applicator, writer: XmlWriter) - """ WriteXml(self: Applicator, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class Beam(ApiDataObject, IXmlSerializable): - # no doc - def ApplyParameters(self, beamParams): - # type: (self: Beam, beamParams: BeamParameters) - """ ApplyParameters(self: Beam, beamParams: BeamParameters) """ - pass - - def CanSetOptimalFluence(self, fluence, message): - # type: (self: Beam, fluence: Fluence) -> (bool, str) - """ CanSetOptimalFluence(self: Beam, fluence: Fluence) -> (bool, str) """ - pass - - def CollimatorAngleToUser(self, val): - # type: (self: Beam, val: float) -> float - """ CollimatorAngleToUser(self: Beam, val: float) -> float """ - pass - - def CreateOrReplaceDRR(self, parameters): - # type: (self: Beam, parameters: DRRCalculationParameters) -> Image - """ CreateOrReplaceDRR(self: Beam, parameters: DRRCalculationParameters) -> Image """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def FitCollimatorToStructure(self, margins, structure, useAsymmetricXJaws, useAsymmetricYJaws, optimizeCollimatorRotation): - # type: (self: Beam, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) - """ FitCollimatorToStructure(self: Beam, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) """ - pass - - def FitMLCToOutline(self, outline, optimizeCollimatorRotation=None, jawFit=None, olmp=None, clmp=None): - # type: (self: Beam, outline: Array[Array[Point]])FitMLCToOutline(self: Beam, outline: Array[Array[Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) - """ FitMLCToOutline(self: Beam, outline: Array[Array[Point]])FitMLCToOutline(self: Beam, outline: Array[Array[Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) """ - pass - - def FitMLCToStructure(self, *__args): - # type: (self: Beam, structure: Structure)FitMLCToStructure(self: Beam, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) - """ FitMLCToStructure(self: Beam, structure: Structure)FitMLCToStructure(self: Beam, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) """ - pass - - def GantryAngleToUser(self, val): - # type: (self: Beam, val: float) -> float - """ GantryAngleToUser(self: Beam, val: float) -> float """ - pass - - def GetEditableParameters(self): - # type: (self: Beam) -> BeamParameters - """ GetEditableParameters(self: Beam) -> BeamParameters """ - pass - - def GetOptimalFluence(self): - # type: (self: Beam) -> Fluence - """ GetOptimalFluence(self: Beam) -> Fluence """ - pass - - def GetSourceLocation(self, gantryAngle): - # type: (self: Beam, gantryAngle: float) -> VVector - """ GetSourceLocation(self: Beam, gantryAngle: float) -> VVector """ - pass - - def GetStructureOutlines(self, structure, inBEV): - # type: (self: Beam, structure: Structure, inBEV: bool) -> Array[Array[Point]] - """ GetStructureOutlines(self: Beam, structure: Structure, inBEV: bool) -> Array[Array[Point]] """ - pass - - def JawPositionsToUserString(self, val): - # type: (self: Beam, val: VRect[float]) -> str - """ JawPositionsToUserString(self: Beam, val: VRect[float]) -> str """ - pass - - def PatientSupportAngleToUser(self, val): - # type: (self: Beam, val: float) -> float - """ PatientSupportAngleToUser(self: Beam, val: float) -> float """ - pass - - def SetOptimalFluence(self, fluence): - # type: (self: Beam, fluence: Fluence) - """ SetOptimalFluence(self: Beam, fluence: Fluence) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Beam, writer: XmlWriter) - """ WriteXml(self: Beam, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Applicator = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> Applicator - """ Get: Applicator(self: Beam) -> Applicator """ - - ArcLength = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> float - """ Get: ArcLength(self: Beam) -> float """ - - AverageSSD = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> float - """ Get: AverageSSD(self: Beam) -> float """ - - BeamNumber = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> int - """ Get: BeamNumber(self: Beam) -> int """ - - Blocks = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> IEnumerable[Block] - """ Get: Blocks(self: Beam) -> IEnumerable[Block] """ - - Boluses = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> IEnumerable[Bolus] - """ Get: Boluses(self: Beam) -> IEnumerable[Bolus] """ - - CalculationLogs = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> IEnumerable[BeamCalculationLog] - """ Get: CalculationLogs(self: Beam) -> IEnumerable[BeamCalculationLog] """ - - Compensator = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> Compensator - """ Get: Compensator(self: Beam) -> Compensator """ - - ControlPoints = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> ControlPointCollection - """ Get: ControlPoints(self: Beam) -> ControlPointCollection """ - - CreationDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> Nullable[DateTime] - """ Get: CreationDateTime(self: Beam) -> Nullable[DateTime] """ - - Dose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> BeamDose - """ Get: Dose(self: Beam) -> BeamDose """ - - DoseRate = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> int - """ Get: DoseRate(self: Beam) -> int """ - - DosimetricLeafGap = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> float - """ Get: DosimetricLeafGap(self: Beam) -> float """ - - EnergyModeDisplayName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> str - """ Get: EnergyModeDisplayName(self: Beam) -> str """ - - FieldReferencePoints = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> IEnumerable[FieldReferencePoint] - """ Get: FieldReferencePoints(self: Beam) -> IEnumerable[FieldReferencePoint] """ - - GantryDirection = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> GantryDirection - """ Get: GantryDirection(self: Beam) -> GantryDirection """ - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> str - """ - Get: Id(self: Beam) -> str - - Set: Id(self: Beam) = value - """ - - IsocenterPosition = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> VVector - """ Get: IsocenterPosition(self: Beam) -> VVector """ - - IsSetupField = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> bool - """ Get: IsSetupField(self: Beam) -> bool """ - - Meterset = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> MetersetValue - """ Get: Meterset(self: Beam) -> MetersetValue """ - - MetersetPerGy = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> float - """ Get: MetersetPerGy(self: Beam) -> float """ - - MLC = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> MLC - """ Get: MLC(self: Beam) -> MLC """ - - MLCPlanType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> MLCPlanType - """ Get: MLCPlanType(self: Beam) -> MLCPlanType """ - - MLCTransmissionFactor = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> float - """ Get: MLCTransmissionFactor(self: Beam) -> float """ - - MotionCompensationTechnique = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> str - """ Get: MotionCompensationTechnique(self: Beam) -> str """ - - MotionSignalSource = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> str - """ Get: MotionSignalSource(self: Beam) -> str """ - - NormalizationFactor = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> float - """ Get: NormalizationFactor(self: Beam) -> float """ - - NormalizationMethod = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> str - """ Get: NormalizationMethod(self: Beam) -> str """ - - Plan = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> PlanSetup - """ Get: Plan(self: Beam) -> PlanSetup """ - - PlannedSSD = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> float - """ Get: PlannedSSD(self: Beam) -> float """ - - ReferenceImage = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> Image - """ Get: ReferenceImage(self: Beam) -> Image """ - - SetupTechnique = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> SetupTechnique - """ Get: SetupTechnique(self: Beam) -> SetupTechnique """ - - SSD = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> float - """ Get: SSD(self: Beam) -> float """ - - SSDAtStopAngle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> float - """ Get: SSDAtStopAngle(self: Beam) -> float """ - - Technique = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> Technique - """ Get: Technique(self: Beam) -> Technique """ - - ToleranceTableLabel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> str - """ Get: ToleranceTableLabel(self: Beam) -> str """ - - Trays = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> IEnumerable[Tray] - """ Get: Trays(self: Beam) -> IEnumerable[Tray] """ - - TreatmentTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> float - """ Get: TreatmentTime(self: Beam) -> float """ - - TreatmentUnit = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> ExternalBeamTreatmentUnit - """ Get: TreatmentUnit(self: Beam) -> ExternalBeamTreatmentUnit """ - - Wedges = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> IEnumerable[Wedge] - """ Get: Wedges(self: Beam) -> IEnumerable[Wedge] """ - - WeightFactor = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Beam) -> float - """ Get: WeightFactor(self: Beam) -> float """ - - - -class BeamCalculationLog(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: BeamCalculationLog, writer: XmlWriter) - """ WriteXml(self: BeamCalculationLog, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Beam = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamCalculationLog) -> Beam - """ Get: Beam(self: BeamCalculationLog) -> Beam """ - - Category = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamCalculationLog) -> str - """ Get: Category(self: BeamCalculationLog) -> str """ - - MessageLines = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamCalculationLog) -> IEnumerable[str] - """ Get: MessageLines(self: BeamCalculationLog) -> IEnumerable[str] """ - - - -class Dose(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetDoseProfile(self, start, stop, preallocatedBuffer): - # type: (self: Dose, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> DoseProfile - """ GetDoseProfile(self: Dose, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> DoseProfile """ - pass - - def GetDoseToPoint(self, at): - # type: (self: Dose, at: VVector) -> DoseValue - """ GetDoseToPoint(self: Dose, at: VVector) -> DoseValue """ - pass - - def GetVoxels(self, planeIndex, preallocatedBuffer): - # type: (self: Dose, planeIndex: int, preallocatedBuffer: Array[int]) - """ GetVoxels(self: Dose, planeIndex: int, preallocatedBuffer: Array[int]) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def VoxelToDoseValue(self, voxelValue): - # type: (self: Dose, voxelValue: int) -> DoseValue - """ VoxelToDoseValue(self: Dose, voxelValue: int) -> DoseValue """ - pass - - def WriteXml(self, writer): - # type: (self: Dose, writer: XmlWriter) - """ WriteXml(self: Dose, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - DoseMax3D = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> DoseValue - """ Get: DoseMax3D(self: Dose) -> DoseValue """ - - DoseMax3DLocation = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> VVector - """ Get: DoseMax3DLocation(self: Dose) -> VVector """ - - Isodoses = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> IEnumerable[Isodose] - """ Get: Isodoses(self: Dose) -> IEnumerable[Isodose] """ - - Origin = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> VVector - """ Get: Origin(self: Dose) -> VVector """ - - Series = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> Series - """ Get: Series(self: Dose) -> Series """ - - SeriesUID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> str - """ Get: SeriesUID(self: Dose) -> str """ - - UID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> str - """ Get: UID(self: Dose) -> str """ - - XDirection = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> VVector - """ Get: XDirection(self: Dose) -> VVector """ - - XRes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> float - """ Get: XRes(self: Dose) -> float """ - - XSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> int - """ Get: XSize(self: Dose) -> int """ - - YDirection = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> VVector - """ Get: YDirection(self: Dose) -> VVector """ - - YRes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> float - """ Get: YRes(self: Dose) -> float """ - - YSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> int - """ Get: YSize(self: Dose) -> int """ - - ZDirection = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> VVector - """ Get: ZDirection(self: Dose) -> VVector """ - - ZRes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> float - """ Get: ZRes(self: Dose) -> float """ - - ZSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Dose) -> int - """ Get: ZSize(self: Dose) -> int """ - - - -class BeamDose(Dose, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetAbsoluteBeamDoseValue(self, relative): - # type: (self: BeamDose, relative: DoseValue) -> DoseValue - """ GetAbsoluteBeamDoseValue(self: BeamDose, relative: DoseValue) -> DoseValue """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: BeamDose, writer: XmlWriter) - """ WriteXml(self: BeamDose, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class BeamParameters(object): - # no doc - def SetAllLeafPositions(self, leafPositions): - # type: (self: BeamParameters, leafPositions: Array[Single]) - """ SetAllLeafPositions(self: BeamParameters, leafPositions: Array[Single]) """ - pass - - def SetJawPositions(self, positions): - # type: (self: BeamParameters, positions: VRect[float]) - """ SetJawPositions(self: BeamParameters, positions: VRect[float]) """ - pass - - ControlPoints = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamParameters) -> IEnumerable[ControlPointParameters] - """ Get: ControlPoints(self: BeamParameters) -> IEnumerable[ControlPointParameters] """ - - GantryDirection = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamParameters) -> GantryDirection - """ Get: GantryDirection(self: BeamParameters) -> GantryDirection """ - - Isocenter = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamParameters) -> VVector - """ - Get: Isocenter(self: BeamParameters) -> VVector - - Set: Isocenter(self: BeamParameters) = value - """ - - WeightFactor = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamParameters) -> float - """ - Get: WeightFactor(self: BeamParameters) -> float - - Set: WeightFactor(self: BeamParameters) = value - """ - - - -class BeamUncertainty(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: BeamUncertainty, writer: XmlWriter) - """ WriteXml(self: BeamUncertainty, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Beam = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamUncertainty) -> Beam - """ Get: Beam(self: BeamUncertainty) -> Beam """ - - BeamNumber = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamUncertainty) -> BeamNumber - """ Get: BeamNumber(self: BeamUncertainty) -> BeamNumber """ - - Dose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamUncertainty) -> Dose - """ Get: Dose(self: BeamUncertainty) -> Dose """ - - - -class Block(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Block, writer: XmlWriter) - """ WriteXml(self: Block, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - AddOnMaterial = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Block) -> AddOnMaterial - """ Get: AddOnMaterial(self: Block) -> AddOnMaterial """ - - IsDiverging = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Block) -> bool - """ Get: IsDiverging(self: Block) -> bool """ - - Outline = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Block) -> Array[Array[Point]] - """ Get: Outline(self: Block) -> Array[Array[Point]] """ - - TransmissionFactor = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Block) -> float - """ Get: TransmissionFactor(self: Block) -> float """ - - Tray = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Block) -> Tray - """ Get: Tray(self: Block) -> Tray """ - - TrayTransmissionFactor = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Block) -> float - """ Get: TrayTransmissionFactor(self: Block) -> float """ - - Type = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Block) -> BlockType - """ Get: Type(self: Block) -> BlockType """ - - - -class Bolus(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Bolus, writer: XmlWriter) - """ WriteXml(self: Bolus, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Bolus) -> str - """ Get: Id(self: Bolus) -> str """ - - MaterialCTValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Bolus) -> float - """ Get: MaterialCTValue(self: Bolus) -> float """ - - Name = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Bolus) -> str - """ Get: Name(self: Bolus) -> str """ - - - -class BrachyFieldReferencePoint(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: BrachyFieldReferencePoint, writer: XmlWriter) - """ WriteXml(self: BrachyFieldReferencePoint, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - FieldDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyFieldReferencePoint) -> DoseValue - """ Get: FieldDose(self: BrachyFieldReferencePoint) -> DoseValue """ - - IsFieldDoseNominal = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyFieldReferencePoint) -> bool - """ Get: IsFieldDoseNominal(self: BrachyFieldReferencePoint) -> bool """ - - IsPrimaryReferencePoint = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyFieldReferencePoint) -> bool - """ Get: IsPrimaryReferencePoint(self: BrachyFieldReferencePoint) -> bool """ - - ReferencePoint = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyFieldReferencePoint) -> ReferencePoint - """ Get: ReferencePoint(self: BrachyFieldReferencePoint) -> ReferencePoint """ - - RefPointLocation = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyFieldReferencePoint) -> VVector - """ Get: RefPointLocation(self: BrachyFieldReferencePoint) -> VVector """ - - - -class PlanningItem(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetDoseAtVolume(self, structure, volume, volumePresentation, requestedDosePresentation): - # type: (self: PlanningItem, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue - """ GetDoseAtVolume(self: PlanningItem, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue """ - pass - - def GetDVHCumulativeData(self, structure, dosePresentation, volumePresentation, binWidth): - # type: (self: PlanningItem, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData - """ GetDVHCumulativeData(self: PlanningItem, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData """ - pass - - def GetVolumeAtDose(self, structure, dose, requestedVolumePresentation): - # type: (self: PlanningItem, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float - """ GetVolumeAtDose(self: PlanningItem, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: PlanningItem, writer: XmlWriter) - """ WriteXml(self: PlanningItem, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CreationDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanningItem) -> Nullable[DateTime] - """ Get: CreationDateTime(self: PlanningItem) -> Nullable[DateTime] """ - - Dose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanningItem) -> PlanningItemDose - """ Get: Dose(self: PlanningItem) -> PlanningItemDose """ - - DoseValuePresentation = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanningItem) -> DoseValuePresentation - """ - Get: DoseValuePresentation(self: PlanningItem) -> DoseValuePresentation - - Set: DoseValuePresentation(self: PlanningItem) = value - """ - - StructureSet = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanningItem) -> StructureSet - """ Get: StructureSet(self: PlanningItem) -> StructureSet """ - - StructuresSelectedForDvh = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanningItem) -> IEnumerable[Structure] - """ Get: StructuresSelectedForDvh(self: PlanningItem) -> IEnumerable[Structure] """ - - - -class PlanSetup(PlanningItem, IXmlSerializable): - # no doc - def AddReferencePoint(self, structure, location, id, name): - # type: (self: PlanSetup, structure: Structure, location: Nullable[VVector], id: str, name: str) -> ReferencePoint - """ AddReferencePoint(self: PlanSetup, structure: Structure, location: Nullable[VVector], id: str, name: str) -> ReferencePoint """ - pass - - def AttachToCalcClient(self, *args): #cannot find CLR method - # type: (self: PlanSetup, doseCalcClient: ICalculationClient) - """ AttachToCalcClient(self: PlanSetup, doseCalcClient: ICalculationClient) """ - pass - - def ClearCalculationModel(self, calculationType): - # type: (self: PlanSetup, calculationType: CalculationType) - """ ClearCalculationModel(self: PlanSetup, calculationType: CalculationType) """ - pass - - def DetachFromCalcClient(self, *args): #cannot find CLR method - # type: (self: PlanSetup, doseCalcClient: ICalculationClient) - """ DetachFromCalcClient(self: PlanSetup, doseCalcClient: ICalculationClient) """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetCalculationModel(self, calculationType): - # type: (self: PlanSetup, calculationType: CalculationType) -> str - """ GetCalculationModel(self: PlanSetup, calculationType: CalculationType) -> str """ - pass - - def GetCalculationOption(self, calculationModel, optionName, optionValue): - # type: (self: PlanSetup, calculationModel: str, optionName: str) -> (bool, str) - """ GetCalculationOption(self: PlanSetup, calculationModel: str, optionName: str) -> (bool, str) """ - pass - - def GetCalculationOptions(self, calculationModel): - # type: (self: PlanSetup, calculationModel: str) -> Dictionary[str, str] - """ GetCalculationOptions(self: PlanSetup, calculationModel: str) -> Dictionary[str, str] """ - pass - - def GetProtocolPrescriptionsAndMeasures(self, prescriptions, measures): - # type: (self: PlanSetup, prescriptions: List[ProtocolPhasePrescription], measures: List[ProtocolPhaseMeasure]) -> (List[ProtocolPhasePrescription], List[ProtocolPhaseMeasure]) - """ GetProtocolPrescriptionsAndMeasures(self: PlanSetup, prescriptions: List[ProtocolPhasePrescription], measures: List[ProtocolPhaseMeasure]) -> (List[ProtocolPhasePrescription], List[ProtocolPhaseMeasure]) """ - pass - - def Report(self, *args): #cannot find CLR method - # type: (self: PlanSetup, str: str) - """ Report(self: PlanSetup, str: str) """ - pass - - def SetCalculationModel(self, calculationType, model): - # type: (self: PlanSetup, calculationType: CalculationType, model: str) - """ SetCalculationModel(self: PlanSetup, calculationType: CalculationType, model: str) """ - pass - - def SetCalculationOption(self, calculationModel, optionName, optionValue): - # type: (self: PlanSetup, calculationModel: str, optionName: str, optionValue: str) -> bool - """ SetCalculationOption(self: PlanSetup, calculationModel: str, optionName: str, optionValue: str) -> bool """ - pass - - def SetPrescription(self, numberOfFractions, dosePerFraction, treatmentPercentage): - # type: (self: PlanSetup, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) - """ SetPrescription(self: PlanSetup, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: PlanSetup, writer: XmlWriter) - """ WriteXml(self: PlanSetup, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ApplicationScriptLogs = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> IEnumerable[ApplicationScriptLog] - """ Get: ApplicationScriptLogs(self: PlanSetup) -> IEnumerable[ApplicationScriptLog] """ - - ApprovalHistory = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> IEnumerable[ApprovalHistoryEntry] - """ Get: ApprovalHistory(self: PlanSetup) -> IEnumerable[ApprovalHistoryEntry] """ - - ApprovalStatus = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> PlanSetupApprovalStatus - """ Get: ApprovalStatus(self: PlanSetup) -> PlanSetupApprovalStatus """ - - Beams = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> IEnumerable[Beam] - """ Get: Beams(self: PlanSetup) -> IEnumerable[Beam] """ - - Course = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> Course - """ Get: Course(self: PlanSetup) -> Course """ - - CreationUserName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: CreationUserName(self: PlanSetup) -> str """ - - DosePerFraction = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> DoseValue - """ Get: DosePerFraction(self: PlanSetup) -> DoseValue """ - - DosePerFractionInPrimaryRefPoint = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> DoseValue - """ Get: DosePerFractionInPrimaryRefPoint(self: PlanSetup) -> DoseValue """ - - DVHEstimates = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> IEnumerable[EstimatedDVH] - """ Get: DVHEstimates(self: PlanSetup) -> IEnumerable[EstimatedDVH] """ - - ElectronCalculationModel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: ElectronCalculationModel(self: PlanSetup) -> str """ - - ElectronCalculationOptions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> Dictionary[str, str] - """ Get: ElectronCalculationOptions(self: PlanSetup) -> Dictionary[str, str] """ - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ - Get: Id(self: PlanSetup) -> str - - Set: Id(self: PlanSetup) = value - """ - - IsDoseValid = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> bool - """ Get: IsDoseValid(self: PlanSetup) -> bool """ - - IsTreated = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> bool - """ Get: IsTreated(self: PlanSetup) -> bool """ - - NumberOfFractions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> Nullable[int] - """ Get: NumberOfFractions(self: PlanSetup) -> Nullable[int] """ - - OptimizationSetup = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> OptimizationSetup - """ Get: OptimizationSetup(self: PlanSetup) -> OptimizationSetup """ - - PhotonCalculationModel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: PhotonCalculationModel(self: PlanSetup) -> str """ - - PhotonCalculationOptions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> Dictionary[str, str] - """ Get: PhotonCalculationOptions(self: PlanSetup) -> Dictionary[str, str] """ - - PlanIntent = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: PlanIntent(self: PlanSetup) -> str """ - - PlannedDosePerFraction = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> DoseValue - """ Get: PlannedDosePerFraction(self: PlanSetup) -> DoseValue """ - - PlanningApprovalDate = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: PlanningApprovalDate(self: PlanSetup) -> str """ - - PlanningApprover = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: PlanningApprover(self: PlanSetup) -> str """ - - PlanningApproverDisplayName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: PlanningApproverDisplayName(self: PlanSetup) -> str """ - - PlanNormalizationMethod = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: PlanNormalizationMethod(self: PlanSetup) -> str """ - - PlanNormalizationPoint = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> VVector - """ Get: PlanNormalizationPoint(self: PlanSetup) -> VVector """ - - PlanNormalizationValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> float - """ - Get: PlanNormalizationValue(self: PlanSetup) -> float - - Set: PlanNormalizationValue(self: PlanSetup) = value - """ - - PlanObjectiveStructures = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> IEnumerable[str] - """ Get: PlanObjectiveStructures(self: PlanSetup) -> IEnumerable[str] """ - - PlanType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> PlanType - """ Get: PlanType(self: PlanSetup) -> PlanType """ - - PlanUncertainties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> IEnumerable[PlanUncertainty] - """ Get: PlanUncertainties(self: PlanSetup) -> IEnumerable[PlanUncertainty] """ - - PredecessorPlan = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> PlanSetup - """ Get: PredecessorPlan(self: PlanSetup) -> PlanSetup """ - - PrescribedDosePerFraction = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> DoseValue - """ Get: PrescribedDosePerFraction(self: PlanSetup) -> DoseValue """ - - PrescribedPercentage = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> float - """ Get: PrescribedPercentage(self: PlanSetup) -> float """ - - PrimaryReferencePoint = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> ReferencePoint - """ Get: PrimaryReferencePoint(self: PlanSetup) -> ReferencePoint """ - - ProtocolID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: ProtocolID(self: PlanSetup) -> str """ - - ProtocolPhaseID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: ProtocolPhaseID(self: PlanSetup) -> str """ - - ProtonCalculationModel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: ProtonCalculationModel(self: PlanSetup) -> str """ - - ProtonCalculationOptions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> Dictionary[str, str] - """ Get: ProtonCalculationOptions(self: PlanSetup) -> Dictionary[str, str] """ - - ReferencePoints = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> IEnumerable[ReferencePoint] - """ Get: ReferencePoints(self: PlanSetup) -> IEnumerable[ReferencePoint] """ - - RTPrescription = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> RTPrescription - """ Get: RTPrescription(self: PlanSetup) -> RTPrescription """ - - Series = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> Series - """ Get: Series(self: PlanSetup) -> Series """ - - SeriesUID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: SeriesUID(self: PlanSetup) -> str """ - - TargetVolumeID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: TargetVolumeID(self: PlanSetup) -> str """ - - TotalDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> DoseValue - """ Get: TotalDose(self: PlanSetup) -> DoseValue """ - - TotalPrescribedDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> DoseValue - """ Get: TotalPrescribedDose(self: PlanSetup) -> DoseValue """ - - TreatmentApprovalDate = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: TreatmentApprovalDate(self: PlanSetup) -> str """ - - TreatmentApprover = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: TreatmentApprover(self: PlanSetup) -> str """ - - TreatmentApproverDisplayName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: TreatmentApproverDisplayName(self: PlanSetup) -> str """ - - TreatmentOrientation = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> PatientOrientation - """ Get: TreatmentOrientation(self: PlanSetup) -> PatientOrientation """ - - TreatmentPercentage = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> float - """ Get: TreatmentPercentage(self: PlanSetup) -> float """ - - TreatmentSessions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> IEnumerable[PlanTreatmentSession] - """ Get: TreatmentSessions(self: PlanSetup) -> IEnumerable[PlanTreatmentSession] """ - - UID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> str - """ Get: UID(self: PlanSetup) -> str """ - - UseGating = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> bool - """ - Get: UseGating(self: PlanSetup) -> bool - - Set: UseGating(self: PlanSetup) = value - """ - - VerifiedPlan = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSetup) -> PlanSetup - """ Get: VerifiedPlan(self: PlanSetup) -> PlanSetup """ - - - m_errorsOnCalculationCompleted = None - - -class BrachyPlanSetup(PlanSetup, IXmlSerializable): - # no doc - def AttachToCalcClient(self, *args): #cannot find CLR method - # type: (self: PlanSetup, doseCalcClient: ICalculationClient) - """ AttachToCalcClient(self: PlanSetup, doseCalcClient: ICalculationClient) """ - pass - - def CalculateAccurateTG43DoseProfile(self, start, stop, preallocatedBuffer): - # type: (self: BrachyPlanSetup, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> DoseProfile - """ CalculateAccurateTG43DoseProfile(self: BrachyPlanSetup, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> DoseProfile """ - pass - - def DetachFromCalcClient(self, *args): #cannot find CLR method - # type: (self: PlanSetup, doseCalcClient: ICalculationClient) - """ DetachFromCalcClient(self: PlanSetup, doseCalcClient: ICalculationClient) """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def Report(self, *args): #cannot find CLR method - # type: (self: PlanSetup, str: str) - """ Report(self: PlanSetup, str: str) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: BrachyPlanSetup, writer: XmlWriter) - """ WriteXml(self: BrachyPlanSetup, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ApplicationSetupType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyPlanSetup) -> str - """ Get: ApplicationSetupType(self: BrachyPlanSetup) -> str """ - - Catheters = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyPlanSetup) -> IEnumerable[Catheter] - """ Get: Catheters(self: BrachyPlanSetup) -> IEnumerable[Catheter] """ - - NumberOfPdrPulses = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyPlanSetup) -> Nullable[int] - """ Get: NumberOfPdrPulses(self: BrachyPlanSetup) -> Nullable[int] """ - - PdrPulseInterval = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyPlanSetup) -> Nullable[float] - """ Get: PdrPulseInterval(self: BrachyPlanSetup) -> Nullable[float] """ - - SeedCollections = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyPlanSetup) -> IEnumerable[SeedCollection] - """ Get: SeedCollections(self: BrachyPlanSetup) -> IEnumerable[SeedCollection] """ - - SolidApplicators = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyPlanSetup) -> IEnumerable[BrachySolidApplicator] - """ Get: SolidApplicators(self: BrachyPlanSetup) -> IEnumerable[BrachySolidApplicator] """ - - TreatmentDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyPlanSetup) -> Nullable[DateTime] - """ Get: TreatmentDateTime(self: BrachyPlanSetup) -> Nullable[DateTime] """ - - TreatmentTechnique = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyPlanSetup) -> str - """ Get: TreatmentTechnique(self: BrachyPlanSetup) -> str """ - - - m_errorsOnCalculationCompleted = None - - -class BrachySolidApplicator(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: BrachySolidApplicator, writer: XmlWriter) - """ WriteXml(self: BrachySolidApplicator, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ApplicatorSetName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachySolidApplicator) -> str - """ Get: ApplicatorSetName(self: BrachySolidApplicator) -> str """ - - ApplicatorSetType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachySolidApplicator) -> str - """ Get: ApplicatorSetType(self: BrachySolidApplicator) -> str """ - - Category = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachySolidApplicator) -> str - """ Get: Category(self: BrachySolidApplicator) -> str """ - - Catheters = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachySolidApplicator) -> IEnumerable[Catheter] - """ Get: Catheters(self: BrachySolidApplicator) -> IEnumerable[Catheter] """ - - Note = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachySolidApplicator) -> str - """ Get: Note(self: BrachySolidApplicator) -> str """ - - PartName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachySolidApplicator) -> str - """ Get: PartName(self: BrachySolidApplicator) -> str """ - - PartNumber = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachySolidApplicator) -> str - """ Get: PartNumber(self: BrachySolidApplicator) -> str """ - - Summary = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachySolidApplicator) -> str - """ Get: Summary(self: BrachySolidApplicator) -> str """ - - UID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachySolidApplicator) -> str - """ Get: UID(self: BrachySolidApplicator) -> str """ - - Vendor = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachySolidApplicator) -> str - """ Get: Vendor(self: BrachySolidApplicator) -> str """ - - Version = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachySolidApplicator) -> str - """ Get: Version(self: BrachySolidApplicator) -> str """ - - - -class BrachyTreatmentUnit(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetActiveRadioactiveSource(self): - # type: (self: BrachyTreatmentUnit) -> RadioactiveSource - """ GetActiveRadioactiveSource(self: BrachyTreatmentUnit) -> RadioactiveSource """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: BrachyTreatmentUnit, writer: XmlWriter) - """ WriteXml(self: BrachyTreatmentUnit, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - DoseRateMode = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> str - """ Get: DoseRateMode(self: BrachyTreatmentUnit) -> str """ - - DwellTimeResolution = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> float - """ Get: DwellTimeResolution(self: BrachyTreatmentUnit) -> float """ - - MachineInterface = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> str - """ Get: MachineInterface(self: BrachyTreatmentUnit) -> str """ - - MachineModel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> str - """ Get: MachineModel(self: BrachyTreatmentUnit) -> str """ - - MaxDwellTimePerChannel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> float - """ Get: MaxDwellTimePerChannel(self: BrachyTreatmentUnit) -> float """ - - MaxDwellTimePerPos = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> float - """ Get: MaxDwellTimePerPos(self: BrachyTreatmentUnit) -> float """ - - MaxDwellTimePerTreatment = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> float - """ Get: MaxDwellTimePerTreatment(self: BrachyTreatmentUnit) -> float """ - - MaximumChannelLength = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> float - """ Get: MaximumChannelLength(self: BrachyTreatmentUnit) -> float """ - - MaximumDwellPositionsPerChannel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> int - """ Get: MaximumDwellPositionsPerChannel(self: BrachyTreatmentUnit) -> int """ - - MaximumStepSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> float - """ Get: MaximumStepSize(self: BrachyTreatmentUnit) -> float """ - - MinimumChannelLength = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> float - """ Get: MinimumChannelLength(self: BrachyTreatmentUnit) -> float """ - - MinimumStepSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> float - """ Get: MinimumStepSize(self: BrachyTreatmentUnit) -> float """ - - NumberOfChannels = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> int - """ Get: NumberOfChannels(self: BrachyTreatmentUnit) -> int """ - - SourceCenterOffsetFromTip = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> float - """ Get: SourceCenterOffsetFromTip(self: BrachyTreatmentUnit) -> float """ - - SourceMovementType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> str - """ Get: SourceMovementType(self: BrachyTreatmentUnit) -> str """ - - StepSizeResolution = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BrachyTreatmentUnit) -> float - """ Get: StepSizeResolution(self: BrachyTreatmentUnit) -> float """ - - - -class CalculationResult(object): - # no doc - Success = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: CalculationResult) -> bool - """ Get: Success(self: CalculationResult) -> bool """ - - - -class Catheter(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetSourcePosCenterDistanceFromTip(self, sourcePosition): - # type: (self: Catheter, sourcePosition: SourcePosition) -> float - """ GetSourcePosCenterDistanceFromTip(self: Catheter, sourcePosition: SourcePosition) -> float """ - pass - - def GetTotalDwellTime(self): - # type: (self: Catheter) -> float - """ GetTotalDwellTime(self: Catheter) -> float """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Catheter, writer: XmlWriter) - """ WriteXml(self: Catheter, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ApplicatorLength = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Catheter) -> float - """ Get: ApplicatorLength(self: Catheter) -> float """ - - BrachyFieldReferencePoints = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Catheter) -> IEnumerable[BrachyFieldReferencePoint] - """ Get: BrachyFieldReferencePoints(self: Catheter) -> IEnumerable[BrachyFieldReferencePoint] """ - - BrachySolidApplicatorPartID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Catheter) -> int - """ Get: BrachySolidApplicatorPartID(self: Catheter) -> int """ - - ChannelNumber = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Catheter) -> int - """ Get: ChannelNumber(self: Catheter) -> int """ - - Color = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Catheter) -> Color - """ Get: Color(self: Catheter) -> Color """ - - DeadSpaceLength = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Catheter) -> float - """ Get: DeadSpaceLength(self: Catheter) -> float """ - - Shape = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Catheter) -> Array[VVector] - """ Get: Shape(self: Catheter) -> Array[VVector] """ - - SourcePositions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Catheter) -> IEnumerable[SourcePosition] - """ Get: SourcePositions(self: Catheter) -> IEnumerable[SourcePosition] """ - - StepSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Catheter) -> float - """ Get: StepSize(self: Catheter) -> float """ - - TreatmentUnit = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Catheter) -> BrachyTreatmentUnit - """ Get: TreatmentUnit(self: Catheter) -> BrachyTreatmentUnit """ - - - -class Compensator(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Compensator, writer: XmlWriter) - """ WriteXml(self: Compensator, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Material = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Compensator) -> AddOnMaterial - """ Get: Material(self: Compensator) -> AddOnMaterial """ - - Slot = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Compensator) -> Slot - """ Get: Slot(self: Compensator) -> Slot """ - - Tray = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Compensator) -> Tray - """ Get: Tray(self: Compensator) -> Tray """ - - - -class ControlPoint(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: ControlPoint, writer: XmlWriter) - """ WriteXml(self: ControlPoint, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Beam = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPoint) -> Beam - """ Get: Beam(self: ControlPoint) -> Beam """ - - CollimatorAngle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPoint) -> float - """ Get: CollimatorAngle(self: ControlPoint) -> float """ - - GantryAngle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPoint) -> float - """ Get: GantryAngle(self: ControlPoint) -> float """ - - Index = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPoint) -> int - """ Get: Index(self: ControlPoint) -> int """ - - JawPositions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPoint) -> VRect[float] - """ Get: JawPositions(self: ControlPoint) -> VRect[float] """ - - LeafPositions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPoint) -> Array[Single] - """ Get: LeafPositions(self: ControlPoint) -> Array[Single] """ - - MetersetWeight = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPoint) -> float - """ Get: MetersetWeight(self: ControlPoint) -> float """ - - PatientSupportAngle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPoint) -> float - """ Get: PatientSupportAngle(self: ControlPoint) -> float """ - - TableTopLateralPosition = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPoint) -> float - """ Get: TableTopLateralPosition(self: ControlPoint) -> float """ - - TableTopLongitudinalPosition = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPoint) -> float - """ Get: TableTopLongitudinalPosition(self: ControlPoint) -> float """ - - TableTopVerticalPosition = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPoint) -> float - """ Get: TableTopVerticalPosition(self: ControlPoint) -> float """ - - - -class ControlPointCollection(SerializableObject, IXmlSerializable, IEnumerable[ControlPoint], IEnumerable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetEnumerator(self): - # type: (self: ControlPointCollection) -> IEnumerator[ControlPoint] - """ GetEnumerator(self: ControlPointCollection) -> IEnumerator[ControlPoint] """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: ControlPointCollection, writer: XmlWriter) - """ WriteXml(self: ControlPointCollection, writer: XmlWriter) """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[ControlPoint](enumerable: IEnumerable[ControlPoint], value: ControlPoint) -> bool """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPointCollection) -> int - """ Get: Count(self: ControlPointCollection) -> int """ - - - -class ControlPointParameters(object): - # no doc - CollimatorAngle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPointParameters) -> float - """ Get: CollimatorAngle(self: ControlPointParameters) -> float """ - - GantryAngle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPointParameters) -> float - """ Get: GantryAngle(self: ControlPointParameters) -> float """ - - Index = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPointParameters) -> int - """ Get: Index(self: ControlPointParameters) -> int """ - - JawPositions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPointParameters) -> VRect[float] - """ - Get: JawPositions(self: ControlPointParameters) -> VRect[float] - - Set: JawPositions(self: ControlPointParameters) = value - """ - - LeafPositions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPointParameters) -> Array[Single] - """ - Get: LeafPositions(self: ControlPointParameters) -> Array[Single] - - Set: LeafPositions(self: ControlPointParameters) = value - """ - - MetersetWeight = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPointParameters) -> float - """ Get: MetersetWeight(self: ControlPointParameters) -> float """ - - PatientSupportAngle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPointParameters) -> float - """ Get: PatientSupportAngle(self: ControlPointParameters) -> float """ - - TableTopLateralPosition = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPointParameters) -> float - """ Get: TableTopLateralPosition(self: ControlPointParameters) -> float """ - - TableTopLongitudinalPosition = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPointParameters) -> float - """ Get: TableTopLongitudinalPosition(self: ControlPointParameters) -> float """ - - TableTopVerticalPosition = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ControlPointParameters) -> float - """ Get: TableTopVerticalPosition(self: ControlPointParameters) -> float """ - - - -class Course(ApiDataObject, IXmlSerializable): - # no doc - def AddExternalPlanSetup(self, structureSet): - # type: (self: Course, structureSet: StructureSet) -> ExternalPlanSetup - """ AddExternalPlanSetup(self: Course, structureSet: StructureSet) -> ExternalPlanSetup """ - pass - - def AddExternalPlanSetupAsVerificationPlan(self, structureSet, verifiedPlan): - # type: (self: Course, structureSet: StructureSet, verifiedPlan: ExternalPlanSetup) -> ExternalPlanSetup - """ AddExternalPlanSetupAsVerificationPlan(self: Course, structureSet: StructureSet, verifiedPlan: ExternalPlanSetup) -> ExternalPlanSetup """ - pass - - def AddIonPlanSetup(self, structureSet, patientSupportDeviceId): - # type: (self: Course, structureSet: StructureSet, patientSupportDeviceId: str) -> IonPlanSetup - """ AddIonPlanSetup(self: Course, structureSet: StructureSet, patientSupportDeviceId: str) -> IonPlanSetup """ - pass - - def AddIonPlanSetupAsVerificationPlan(self, structureSet, patientSupportDeviceId, verifiedPlan): - # type: (self: Course, structureSet: StructureSet, patientSupportDeviceId: str, verifiedPlan: IonPlanSetup) -> IonPlanSetup - """ AddIonPlanSetupAsVerificationPlan(self: Course, structureSet: StructureSet, patientSupportDeviceId: str, verifiedPlan: IonPlanSetup) -> IonPlanSetup """ - pass - - def CanAddPlanSetup(self, structureSet): - # type: (self: Course, structureSet: StructureSet) -> bool - """ CanAddPlanSetup(self: Course, structureSet: StructureSet) -> bool """ - pass - - def CanRemovePlanSetup(self, planSetup): - # type: (self: Course, planSetup: PlanSetup) -> bool - """ CanRemovePlanSetup(self: Course, planSetup: PlanSetup) -> bool """ - pass - - def CopyPlanSetup(self, sourcePlan, structureset=None, outputDiagnostics=None): - # type: (self: Course, sourcePlan: PlanSetup) -> PlanSetup - """ - CopyPlanSetup(self: Course, sourcePlan: PlanSetup) -> PlanSetup - CopyPlanSetup(self: Course, sourcePlan: PlanSetup, structureset: StructureSet, outputDiagnostics: StringBuilder) -> PlanSetup - """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def RemovePlanSetup(self, planSetup): - # type: (self: Course, planSetup: PlanSetup) - """ RemovePlanSetup(self: Course, planSetup: PlanSetup) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Course, writer: XmlWriter) - """ WriteXml(self: Course, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - BrachyPlanSetups = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> IEnumerable[BrachyPlanSetup] - """ Get: BrachyPlanSetups(self: Course) -> IEnumerable[BrachyPlanSetup] """ - - CompletedDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> Nullable[DateTime] - """ Get: CompletedDateTime(self: Course) -> Nullable[DateTime] """ - - Diagnoses = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> IEnumerable[Diagnosis] - """ Get: Diagnoses(self: Course) -> IEnumerable[Diagnosis] """ - - ExternalPlanSetups = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> IEnumerable[ExternalPlanSetup] - """ Get: ExternalPlanSetups(self: Course) -> IEnumerable[ExternalPlanSetup] """ - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> str - """ - Get: Id(self: Course) -> str - - Set: Id(self: Course) = value - """ - - Intent = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> str - """ Get: Intent(self: Course) -> str """ - - IonPlanSetups = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> IEnumerable[IonPlanSetup] - """ Get: IonPlanSetups(self: Course) -> IEnumerable[IonPlanSetup] """ - - Patient = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> Patient - """ Get: Patient(self: Course) -> Patient """ - - PlanSetups = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> IEnumerable[PlanSetup] - """ Get: PlanSetups(self: Course) -> IEnumerable[PlanSetup] """ - - PlanSums = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> IEnumerable[PlanSum] - """ Get: PlanSums(self: Course) -> IEnumerable[PlanSum] """ - - StartDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> Nullable[DateTime] - """ Get: StartDateTime(self: Course) -> Nullable[DateTime] """ - - TreatmentPhases = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> IEnumerable[TreatmentPhase] - """ Get: TreatmentPhases(self: Course) -> IEnumerable[TreatmentPhase] """ - - TreatmentSessions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Course) -> IEnumerable[TreatmentSession] - """ Get: TreatmentSessions(self: Course) -> IEnumerable[TreatmentSession] """ - - - -class CustomScriptExecutable(object): - # no doc - @staticmethod - def CreateApplication(scriptName): - # type: (scriptName: str) -> Application - """ CreateApplication(scriptName: str) -> Application """ - pass - - __all__ = [ - 'CreateApplication', - ] - - -class Diagnosis(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Diagnosis, writer: XmlWriter) - """ WriteXml(self: Diagnosis, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ClinicalDescription = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Diagnosis) -> str - """ Get: ClinicalDescription(self: Diagnosis) -> str """ - - Code = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Diagnosis) -> str - """ Get: Code(self: Diagnosis) -> str """ - - CodeTable = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Diagnosis) -> str - """ Get: CodeTable(self: Diagnosis) -> str """ - - - -class DVHData(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: DVHData, writer: XmlWriter) - """ WriteXml(self: DVHData, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Coverage = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHData) -> float - """ Get: Coverage(self: DVHData) -> float """ - - CurveData = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHData) -> Array[DVHPoint] - """ Get: CurveData(self: DVHData) -> Array[DVHPoint] """ - - MaxDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHData) -> DoseValue - """ Get: MaxDose(self: DVHData) -> DoseValue """ - - MeanDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHData) -> DoseValue - """ Get: MeanDose(self: DVHData) -> DoseValue """ - - MedianDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHData) -> DoseValue - """ Get: MedianDose(self: DVHData) -> DoseValue """ - - MinDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHData) -> DoseValue - """ Get: MinDose(self: DVHData) -> DoseValue """ - - SamplingCoverage = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHData) -> float - """ Get: SamplingCoverage(self: DVHData) -> float """ - - StdDev = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHData) -> float - """ Get: StdDev(self: DVHData) -> float """ - - Volume = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHData) -> float - """ Get: Volume(self: DVHData) -> float """ - - - -class Wedge(AddOn, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Wedge, writer: XmlWriter) - """ WriteXml(self: Wedge, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Direction = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Wedge) -> float - """ Get: Direction(self: Wedge) -> float """ - - WedgeAngle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Wedge) -> float - """ Get: WedgeAngle(self: Wedge) -> float """ - - - -class DynamicWedge(Wedge, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: DynamicWedge, writer: XmlWriter) - """ WriteXml(self: DynamicWedge, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class EnhancedDynamicWedge(DynamicWedge, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: EnhancedDynamicWedge, writer: XmlWriter) - """ WriteXml(self: EnhancedDynamicWedge, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class ESAPIActionPackAttribute(Attribute, _Attribute): - # type: () - """ ESAPIActionPackAttribute() """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - IsWriteable = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ESAPIActionPackAttribute) -> bool - """ - Get: IsWriteable(self: ESAPIActionPackAttribute) -> bool - - Set: IsWriteable(self: ESAPIActionPackAttribute) = value - """ - - - -class ESAPIScriptAttribute(Attribute, _Attribute): - # type: () - """ ESAPIScriptAttribute() """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - IsWriteable = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ESAPIScriptAttribute) -> bool - """ - Get: IsWriteable(self: ESAPIScriptAttribute) -> bool - - Set: IsWriteable(self: ESAPIScriptAttribute) = value - """ - - - -class EstimatedDVH(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: EstimatedDVH, writer: XmlWriter) - """ WriteXml(self: EstimatedDVH, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CurveData = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: EstimatedDVH) -> Array[DVHPoint] - """ Get: CurveData(self: EstimatedDVH) -> Array[DVHPoint] """ - - PlanSetup = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: EstimatedDVH) -> PlanSetup - """ Get: PlanSetup(self: EstimatedDVH) -> PlanSetup """ - - PlanSetupId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: EstimatedDVH) -> str - """ Get: PlanSetupId(self: EstimatedDVH) -> str """ - - Structure = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: EstimatedDVH) -> Structure - """ Get: Structure(self: EstimatedDVH) -> Structure """ - - StructureId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: EstimatedDVH) -> str - """ Get: StructureId(self: EstimatedDVH) -> str """ - - TargetDoseLevel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: EstimatedDVH) -> DoseValue - """ Get: TargetDoseLevel(self: EstimatedDVH) -> DoseValue """ - - Type = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: EstimatedDVH) -> DVHEstimateType - """ Get: Type(self: EstimatedDVH) -> DVHEstimateType """ - - - -class EvaluationDose(Dose, IXmlSerializable): - # no doc - def DoseValueToVoxel(self, doseValue): - # type: (self: EvaluationDose, doseValue: DoseValue) -> int - """ DoseValueToVoxel(self: EvaluationDose, doseValue: DoseValue) -> int """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def SetVoxels(self, planeIndex, values): - # type: (self: EvaluationDose, planeIndex: int, values: Array[int]) - """ SetVoxels(self: EvaluationDose, planeIndex: int, values: Array[int]) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: EvaluationDose, writer: XmlWriter) - """ WriteXml(self: EvaluationDose, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class ExternalBeamTreatmentUnit(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: ExternalBeamTreatmentUnit, writer: XmlWriter) - """ WriteXml(self: ExternalBeamTreatmentUnit, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - MachineModel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalBeamTreatmentUnit) -> str - """ Get: MachineModel(self: ExternalBeamTreatmentUnit) -> str """ - - MachineModelName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalBeamTreatmentUnit) -> str - """ Get: MachineModelName(self: ExternalBeamTreatmentUnit) -> str """ - - MachineScaleDisplayName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalBeamTreatmentUnit) -> str - """ Get: MachineScaleDisplayName(self: ExternalBeamTreatmentUnit) -> str """ - - OperatingLimits = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalBeamTreatmentUnit) -> TreatmentUnitOperatingLimits - """ Get: OperatingLimits(self: ExternalBeamTreatmentUnit) -> TreatmentUnitOperatingLimits """ - - SourceAxisDistance = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalBeamTreatmentUnit) -> float - """ Get: SourceAxisDistance(self: ExternalBeamTreatmentUnit) -> float """ - - - -class ExternalPlanSetup(PlanSetup, IXmlSerializable): - # no doc - def AddArcBeam(self, machineParameters, jawPositions, collimatorAngle, gantryAngle, gantryStop, gantryDirection, patientSupportAngle, isocenter): - # type: (self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam - """ AddArcBeam(self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam """ - pass - - def AddConformalArcBeam(self, machineParameters, collimatorAngle, controlPointCount, gantryAngle, gantryStop, gantryDirection, patientSupportAngle, isocenter): - # type: (self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, controlPointCount: int, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam - """ AddConformalArcBeam(self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, controlPointCount: int, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam """ - pass - - def AddMLCArcBeam(self, machineParameters, leafPositions, jawPositions, collimatorAngle, gantryAngle, gantryStop, gantryDirection, patientSupportAngle, isocenter): - # type: (self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[Single], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam - """ AddMLCArcBeam(self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[Single], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam """ - pass - - def AddMLCBeam(self, machineParameters, leafPositions, jawPositions, collimatorAngle, gantryAngle, patientSupportAngle, isocenter): - # type: (self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[Single], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam - """ AddMLCBeam(self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[Single], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam """ - pass - - def AddMultipleStaticSegmentBeam(self, machineParameters, metersetWeights, collimatorAngle, gantryAngle, patientSupportAngle, isocenter): - # type: (self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, metersetWeights: IEnumerable[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam - """ AddMultipleStaticSegmentBeam(self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, metersetWeights: IEnumerable[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam """ - pass - - def AddSlidingWindowBeam(self, machineParameters, metersetWeights, collimatorAngle, gantryAngle, patientSupportAngle, isocenter): - # type: (self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, metersetWeights: IEnumerable[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam - """ AddSlidingWindowBeam(self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, metersetWeights: IEnumerable[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam """ - pass - - def AddStaticBeam(self, machineParameters, jawPositions, collimatorAngle, gantryAngle, patientSupportAngle, isocenter): - # type: (self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam - """ AddStaticBeam(self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam """ - pass - - def AddVMATBeam(self, machineParameters, metersetWeights, collimatorAngle, gantryAngle, gantryStop, gantryDirection, patientSupportAngle, isocenter): - # type: (self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, metersetWeights: IEnumerable[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam - """ AddVMATBeam(self: ExternalPlanSetup, machineParameters: ExternalBeamMachineParameters, metersetWeights: IEnumerable[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam """ - pass - - def AttachToCalcClient(self, *args): #cannot find CLR method - # type: (self: PlanSetup, doseCalcClient: ICalculationClient) - """ AttachToCalcClient(self: PlanSetup, doseCalcClient: ICalculationClient) """ - pass - - def CalculateDose(self): - # type: (self: ExternalPlanSetup) -> CalculationResult - """ CalculateDose(self: ExternalPlanSetup) -> CalculationResult """ - pass - - def CalculateDoseWithPresetValues(self, presetValues): - # type: (self: ExternalPlanSetup, presetValues: List[KeyValuePair[str, MetersetValue]]) -> CalculationResult - """ CalculateDoseWithPresetValues(self: ExternalPlanSetup, presetValues: List[KeyValuePair[str, MetersetValue]]) -> CalculationResult """ - pass - - def CalculateDVHEstimates(self, modelId, targetDoseLevels, structureMatches): - # type: (self: ExternalPlanSetup, modelId: str, targetDoseLevels: Dictionary[str, DoseValue], structureMatches: Dictionary[str, str]) -> CalculationResult - """ CalculateDVHEstimates(self: ExternalPlanSetup, modelId: str, targetDoseLevels: Dictionary[str, DoseValue], structureMatches: Dictionary[str, str]) -> CalculationResult """ - pass - - def CalculateLeafMotions(self, options=None): - # type: (self: ExternalPlanSetup) -> CalculationResult - """ - CalculateLeafMotions(self: ExternalPlanSetup) -> CalculationResult - CalculateLeafMotions(self: ExternalPlanSetup, options: LMCVOptions) -> CalculationResult - CalculateLeafMotions(self: ExternalPlanSetup, options: SmartLMCOptions) -> CalculationResult - CalculateLeafMotions(self: ExternalPlanSetup, options: LMCMSSOptions) -> CalculationResult - """ - pass - - def CalculateLeafMotionsAndDose(self): - # type: (self: ExternalPlanSetup) -> CalculationResult - """ CalculateLeafMotionsAndDose(self: ExternalPlanSetup) -> CalculationResult """ - pass - - def CopyEvaluationDose(self, existing): - # type: (self: ExternalPlanSetup, existing: Dose) -> EvaluationDose - """ CopyEvaluationDose(self: ExternalPlanSetup, existing: Dose) -> EvaluationDose """ - pass - - def CreateEvaluationDose(self): - # type: (self: ExternalPlanSetup) -> EvaluationDose - """ CreateEvaluationDose(self: ExternalPlanSetup) -> EvaluationDose """ - pass - - def DetachFromCalcClient(self, *args): #cannot find CLR method - # type: (self: PlanSetup, doseCalcClient: ICalculationClient) - """ DetachFromCalcClient(self: PlanSetup, doseCalcClient: ICalculationClient) """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetModelsForCalculationType(self, calculationType): - # type: (self: ExternalPlanSetup, calculationType: CalculationType) -> IEnumerable[str] - """ GetModelsForCalculationType(self: ExternalPlanSetup, calculationType: CalculationType) -> IEnumerable[str] """ - pass - - def Optimize(self, *__args): - # type: (self: ExternalPlanSetup, maxIterations: int) -> OptimizerResult - """ - Optimize(self: ExternalPlanSetup, maxIterations: int) -> OptimizerResult - Optimize(self: ExternalPlanSetup, maxIterations: int, optimizationOption: OptimizationOption) -> OptimizerResult - Optimize(self: ExternalPlanSetup, maxIterations: int, optimizationOption: OptimizationOption, mlcId: str) -> OptimizerResult - Optimize(self: ExternalPlanSetup) -> OptimizerResult - Optimize(self: ExternalPlanSetup, options: OptimizationOptionsIMRT) -> OptimizerResult - """ - pass - - def OptimizeVMAT(self, *__args): - # type: (self: ExternalPlanSetup, mlcId: str) -> OptimizerResult - """ - OptimizeVMAT(self: ExternalPlanSetup, mlcId: str) -> OptimizerResult - OptimizeVMAT(self: ExternalPlanSetup) -> OptimizerResult - OptimizeVMAT(self: ExternalPlanSetup, options: OptimizationOptionsVMAT) -> OptimizerResult - """ - pass - - def RemoveBeam(self, beam): - # type: (self: ExternalPlanSetup, beam: Beam) - """ RemoveBeam(self: ExternalPlanSetup, beam: Beam) """ - pass - - def Report(self, *args): #cannot find CLR method - # type: (self: PlanSetup, str: str) - """ Report(self: PlanSetup, str: str) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: ExternalPlanSetup, writer: XmlWriter) - """ WriteXml(self: ExternalPlanSetup, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - DoseAsEvaluationDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalPlanSetup) -> EvaluationDose - """ Get: DoseAsEvaluationDose(self: ExternalPlanSetup) -> EvaluationDose """ - - TradeoffExplorationContext = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalPlanSetup) -> TradeoffExplorationContext - """ Get: TradeoffExplorationContext(self: ExternalPlanSetup) -> TradeoffExplorationContext """ - - - m_errorsOnCalculationCompleted = None - - -class FieldReferencePoint(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: FieldReferencePoint, writer: XmlWriter) - """ WriteXml(self: FieldReferencePoint, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - EffectiveDepth = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: FieldReferencePoint) -> float - """ Get: EffectiveDepth(self: FieldReferencePoint) -> float """ - - FieldDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: FieldReferencePoint) -> DoseValue - """ Get: FieldDose(self: FieldReferencePoint) -> DoseValue """ - - IsFieldDoseNominal = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: FieldReferencePoint) -> bool - """ Get: IsFieldDoseNominal(self: FieldReferencePoint) -> bool """ - - IsPrimaryReferencePoint = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: FieldReferencePoint) -> bool - """ Get: IsPrimaryReferencePoint(self: FieldReferencePoint) -> bool """ - - ReferencePoint = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: FieldReferencePoint) -> ReferencePoint - """ Get: ReferencePoint(self: FieldReferencePoint) -> ReferencePoint """ - - RefPointLocation = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: FieldReferencePoint) -> VVector - """ Get: RefPointLocation(self: FieldReferencePoint) -> VVector """ - - SSD = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: FieldReferencePoint) -> float - """ Get: SSD(self: FieldReferencePoint) -> float """ - - - -class Globals(object): - # type: () - """ Globals() """ - @staticmethod - def DisableApiAccessTrace(): - # type: () - """ DisableApiAccessTrace() """ - pass - - @staticmethod - def EnableApiAccessTrace(): - # type: () - """ EnableApiAccessTrace() """ - pass - - @staticmethod - def GetLoggedApiCalls(): - # type: () -> IEnumerable[str] - """ GetLoggedApiCalls() -> IEnumerable[str] """ - pass - - @staticmethod - def SetMaximumNumberOfLoggedApiCalls(apiLogCacheSize): - # type: (apiLogCacheSize: int) - """ SetMaximumNumberOfLoggedApiCalls(apiLogCacheSize: int) """ - pass - - AbortNow = False - DefaultMaximumNumberOfLoggedApiCalls = 200 - - -class Hospital(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Hospital, writer: XmlWriter) - """ WriteXml(self: Hospital, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CreationDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Hospital) -> Nullable[DateTime] - """ Get: CreationDateTime(self: Hospital) -> Nullable[DateTime] """ - - Location = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Hospital) -> str - """ Get: Location(self: Hospital) -> str """ - - - -class Image(ApiDataObject, IXmlSerializable): - # no doc - def CreateNewStructureSet(self): - # type: (self: Image) -> StructureSet - """ CreateNewStructureSet(self: Image) -> StructureSet """ - pass - - def DicomToUser(self, dicom, planSetup): - # type: (self: Image, dicom: VVector, planSetup: PlanSetup) -> VVector - """ DicomToUser(self: Image, dicom: VVector, planSetup: PlanSetup) -> VVector """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetImageProfile(self, start, stop, preallocatedBuffer): - # type: (self: Image, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> ImageProfile - """ GetImageProfile(self: Image, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> ImageProfile """ - pass - - def GetVoxels(self, planeIndex, preallocatedBuffer): - # type: (self: Image, planeIndex: int, preallocatedBuffer: Array[int]) - """ GetVoxels(self: Image, planeIndex: int, preallocatedBuffer: Array[int]) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def UserToDicom(self, user, planSetup): - # type: (self: Image, user: VVector, planSetup: PlanSetup) -> VVector - """ UserToDicom(self: Image, user: VVector, planSetup: PlanSetup) -> VVector """ - pass - - def VoxelToDisplayValue(self, voxelValue): - # type: (self: Image, voxelValue: int) -> float - """ VoxelToDisplayValue(self: Image, voxelValue: int) -> float """ - pass - - def WriteXml(self, writer): - # type: (self: Image, writer: XmlWriter) - """ WriteXml(self: Image, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ApprovalHistory = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> IEnumerable[ImageApprovalHistoryEntry] - """ Get: ApprovalHistory(self: Image) -> IEnumerable[ImageApprovalHistoryEntry] """ - - ContrastBolusAgentIngredientName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> str - """ Get: ContrastBolusAgentIngredientName(self: Image) -> str """ - - CreationDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> Nullable[DateTime] - """ Get: CreationDateTime(self: Image) -> Nullable[DateTime] """ - - DisplayUnit = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> str - """ Get: DisplayUnit(self: Image) -> str """ - - FOR = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> str - """ Get: FOR(self: Image) -> str """ - - HasUserOrigin = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> bool - """ Get: HasUserOrigin(self: Image) -> bool """ - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> str - """ - Get: Id(self: Image) -> str - - Set: Id(self: Image) = value - """ - - ImagingOrientation = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> PatientOrientation - """ Get: ImagingOrientation(self: Image) -> PatientOrientation """ - - IsProcessed = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> bool - """ Get: IsProcessed(self: Image) -> bool """ - - Level = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> int - """ Get: Level(self: Image) -> int """ - - Origin = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> VVector - """ Get: Origin(self: Image) -> VVector """ - - Series = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> Series - """ Get: Series(self: Image) -> Series """ - - UserOrigin = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> VVector - """ - Get: UserOrigin(self: Image) -> VVector - - Set: UserOrigin(self: Image) = value - """ - - UserOriginComments = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> str - """ Get: UserOriginComments(self: Image) -> str """ - - Window = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> int - """ Get: Window(self: Image) -> int """ - - XDirection = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> VVector - """ Get: XDirection(self: Image) -> VVector """ - - XRes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> float - """ Get: XRes(self: Image) -> float """ - - XSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> int - """ Get: XSize(self: Image) -> int """ - - YDirection = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> VVector - """ Get: YDirection(self: Image) -> VVector """ - - YRes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> float - """ Get: YRes(self: Image) -> float """ - - YSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> int - """ Get: YSize(self: Image) -> int """ - - ZDirection = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> VVector - """ Get: ZDirection(self: Image) -> VVector """ - - ZRes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> float - """ Get: ZRes(self: Image) -> float """ - - ZSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Image) -> int - """ Get: ZSize(self: Image) -> int """ - - - -class IonBeam(Beam, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetEditableParameters(self): - # type: (self: IonBeam) -> IonBeamParameters - """ GetEditableParameters(self: IonBeam) -> IonBeamParameters """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: IonBeam, writer: XmlWriter) - """ WriteXml(self: IonBeam, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - AirGap = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> float - """ Get: AirGap(self: IonBeam) -> float """ - - DistalTargetMargin = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> float - """ Get: DistalTargetMargin(self: IonBeam) -> float """ - - IonControlPoints = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> IonControlPointCollection - """ Get: IonControlPoints(self: IonBeam) -> IonControlPointCollection """ - - LateralMargins = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> VRect[float] - """ Get: LateralMargins(self: IonBeam) -> VRect[float] """ - - LateralSpreadingDevices = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> IEnumerable[LateralSpreadingDevice] - """ Get: LateralSpreadingDevices(self: IonBeam) -> IEnumerable[LateralSpreadingDevice] """ - - NominalRange = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> float - """ Get: NominalRange(self: IonBeam) -> float """ - - NominalSOBPWidth = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> float - """ Get: NominalSOBPWidth(self: IonBeam) -> float """ - - OptionId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> str - """ Get: OptionId(self: IonBeam) -> str """ - - PatientSupportId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> str - """ Get: PatientSupportId(self: IonBeam) -> str """ - - PatientSupportType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> PatientSupportType - """ Get: PatientSupportType(self: IonBeam) -> PatientSupportType """ - - ProximalTargetMargin = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> float - """ Get: ProximalTargetMargin(self: IonBeam) -> float """ - - RangeModulators = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> IEnumerable[RangeModulator] - """ Get: RangeModulators(self: IonBeam) -> IEnumerable[RangeModulator] """ - - RangeShifters = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> IEnumerable[RangeShifter] - """ Get: RangeShifters(self: IonBeam) -> IEnumerable[RangeShifter] """ - - ScanMode = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> IonBeamScanMode - """ Get: ScanMode(self: IonBeam) -> IonBeamScanMode """ - - SnoutId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> str - """ Get: SnoutId(self: IonBeam) -> str """ - - TargetStructure = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> Structure - """ Get: TargetStructure(self: IonBeam) -> Structure """ - - VirtualSADX = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> float - """ Get: VirtualSADX(self: IonBeam) -> float """ - - VirtualSADY = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeam) -> float - """ Get: VirtualSADY(self: IonBeam) -> float """ - - - -class IonBeamParameters(BeamParameters): - # no doc - ControlPoints = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeamParameters) -> IEnumerable[IonControlPointParameters] - """ Get: ControlPoints(self: IonBeamParameters) -> IEnumerable[IonControlPointParameters] """ - - IonControlPointPairs = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonBeamParameters) -> IonControlPointPairCollection - """ Get: IonControlPointPairs(self: IonBeamParameters) -> IonControlPointPairCollection """ - - - -class IonControlPoint(ControlPoint, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: IonControlPoint, writer: XmlWriter) - """ WriteXml(self: IonControlPoint, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - FinalSpotList = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPoint) -> IonSpotCollection - """ Get: FinalSpotList(self: IonControlPoint) -> IonSpotCollection """ - - LateralSpreadingDeviceSettings = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPoint) -> IEnumerable[LateralSpreadingDeviceSettings] - """ Get: LateralSpreadingDeviceSettings(self: IonControlPoint) -> IEnumerable[LateralSpreadingDeviceSettings] """ - - NominalBeamEnergy = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPoint) -> float - """ Get: NominalBeamEnergy(self: IonControlPoint) -> float """ - - NumberOfPaintings = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPoint) -> int - """ Get: NumberOfPaintings(self: IonControlPoint) -> int """ - - RangeModulatorSettings = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPoint) -> IEnumerable[RangeModulatorSettings] - """ Get: RangeModulatorSettings(self: IonControlPoint) -> IEnumerable[RangeModulatorSettings] """ - - RangeShifterSettings = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPoint) -> IEnumerable[RangeShifterSettings] - """ Get: RangeShifterSettings(self: IonControlPoint) -> IEnumerable[RangeShifterSettings] """ - - RawSpotList = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPoint) -> IonSpotCollection - """ Get: RawSpotList(self: IonControlPoint) -> IonSpotCollection """ - - ScanningSpotSizeX = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPoint) -> float - """ Get: ScanningSpotSizeX(self: IonControlPoint) -> float """ - - ScanningSpotSizeY = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPoint) -> float - """ Get: ScanningSpotSizeY(self: IonControlPoint) -> float """ - - ScanSpotTuneId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPoint) -> str - """ Get: ScanSpotTuneId(self: IonControlPoint) -> str """ - - SnoutPosition = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPoint) -> float - """ Get: SnoutPosition(self: IonControlPoint) -> float """ - - - -class IonControlPointCollection(SerializableObject, IXmlSerializable, IEnumerable[IonControlPoint], IEnumerable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetEnumerator(self): - # type: (self: IonControlPointCollection) -> IEnumerator[IonControlPoint] - """ GetEnumerator(self: IonControlPointCollection) -> IEnumerator[IonControlPoint] """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: IonControlPointCollection, writer: XmlWriter) - """ WriteXml(self: IonControlPointCollection, writer: XmlWriter) """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[IonControlPoint](enumerable: IEnumerable[IonControlPoint], value: IonControlPoint) -> bool """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPointCollection) -> int - """ Get: Count(self: IonControlPointCollection) -> int """ - - - -class IonControlPointPair(object): - # no doc - def ResizeFinalSpotList(self, count): - # type: (self: IonControlPointPair, count: int) - """ ResizeFinalSpotList(self: IonControlPointPair, count: int) """ - pass - - def ResizeRawSpotList(self, count): - # type: (self: IonControlPointPair, count: int) - """ ResizeRawSpotList(self: IonControlPointPair, count: int) """ - pass - - EndControlPoint = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPointPair) -> IonControlPointParameters - """ Get: EndControlPoint(self: IonControlPointPair) -> IonControlPointParameters """ - - FinalSpotList = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPointPair) -> IonSpotParametersCollection - """ Get: FinalSpotList(self: IonControlPointPair) -> IonSpotParametersCollection """ - - NominalBeamEnergy = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPointPair) -> float - """ Get: NominalBeamEnergy(self: IonControlPointPair) -> float """ - - RawSpotList = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPointPair) -> IonSpotParametersCollection - """ Get: RawSpotList(self: IonControlPointPair) -> IonSpotParametersCollection """ - - StartControlPoint = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPointPair) -> IonControlPointParameters - """ Get: StartControlPoint(self: IonControlPointPair) -> IonControlPointParameters """ - - StartIndex = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPointPair) -> int - """ Get: StartIndex(self: IonControlPointPair) -> int """ - - - -class IonControlPointPairCollection(object, IEnumerable[IonControlPointPair], IEnumerable): - # no doc - def GetEnumerator(self): - # type: (self: IonControlPointPairCollection) -> IEnumerator[IonControlPointPair] - """ GetEnumerator(self: IonControlPointPairCollection) -> IEnumerator[IonControlPointPair] """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[IonControlPointPair](enumerable: IEnumerable[IonControlPointPair], value: IonControlPointPair) -> bool """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPointPairCollection) -> int - """ Get: Count(self: IonControlPointPairCollection) -> int """ - - - -class IonControlPointParameters(ControlPointParameters): - # no doc - FinalSpotList = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPointParameters) -> IonSpotParametersCollection - """ Get: FinalSpotList(self: IonControlPointParameters) -> IonSpotParametersCollection """ - - RawSpotList = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonControlPointParameters) -> IonSpotParametersCollection - """ Get: RawSpotList(self: IonControlPointParameters) -> IonSpotParametersCollection """ - - - -class IonPlanSetup(PlanSetup, IXmlSerializable): - # no doc - def AttachToCalcClient(self, *args): #cannot find CLR method - # type: (self: PlanSetup, doseCalcClient: ICalculationClient) - """ AttachToCalcClient(self: PlanSetup, doseCalcClient: ICalculationClient) """ - pass - - def CalculateDose(self): - # type: (self: IonPlanSetup) -> CalculationResult - """ CalculateDose(self: IonPlanSetup) -> CalculationResult """ - pass - - def CalculateDoseWithoutPostProcessing(self): - # type: (self: IonPlanSetup) -> CalculationResult - """ CalculateDoseWithoutPostProcessing(self: IonPlanSetup) -> CalculationResult """ - pass - - def CopyEvaluationDose(self, existing): - # type: (self: IonPlanSetup, existing: Dose) -> EvaluationDose - """ CopyEvaluationDose(self: IonPlanSetup, existing: Dose) -> EvaluationDose """ - pass - - def CreateEvaluationDose(self): - # type: (self: IonPlanSetup) -> EvaluationDose - """ CreateEvaluationDose(self: IonPlanSetup) -> EvaluationDose """ - pass - - def DetachFromCalcClient(self, *args): #cannot find CLR method - # type: (self: PlanSetup, doseCalcClient: ICalculationClient) - """ DetachFromCalcClient(self: PlanSetup, doseCalcClient: ICalculationClient) """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetModelsForCalculationType(self, calculationType): - # type: (self: IonPlanSetup, calculationType: CalculationType) -> IEnumerable[str] - """ GetModelsForCalculationType(self: IonPlanSetup, calculationType: CalculationType) -> IEnumerable[str] """ - pass - - def PostProcessAndCalculateDose(self): - # type: (self: IonPlanSetup) -> CalculationResult - """ PostProcessAndCalculateDose(self: IonPlanSetup) -> CalculationResult """ - pass - - def Report(self, *args): #cannot find CLR method - # type: (self: PlanSetup, str: str) - """ Report(self: PlanSetup, str: str) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: IonPlanSetup, writer: XmlWriter) - """ WriteXml(self: IonPlanSetup, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - DoseAsEvaluationDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonPlanSetup) -> EvaluationDose - """ Get: DoseAsEvaluationDose(self: IonPlanSetup) -> EvaluationDose """ - - IonBeams = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonPlanSetup) -> IEnumerable[IonBeam] - """ Get: IonBeams(self: IonPlanSetup) -> IEnumerable[IonBeam] """ - - IsPostProcessingNeeded = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonPlanSetup) -> bool - """ - Get: IsPostProcessingNeeded(self: IonPlanSetup) -> bool - - Set: IsPostProcessingNeeded(self: IonPlanSetup) = value - """ - - - m_errorsOnCalculationCompleted = None - - -class IonSpot(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: IonSpot, writer: XmlWriter) - """ WriteXml(self: IonSpot, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Position = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonSpot) -> VVector - """ Get: Position(self: IonSpot) -> VVector """ - - Weight = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonSpot) -> Single - """ Get: Weight(self: IonSpot) -> Single """ - - - -class IonSpotCollection(SerializableObject, IXmlSerializable, IEnumerable[IonSpot], IEnumerable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetEnumerator(self): - # type: (self: IonSpotCollection) -> IEnumerator[IonSpot] - """ GetEnumerator(self: IonSpotCollection) -> IEnumerator[IonSpot] """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: IonSpotCollection, writer: XmlWriter) - """ WriteXml(self: IonSpotCollection, writer: XmlWriter) """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[IonSpot](enumerable: IEnumerable[IonSpot], value: IonSpot) -> bool """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonSpotCollection) -> int - """ Get: Count(self: IonSpotCollection) -> int """ - - - -class IonSpotParameters(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: IonSpotParameters, writer: XmlWriter) - """ WriteXml(self: IonSpotParameters, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Weight = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonSpotParameters) -> Single - """ - Get: Weight(self: IonSpotParameters) -> Single - - Set: Weight(self: IonSpotParameters) = value - """ - - X = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonSpotParameters) -> Single - """ - Get: X(self: IonSpotParameters) -> Single - - Set: X(self: IonSpotParameters) = value - """ - - Y = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonSpotParameters) -> Single - """ - Get: Y(self: IonSpotParameters) -> Single - - Set: Y(self: IonSpotParameters) = value - """ - - - -class IonSpotParametersCollection(SerializableObject, IXmlSerializable, IEnumerable[IonSpotParameters], IEnumerable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetEnumerator(self): - # type: (self: IonSpotParametersCollection) -> IEnumerator[IonSpotParameters] - """ GetEnumerator(self: IonSpotParametersCollection) -> IEnumerator[IonSpotParameters] """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: IonSpotParametersCollection, writer: XmlWriter) - """ WriteXml(self: IonSpotParametersCollection, writer: XmlWriter) """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[IonSpotParameters](enumerable: IEnumerable[IonSpotParameters], value: IonSpotParameters) -> bool """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: IonSpotParametersCollection) -> int - """ Get: Count(self: IonSpotParametersCollection) -> int """ - - - -class Isodose(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Isodose, writer: XmlWriter) - """ WriteXml(self: Isodose, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Color = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Isodose) -> Color - """ Get: Color(self: Isodose) -> Color """ - - Level = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Isodose) -> DoseValue - """ Get: Level(self: Isodose) -> DoseValue """ - - MeshGeometry = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Isodose) -> MeshGeometry3D - """ Get: MeshGeometry(self: Isodose) -> MeshGeometry3D """ - - - -class LateralSpreadingDevice(AddOn, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: LateralSpreadingDevice, writer: XmlWriter) - """ WriteXml(self: LateralSpreadingDevice, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Type = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: LateralSpreadingDevice) -> LateralSpreadingDeviceType - """ Get: Type(self: LateralSpreadingDevice) -> LateralSpreadingDeviceType """ - - - -class LateralSpreadingDeviceSettings(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: LateralSpreadingDeviceSettings, writer: XmlWriter) - """ WriteXml(self: LateralSpreadingDeviceSettings, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - IsocenterToLateralSpreadingDeviceDistance = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: LateralSpreadingDeviceSettings) -> float - """ Get: IsocenterToLateralSpreadingDeviceDistance(self: LateralSpreadingDeviceSettings) -> float """ - - LateralSpreadingDeviceSetting = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: LateralSpreadingDeviceSettings) -> str - """ Get: LateralSpreadingDeviceSetting(self: LateralSpreadingDeviceSettings) -> str """ - - LateralSpreadingDeviceWaterEquivalentThickness = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: LateralSpreadingDeviceSettings) -> float - """ Get: LateralSpreadingDeviceWaterEquivalentThickness(self: LateralSpreadingDeviceSettings) -> float """ - - ReferencedLateralSpreadingDevice = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: LateralSpreadingDeviceSettings) -> LateralSpreadingDevice - """ Get: ReferencedLateralSpreadingDevice(self: LateralSpreadingDeviceSettings) -> LateralSpreadingDevice """ - - - -class MLC(AddOn, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: MLC, writer: XmlWriter) - """ WriteXml(self: MLC, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ManufacturerName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: MLC) -> str - """ Get: ManufacturerName(self: MLC) -> str """ - - MinDoseDynamicLeafGap = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: MLC) -> float - """ Get: MinDoseDynamicLeafGap(self: MLC) -> float """ - - Model = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: MLC) -> str - """ Get: Model(self: MLC) -> str """ - - SerialNumber = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: MLC) -> str - """ Get: SerialNumber(self: MLC) -> str """ - - - -class MotorizedWedge(Wedge, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: MotorizedWedge, writer: XmlWriter) - """ WriteXml(self: MotorizedWedge, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class OmniWedge(Wedge, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OmniWedge, writer: XmlWriter) - """ WriteXml(self: OmniWedge, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class OptimizationObjective(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def Equals(self, obj): - # type: (self: OptimizationObjective, obj: object) -> bool - """ Equals(self: OptimizationObjective, obj: object) -> bool """ - pass - - def GetHashCode(self): - # type: (self: OptimizationObjective) -> int - """ GetHashCode(self: OptimizationObjective) -> int """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationObjective, writer: XmlWriter) - """ WriteXml(self: OptimizationObjective, writer: XmlWriter) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - Operator = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationObjective) -> OptimizationObjectiveOperator - """ Get: Operator(self: OptimizationObjective) -> OptimizationObjectiveOperator """ - - Priority = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationObjective) -> float - """ Get: Priority(self: OptimizationObjective) -> float """ - - Structure = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationObjective) -> Structure - """ Get: Structure(self: OptimizationObjective) -> Structure """ - - StructureId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationObjective) -> str - """ Get: StructureId(self: OptimizationObjective) -> str """ - - - -class OptimizationEUDObjective(OptimizationObjective, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationEUDObjective, writer: XmlWriter) - """ WriteXml(self: OptimizationEUDObjective, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Dose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationEUDObjective) -> DoseValue - """ Get: Dose(self: OptimizationEUDObjective) -> DoseValue """ - - ParameterA = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationEUDObjective) -> float - """ Get: ParameterA(self: OptimizationEUDObjective) -> float """ - - - -class OptimizationParameter(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def Equals(self, obj): - # type: (self: OptimizationParameter, obj: object) -> bool - """ Equals(self: OptimizationParameter, obj: object) -> bool """ - pass - - def GetHashCode(self): - # type: (self: OptimizationParameter) -> int - """ GetHashCode(self: OptimizationParameter) -> int """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationParameter, writer: XmlWriter) - """ WriteXml(self: OptimizationParameter, writer: XmlWriter) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - -class OptimizationExcludeStructureParameter(OptimizationParameter, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationExcludeStructureParameter, writer: XmlWriter) - """ WriteXml(self: OptimizationExcludeStructureParameter, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Structure = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationExcludeStructureParameter) -> Structure - """ Get: Structure(self: OptimizationExcludeStructureParameter) -> Structure """ - - - -class OptimizationIMRTBeamParameter(OptimizationParameter, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationIMRTBeamParameter, writer: XmlWriter) - """ WriteXml(self: OptimizationIMRTBeamParameter, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Beam = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationIMRTBeamParameter) -> Beam - """ Get: Beam(self: OptimizationIMRTBeamParameter) -> Beam """ - - BeamId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationIMRTBeamParameter) -> str - """ Get: BeamId(self: OptimizationIMRTBeamParameter) -> str """ - - Excluded = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationIMRTBeamParameter) -> bool - """ Get: Excluded(self: OptimizationIMRTBeamParameter) -> bool """ - - FixedJaws = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationIMRTBeamParameter) -> bool - """ Get: FixedJaws(self: OptimizationIMRTBeamParameter) -> bool """ - - SmoothX = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationIMRTBeamParameter) -> float - """ Get: SmoothX(self: OptimizationIMRTBeamParameter) -> float """ - - SmoothY = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationIMRTBeamParameter) -> float - """ Get: SmoothY(self: OptimizationIMRTBeamParameter) -> float """ - - - -class OptimizationJawTrackingUsedParameter(OptimizationParameter, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationJawTrackingUsedParameter, writer: XmlWriter) - """ WriteXml(self: OptimizationJawTrackingUsedParameter, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class OptimizationLineObjective(OptimizationObjective, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationLineObjective, writer: XmlWriter) - """ WriteXml(self: OptimizationLineObjective, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - CurveData = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationLineObjective) -> Array[DVHPoint] - """ Get: CurveData(self: OptimizationLineObjective) -> Array[DVHPoint] """ - - - -class OptimizationMeanDoseObjective(OptimizationObjective, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationMeanDoseObjective, writer: XmlWriter) - """ WriteXml(self: OptimizationMeanDoseObjective, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Dose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationMeanDoseObjective) -> DoseValue - """ Get: Dose(self: OptimizationMeanDoseObjective) -> DoseValue """ - - - -class OptimizationNormalTissueParameter(OptimizationParameter, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationNormalTissueParameter, writer: XmlWriter) - """ WriteXml(self: OptimizationNormalTissueParameter, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - DistanceFromTargetBorderInMM = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationNormalTissueParameter) -> float - """ Get: DistanceFromTargetBorderInMM(self: OptimizationNormalTissueParameter) -> float """ - - EndDosePercentage = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationNormalTissueParameter) -> float - """ Get: EndDosePercentage(self: OptimizationNormalTissueParameter) -> float """ - - FallOff = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationNormalTissueParameter) -> float - """ Get: FallOff(self: OptimizationNormalTissueParameter) -> float """ - - IsAutomatic = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationNormalTissueParameter) -> bool - """ Get: IsAutomatic(self: OptimizationNormalTissueParameter) -> bool """ - - Priority = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationNormalTissueParameter) -> float - """ Get: Priority(self: OptimizationNormalTissueParameter) -> float """ - - StartDosePercentage = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationNormalTissueParameter) -> float - """ Get: StartDosePercentage(self: OptimizationNormalTissueParameter) -> float """ - - - -class OptimizationPointCloudParameter(OptimizationParameter, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationPointCloudParameter, writer: XmlWriter) - """ WriteXml(self: OptimizationPointCloudParameter, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - PointResolutionInMM = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationPointCloudParameter) -> float - """ Get: PointResolutionInMM(self: OptimizationPointCloudParameter) -> float """ - - Structure = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationPointCloudParameter) -> Structure - """ Get: Structure(self: OptimizationPointCloudParameter) -> Structure """ - - - -class OptimizationPointObjective(OptimizationObjective, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationPointObjective, writer: XmlWriter) - """ WriteXml(self: OptimizationPointObjective, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Dose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationPointObjective) -> DoseValue - """ Get: Dose(self: OptimizationPointObjective) -> DoseValue """ - - Volume = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationPointObjective) -> float - """ Get: Volume(self: OptimizationPointObjective) -> float """ - - - -class OptimizationSetup(SerializableObject, IXmlSerializable): - # no doc - def AddAutomaticNormalTissueObjective(self, priority): - # type: (self: OptimizationSetup, priority: float) -> OptimizationNormalTissueParameter - """ AddAutomaticNormalTissueObjective(self: OptimizationSetup, priority: float) -> OptimizationNormalTissueParameter """ - pass - - def AddBeamSpecificParameter(self, beam, smoothX, smoothY, fixedJaws): - # type: (self: OptimizationSetup, beam: Beam, smoothX: float, smoothY: float, fixedJaws: bool) -> OptimizationIMRTBeamParameter - """ AddBeamSpecificParameter(self: OptimizationSetup, beam: Beam, smoothX: float, smoothY: float, fixedJaws: bool) -> OptimizationIMRTBeamParameter """ - pass - - def AddEUDObjective(self, structure, objectiveOperator, dose, parameterA, priority): - # type: (self: OptimizationSetup, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, parameterA: float, priority: float) -> OptimizationEUDObjective - """ AddEUDObjective(self: OptimizationSetup, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, parameterA: float, priority: float) -> OptimizationEUDObjective """ - pass - - def AddMeanDoseObjective(self, structure, dose, priority): - # type: (self: OptimizationSetup, structure: Structure, dose: DoseValue, priority: float) -> OptimizationMeanDoseObjective - """ AddMeanDoseObjective(self: OptimizationSetup, structure: Structure, dose: DoseValue, priority: float) -> OptimizationMeanDoseObjective """ - pass - - def AddNormalTissueObjective(self, priority, distanceFromTargetBorderInMM, startDosePercentage, endDosePercentage, fallOff): - # type: (self: OptimizationSetup, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float, fallOff: float) -> OptimizationNormalTissueParameter - """ AddNormalTissueObjective(self: OptimizationSetup, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float, fallOff: float) -> OptimizationNormalTissueParameter """ - pass - - def AddPointObjective(self, structure, objectiveOperator, dose, volume, priority): - # type: (self: OptimizationSetup, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, volume: float, priority: float) -> OptimizationPointObjective - """ AddPointObjective(self: OptimizationSetup, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, volume: float, priority: float) -> OptimizationPointObjective """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def RemoveObjective(self, objective): - # type: (self: OptimizationSetup, objective: OptimizationObjective) - """ RemoveObjective(self: OptimizationSetup, objective: OptimizationObjective) """ - pass - - def RemoveParameter(self, parameter): - # type: (self: OptimizationSetup, parameter: OptimizationParameter) - """ RemoveParameter(self: OptimizationSetup, parameter: OptimizationParameter) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: OptimizationSetup, writer: XmlWriter) - """ WriteXml(self: OptimizationSetup, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Objectives = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationSetup) -> IEnumerable[OptimizationObjective] - """ Get: Objectives(self: OptimizationSetup) -> IEnumerable[OptimizationObjective] """ - - Parameters = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationSetup) -> IEnumerable[OptimizationParameter] - """ Get: Parameters(self: OptimizationSetup) -> IEnumerable[OptimizationParameter] """ - - UseJawTracking = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationSetup) -> bool - """ - Get: UseJawTracking(self: OptimizationSetup) -> bool - - Set: UseJawTracking(self: OptimizationSetup) = value - """ - - - -class OptimizerDVH(object): - # no doc - CurveData = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizerDVH) -> Array[DVHPoint] - """ Get: CurveData(self: OptimizerDVH) -> Array[DVHPoint] """ - - Structure = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizerDVH) -> Structure - """ Get: Structure(self: OptimizerDVH) -> Structure """ - - - -class OptimizerObjectiveValue(object): - # no doc - Structure = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizerObjectiveValue) -> Structure - """ Get: Structure(self: OptimizerObjectiveValue) -> Structure """ - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizerObjectiveValue) -> float - """ Get: Value(self: OptimizerObjectiveValue) -> float """ - - - -class OptimizerResult(CalculationResult): - # no doc - NumberOfIMRTOptimizerIterations = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizerResult) -> int - """ Get: NumberOfIMRTOptimizerIterations(self: OptimizerResult) -> int """ - - StructureDVHs = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizerResult) -> IEnumerable[OptimizerDVH] - """ Get: StructureDVHs(self: OptimizerResult) -> IEnumerable[OptimizerDVH] """ - - StructureObjectiveValues = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizerResult) -> IEnumerable[OptimizerObjectiveValue] - """ Get: StructureObjectiveValues(self: OptimizerResult) -> IEnumerable[OptimizerObjectiveValue] """ - - TotalObjectiveFunctionValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizerResult) -> float - """ Get: TotalObjectiveFunctionValue(self: OptimizerResult) -> float """ - - - -class Patient(ApiDataObject, IXmlSerializable): - # no doc - def AddCourse(self): - # type: (self: Patient) -> Course - """ AddCourse(self: Patient) -> Course """ - pass - - def AddEmptyPhantom(self, imageId, orientation, xSizePixel, ySizePixel, widthMM, heightMM, nrOfPlanes, planeSepMM): - # type: (self: Patient, imageId: str, orientation: PatientOrientation, xSizePixel: int, ySizePixel: int, widthMM: float, heightMM: float, nrOfPlanes: int, planeSepMM: float) -> StructureSet - """ AddEmptyPhantom(self: Patient, imageId: str, orientation: PatientOrientation, xSizePixel: int, ySizePixel: int, widthMM: float, heightMM: float, nrOfPlanes: int, planeSepMM: float) -> StructureSet """ - pass - - def BeginModifications(self): - # type: (self: Patient) - """ BeginModifications(self: Patient) """ - pass - - def CanAddCourse(self): - # type: (self: Patient) -> bool - """ CanAddCourse(self: Patient) -> bool """ - pass - - def CanAddEmptyPhantom(self, errorMessage): - # type: (self: Patient) -> (bool, str) - """ CanAddEmptyPhantom(self: Patient) -> (bool, str) """ - pass - - def CanCopyImageFromOtherPatient(self, targetStudy, otherPatientId, otherPatientStudyId, otherPatient3DImageId, errorMessage): - # type: (self: Patient, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> (bool, str) - """ CanCopyImageFromOtherPatient(self: Patient, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> (bool, str) """ - pass - - def CanModifyData(self): - # type: (self: Patient) -> bool - """ CanModifyData(self: Patient) -> bool """ - pass - - def CanRemoveCourse(self, course): - # type: (self: Patient, course: Course) -> bool - """ CanRemoveCourse(self: Patient, course: Course) -> bool """ - pass - - def CanRemoveEmptyPhantom(self, structureset, errorMessage): - # type: (self: Patient, structureset: StructureSet) -> (bool, str) - """ CanRemoveEmptyPhantom(self: Patient, structureset: StructureSet) -> (bool, str) """ - pass - - def CopyImageFromOtherPatient(self, *__args): - # type: (self: Patient, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet - """ - CopyImageFromOtherPatient(self: Patient, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet - CopyImageFromOtherPatient(self: Patient, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet - """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def RemoveCourse(self, course): - # type: (self: Patient, course: Course) - """ RemoveCourse(self: Patient, course: Course) """ - pass - - def RemoveEmptyPhantom(self, structureset): - # type: (self: Patient, structureset: StructureSet) - """ RemoveEmptyPhantom(self: Patient, structureset: StructureSet) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Patient, writer: XmlWriter) - """ WriteXml(self: Patient, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Courses = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> IEnumerable[Course] - """ Get: Courses(self: Patient) -> IEnumerable[Course] """ - - CreationDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> Nullable[DateTime] - """ Get: CreationDateTime(self: Patient) -> Nullable[DateTime] """ - - DateOfBirth = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> Nullable[DateTime] - """ Get: DateOfBirth(self: Patient) -> Nullable[DateTime] """ - - FirstName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> str - """ Get: FirstName(self: Patient) -> str """ - - HasModifiedData = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> bool - """ Get: HasModifiedData(self: Patient) -> bool """ - - Hospital = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> Hospital - """ Get: Hospital(self: Patient) -> Hospital """ - - Id2 = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> str - """ Get: Id2(self: Patient) -> str """ - - LastName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> str - """ Get: LastName(self: Patient) -> str """ - - MiddleName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> str - """ Get: MiddleName(self: Patient) -> str """ - - PrimaryOncologistId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> str - """ Get: PrimaryOncologistId(self: Patient) -> str """ - - Registrations = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> IEnumerable[Registration] - """ Get: Registrations(self: Patient) -> IEnumerable[Registration] """ - - Sex = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> str - """ Get: Sex(self: Patient) -> str """ - - SSN = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> str - """ Get: SSN(self: Patient) -> str """ - - StructureSets = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> IEnumerable[StructureSet] - """ Get: StructureSets(self: Patient) -> IEnumerable[StructureSet] """ - - Studies = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Patient) -> IEnumerable[Study] - """ Get: Studies(self: Patient) -> IEnumerable[Study] """ - - - -class PatientSummary(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: PatientSummary, writer: XmlWriter) - """ WriteXml(self: PatientSummary, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - CreationDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PatientSummary) -> Nullable[DateTime] - """ Get: CreationDateTime(self: PatientSummary) -> Nullable[DateTime] """ - - DateOfBirth = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PatientSummary) -> Nullable[DateTime] - """ Get: DateOfBirth(self: PatientSummary) -> Nullable[DateTime] """ - - FirstName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PatientSummary) -> str - """ Get: FirstName(self: PatientSummary) -> str """ - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PatientSummary) -> str - """ Get: Id(self: PatientSummary) -> str """ - - Id2 = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PatientSummary) -> str - """ Get: Id2(self: PatientSummary) -> str """ - - LastName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PatientSummary) -> str - """ Get: LastName(self: PatientSummary) -> str """ - - MiddleName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PatientSummary) -> str - """ Get: MiddleName(self: PatientSummary) -> str """ - - Sex = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PatientSummary) -> str - """ Get: Sex(self: PatientSummary) -> str """ - - SSN = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PatientSummary) -> str - """ Get: SSN(self: PatientSummary) -> str """ - - - -class PlanningItemDose(Dose, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: PlanningItemDose, writer: XmlWriter) - """ WriteXml(self: PlanningItemDose, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class PlanSum(PlanningItem, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetPlanSumOperation(self, planSetupInPlanSum): - # type: (self: PlanSum, planSetupInPlanSum: PlanSetup) -> PlanSumOperation - """ GetPlanSumOperation(self: PlanSum, planSetupInPlanSum: PlanSetup) -> PlanSumOperation """ - pass - - def GetPlanWeight(self, planSetupInPlanSum): - # type: (self: PlanSum, planSetupInPlanSum: PlanSetup) -> float - """ GetPlanWeight(self: PlanSum, planSetupInPlanSum: PlanSetup) -> float """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: PlanSum, writer: XmlWriter) - """ WriteXml(self: PlanSum, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Course = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSum) -> Course - """ Get: Course(self: PlanSum) -> Course """ - - PlanSetups = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSum) -> IEnumerable[PlanSetup] - """ Get: PlanSetups(self: PlanSum) -> IEnumerable[PlanSetup] """ - - PlanSumComponents = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSum) -> IEnumerable[PlanSumComponent] - """ Get: PlanSumComponents(self: PlanSum) -> IEnumerable[PlanSumComponent] """ - - - -class PlanSumComponent(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: PlanSumComponent, writer: XmlWriter) - """ WriteXml(self: PlanSumComponent, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - PlanSetupId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSumComponent) -> str - """ Get: PlanSetupId(self: PlanSumComponent) -> str """ - - PlanSumOperation = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSumComponent) -> PlanSumOperation - """ Get: PlanSumOperation(self: PlanSumComponent) -> PlanSumOperation """ - - PlanWeight = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanSumComponent) -> float - """ Get: PlanWeight(self: PlanSumComponent) -> float """ - - - -class PlanTreatmentSession(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: PlanTreatmentSession, writer: XmlWriter) - """ WriteXml(self: PlanTreatmentSession, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - PlanSetup = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanTreatmentSession) -> PlanSetup - """ Get: PlanSetup(self: PlanTreatmentSession) -> PlanSetup """ - - Status = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanTreatmentSession) -> TreatmentSessionStatus - """ Get: Status(self: PlanTreatmentSession) -> TreatmentSessionStatus """ - - TreatmentSession = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanTreatmentSession) -> TreatmentSession - """ Get: TreatmentSession(self: PlanTreatmentSession) -> TreatmentSession """ - - - -class PlanUncertainty(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetDVHCumulativeData(self, structure, dosePresentation, volumePresentation, binWidth): - # type: (self: PlanUncertainty, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData - """ GetDVHCumulativeData(self: PlanUncertainty, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: PlanUncertainty, writer: XmlWriter) - """ WriteXml(self: PlanUncertainty, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - BeamUncertainties = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanUncertainty) -> IEnumerable[BeamUncertainty] - """ Get: BeamUncertainties(self: PlanUncertainty) -> IEnumerable[BeamUncertainty] """ - - CalibrationCurveError = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanUncertainty) -> float - """ Get: CalibrationCurveError(self: PlanUncertainty) -> float """ - - DisplayName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanUncertainty) -> str - """ Get: DisplayName(self: PlanUncertainty) -> str """ - - Dose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanUncertainty) -> Dose - """ Get: Dose(self: PlanUncertainty) -> Dose """ - - IsocenterShift = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanUncertainty) -> VVector - """ Get: IsocenterShift(self: PlanUncertainty) -> VVector """ - - UncertaintyType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: PlanUncertainty) -> PlanUncertaintyType - """ Get: UncertaintyType(self: PlanUncertainty) -> PlanUncertaintyType """ - - - -class ProtocolPhaseMeasure(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: ProtocolPhaseMeasure, writer: XmlWriter) - """ WriteXml(self: ProtocolPhaseMeasure, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - ActualValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhaseMeasure) -> float - """ Get: ActualValue(self: ProtocolPhaseMeasure) -> float """ - - Modifier = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhaseMeasure) -> MeasureModifier - """ Get: Modifier(self: ProtocolPhaseMeasure) -> MeasureModifier """ - - StructureId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhaseMeasure) -> str - """ Get: StructureId(self: ProtocolPhaseMeasure) -> str """ - - TargetIsMet = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhaseMeasure) -> Nullable[bool] - """ Get: TargetIsMet(self: ProtocolPhaseMeasure) -> Nullable[bool] """ - - TargetValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhaseMeasure) -> float - """ Get: TargetValue(self: ProtocolPhaseMeasure) -> float """ - - Type = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhaseMeasure) -> MeasureType - """ Get: Type(self: ProtocolPhaseMeasure) -> MeasureType """ - - TypeText = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhaseMeasure) -> str - """ Get: TypeText(self: ProtocolPhaseMeasure) -> str """ - - - -class ProtocolPhasePrescription(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: ProtocolPhasePrescription, writer: XmlWriter) - """ WriteXml(self: ProtocolPhasePrescription, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - ActualTotalDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhasePrescription) -> DoseValue - """ Get: ActualTotalDose(self: ProtocolPhasePrescription) -> DoseValue """ - - PrescModifier = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhasePrescription) -> PrescriptionModifier - """ Get: PrescModifier(self: ProtocolPhasePrescription) -> PrescriptionModifier """ - - PrescParameter = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhasePrescription) -> float - """ Get: PrescParameter(self: ProtocolPhasePrescription) -> float """ - - PrescType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhasePrescription) -> PrescriptionType - """ Get: PrescType(self: ProtocolPhasePrescription) -> PrescriptionType """ - - StructureId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhasePrescription) -> str - """ Get: StructureId(self: ProtocolPhasePrescription) -> str """ - - TargetFractionDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhasePrescription) -> DoseValue - """ Get: TargetFractionDose(self: ProtocolPhasePrescription) -> DoseValue """ - - TargetIsMet = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhasePrescription) -> Nullable[bool] - """ Get: TargetIsMet(self: ProtocolPhasePrescription) -> Nullable[bool] """ - - TargetTotalDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProtocolPhasePrescription) -> DoseValue - """ Get: TargetTotalDose(self: ProtocolPhasePrescription) -> DoseValue """ - - - -class RadioactiveSource(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: RadioactiveSource, writer: XmlWriter) - """ WriteXml(self: RadioactiveSource, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CalibrationDate = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSource) -> Nullable[DateTime] - """ Get: CalibrationDate(self: RadioactiveSource) -> Nullable[DateTime] """ - - NominalActivity = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSource) -> bool - """ Get: NominalActivity(self: RadioactiveSource) -> bool """ - - RadioactiveSourceModel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSource) -> RadioactiveSourceModel - """ Get: RadioactiveSourceModel(self: RadioactiveSource) -> RadioactiveSourceModel """ - - SerialNumber = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSource) -> str - """ Get: SerialNumber(self: RadioactiveSource) -> str """ - - Strength = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSource) -> float - """ Get: Strength(self: RadioactiveSource) -> float """ - - - -class RadioactiveSourceModel(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: RadioactiveSourceModel, writer: XmlWriter) - """ WriteXml(self: RadioactiveSourceModel, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ActiveSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSourceModel) -> VVector - """ Get: ActiveSize(self: RadioactiveSourceModel) -> VVector """ - - ActivityConversionFactor = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSourceModel) -> float - """ Get: ActivityConversionFactor(self: RadioactiveSourceModel) -> float """ - - CalculationModel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSourceModel) -> str - """ Get: CalculationModel(self: RadioactiveSourceModel) -> str """ - - DoseRateConstant = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSourceModel) -> float - """ Get: DoseRateConstant(self: RadioactiveSourceModel) -> float """ - - HalfLife = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSourceModel) -> float - """ Get: HalfLife(self: RadioactiveSourceModel) -> float """ - - LiteratureReference = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSourceModel) -> str - """ Get: LiteratureReference(self: RadioactiveSourceModel) -> str """ - - Manufacturer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSourceModel) -> str - """ Get: Manufacturer(self: RadioactiveSourceModel) -> str """ - - SourceType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSourceModel) -> str - """ Get: SourceType(self: RadioactiveSourceModel) -> str """ - - Status = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSourceModel) -> str - """ Get: Status(self: RadioactiveSourceModel) -> str """ - - StatusDate = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSourceModel) -> Nullable[DateTime] - """ Get: StatusDate(self: RadioactiveSourceModel) -> Nullable[DateTime] """ - - StatusUserName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RadioactiveSourceModel) -> str - """ Get: StatusUserName(self: RadioactiveSourceModel) -> str """ - - - -class RangeModulator(AddOn, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: RangeModulator, writer: XmlWriter) - """ WriteXml(self: RangeModulator, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Type = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeModulator) -> RangeModulatorType - """ Get: Type(self: RangeModulator) -> RangeModulatorType """ - - - -class RangeModulatorSettings(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: RangeModulatorSettings, writer: XmlWriter) - """ WriteXml(self: RangeModulatorSettings, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - IsocenterToRangeModulatorDistance = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeModulatorSettings) -> float - """ Get: IsocenterToRangeModulatorDistance(self: RangeModulatorSettings) -> float """ - - RangeModulatorGatingStartValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeModulatorSettings) -> float - """ Get: RangeModulatorGatingStartValue(self: RangeModulatorSettings) -> float """ - - RangeModulatorGatingStarWaterEquivalentThickness = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeModulatorSettings) -> float - """ Get: RangeModulatorGatingStarWaterEquivalentThickness(self: RangeModulatorSettings) -> float """ - - RangeModulatorGatingStopValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeModulatorSettings) -> float - """ Get: RangeModulatorGatingStopValue(self: RangeModulatorSettings) -> float """ - - RangeModulatorGatingStopWaterEquivalentThickness = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeModulatorSettings) -> float - """ Get: RangeModulatorGatingStopWaterEquivalentThickness(self: RangeModulatorSettings) -> float """ - - ReferencedRangeModulator = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeModulatorSettings) -> RangeModulator - """ Get: ReferencedRangeModulator(self: RangeModulatorSettings) -> RangeModulator """ - - - -class RangeShifter(AddOn, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: RangeShifter, writer: XmlWriter) - """ WriteXml(self: RangeShifter, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Type = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeShifter) -> RangeShifterType - """ Get: Type(self: RangeShifter) -> RangeShifterType """ - - - -class RangeShifterSettings(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: RangeShifterSettings, writer: XmlWriter) - """ WriteXml(self: RangeShifterSettings, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - IsocenterToRangeShifterDistance = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeShifterSettings) -> float - """ Get: IsocenterToRangeShifterDistance(self: RangeShifterSettings) -> float """ - - RangeShifterSetting = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeShifterSettings) -> str - """ Get: RangeShifterSetting(self: RangeShifterSettings) -> str """ - - RangeShifterWaterEquivalentThickness = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeShifterSettings) -> float - """ Get: RangeShifterWaterEquivalentThickness(self: RangeShifterSettings) -> float """ - - ReferencedRangeShifter = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RangeShifterSettings) -> RangeShifter - """ Get: ReferencedRangeShifter(self: RangeShifterSettings) -> RangeShifter """ - - - -class ReferencePoint(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetReferencePointLocation(self, planSetup): - # type: (self: ReferencePoint, planSetup: PlanSetup) -> VVector - """ GetReferencePointLocation(self: ReferencePoint, planSetup: PlanSetup) -> VVector """ - pass - - def HasLocation(self, planSetup): - # type: (self: ReferencePoint, planSetup: PlanSetup) -> bool - """ HasLocation(self: ReferencePoint, planSetup: PlanSetup) -> bool """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: ReferencePoint, writer: XmlWriter) - """ WriteXml(self: ReferencePoint, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - DailyDoseLimit = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ReferencePoint) -> DoseValue - """ - Get: DailyDoseLimit(self: ReferencePoint) -> DoseValue - - Set: DailyDoseLimit(self: ReferencePoint) = value - """ - - PatientVolumeId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ReferencePoint) -> str - """ Get: PatientVolumeId(self: ReferencePoint) -> str """ - - SessionDoseLimit = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ReferencePoint) -> DoseValue - """ - Get: SessionDoseLimit(self: ReferencePoint) -> DoseValue - - Set: SessionDoseLimit(self: ReferencePoint) = value - """ - - TotalDoseLimit = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ReferencePoint) -> DoseValue - """ - Get: TotalDoseLimit(self: ReferencePoint) -> DoseValue - - Set: TotalDoseLimit(self: ReferencePoint) = value - """ - - - -class Registration(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def InverseTransformPoint(self, pt): - # type: (self: Registration, pt: VVector) -> VVector - """ InverseTransformPoint(self: Registration, pt: VVector) -> VVector """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def TransformPoint(self, pt): - # type: (self: Registration, pt: VVector) -> VVector - """ TransformPoint(self: Registration, pt: VVector) -> VVector """ - pass - - def WriteXml(self, writer): - # type: (self: Registration, writer: XmlWriter) - """ WriteXml(self: Registration, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CreationDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Registration) -> Nullable[DateTime] - """ Get: CreationDateTime(self: Registration) -> Nullable[DateTime] """ - - RegisteredFOR = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Registration) -> str - """ Get: RegisteredFOR(self: Registration) -> str """ - - SourceFOR = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Registration) -> str - """ Get: SourceFOR(self: Registration) -> str """ - - Status = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Registration) -> RegistrationApprovalStatus - """ Get: Status(self: Registration) -> RegistrationApprovalStatus """ - - StatusDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Registration) -> Nullable[DateTime] - """ Get: StatusDateTime(self: Registration) -> Nullable[DateTime] """ - - StatusUserDisplayName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Registration) -> str - """ Get: StatusUserDisplayName(self: Registration) -> str """ - - StatusUserName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Registration) -> str - """ Get: StatusUserName(self: Registration) -> str """ - - TransformationMatrix = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Registration) -> Array[float] - """ Get: TransformationMatrix(self: Registration) -> Array[float] """ - - UID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Registration) -> str - """ Get: UID(self: Registration) -> str """ - - - -class RTPrescription(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: RTPrescription, writer: XmlWriter) - """ WriteXml(self: RTPrescription, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - BolusFrequency = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> str - """ Get: BolusFrequency(self: RTPrescription) -> str """ - - BolusThickness = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> str - """ Get: BolusThickness(self: RTPrescription) -> str """ - - Energies = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> IEnumerable[str] - """ Get: Energies(self: RTPrescription) -> IEnumerable[str] """ - - EnergyModes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> IEnumerable[str] - """ Get: EnergyModes(self: RTPrescription) -> IEnumerable[str] """ - - Gating = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> str - """ Get: Gating(self: RTPrescription) -> str """ - - LatestRevision = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> RTPrescription - """ Get: LatestRevision(self: RTPrescription) -> RTPrescription """ - - Notes = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> str - """ Get: Notes(self: RTPrescription) -> str """ - - NumberOfFractions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> Nullable[int] - """ Get: NumberOfFractions(self: RTPrescription) -> Nullable[int] """ - - OrgansAtRisk = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> IEnumerable[RTPrescriptionOrganAtRisk] - """ Get: OrgansAtRisk(self: RTPrescription) -> IEnumerable[RTPrescriptionOrganAtRisk] """ - - PhaseType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> str - """ Get: PhaseType(self: RTPrescription) -> str """ - - PredecessorPrescription = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> RTPrescription - """ Get: PredecessorPrescription(self: RTPrescription) -> RTPrescription """ - - RevisionNumber = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> int - """ Get: RevisionNumber(self: RTPrescription) -> int """ - - SimulationNeeded = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> Nullable[bool] - """ Get: SimulationNeeded(self: RTPrescription) -> Nullable[bool] """ - - Site = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> str - """ Get: Site(self: RTPrescription) -> str """ - - Status = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> str - """ Get: Status(self: RTPrescription) -> str """ - - TargetConstraintsWithoutTargetLevel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> IEnumerable[RTPrescriptionTargetConstraints] - """ Get: TargetConstraintsWithoutTargetLevel(self: RTPrescription) -> IEnumerable[RTPrescriptionTargetConstraints] """ - - Targets = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> IEnumerable[RTPrescriptionTarget] - """ Get: Targets(self: RTPrescription) -> IEnumerable[RTPrescriptionTarget] """ - - Technique = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescription) -> str - """ Get: Technique(self: RTPrescription) -> str """ - - - -class RTPrescriptionConstraint(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: RTPrescriptionConstraint, writer: XmlWriter) - """ WriteXml(self: RTPrescriptionConstraint, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - ConstraintType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionConstraint) -> RTPrescriptionConstraintType - """ Get: ConstraintType(self: RTPrescriptionConstraint) -> RTPrescriptionConstraintType """ - - Unit1 = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionConstraint) -> str - """ Get: Unit1(self: RTPrescriptionConstraint) -> str """ - - Unit2 = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionConstraint) -> str - """ Get: Unit2(self: RTPrescriptionConstraint) -> str """ - - Value1 = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionConstraint) -> str - """ Get: Value1(self: RTPrescriptionConstraint) -> str """ - - Value2 = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionConstraint) -> str - """ Get: Value2(self: RTPrescriptionConstraint) -> str """ - - - -class RTPrescriptionOrganAtRisk(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: RTPrescriptionOrganAtRisk, writer: XmlWriter) - """ WriteXml(self: RTPrescriptionOrganAtRisk, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Constraints = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionOrganAtRisk) -> IEnumerable[RTPrescriptionConstraint] - """ Get: Constraints(self: RTPrescriptionOrganAtRisk) -> IEnumerable[RTPrescriptionConstraint] """ - - OrganAtRiskId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionOrganAtRisk) -> str - """ Get: OrganAtRiskId(self: RTPrescriptionOrganAtRisk) -> str """ - - - -class RTPrescriptionTarget(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: RTPrescriptionTarget, writer: XmlWriter) - """ WriteXml(self: RTPrescriptionTarget, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Constraints = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionTarget) -> IEnumerable[RTPrescriptionConstraint] - """ Get: Constraints(self: RTPrescriptionTarget) -> IEnumerable[RTPrescriptionConstraint] """ - - DosePerFraction = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionTarget) -> DoseValue - """ Get: DosePerFraction(self: RTPrescriptionTarget) -> DoseValue """ - - NumberOfFractions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionTarget) -> int - """ Get: NumberOfFractions(self: RTPrescriptionTarget) -> int """ - - TargetId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionTarget) -> str - """ Get: TargetId(self: RTPrescriptionTarget) -> str """ - - Type = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionTarget) -> RTPrescriptionTargetType - """ Get: Type(self: RTPrescriptionTarget) -> RTPrescriptionTargetType """ - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionTarget) -> float - """ Get: Value(self: RTPrescriptionTarget) -> float """ - - - -class RTPrescriptionTargetConstraints(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: RTPrescriptionTargetConstraints, writer: XmlWriter) - """ WriteXml(self: RTPrescriptionTargetConstraints, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - Constraints = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionTargetConstraints) -> IEnumerable[RTPrescriptionConstraint] - """ Get: Constraints(self: RTPrescriptionTargetConstraints) -> IEnumerable[RTPrescriptionConstraint] """ - - TargetId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: RTPrescriptionTargetConstraints) -> str - """ Get: TargetId(self: RTPrescriptionTargetConstraints) -> str """ - - - -class ScriptContext(object): - # type: (context: object, user: object, appName: str) - """ ScriptContext(context: object, user: object, appName: str) """ - @staticmethod # known case of __new__ - def __new__(self, context, user, appName): - """ __new__(cls: type, context: object, user: object, appName: str) """ - pass - - ApplicationName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> str - """ Get: ApplicationName(self: ScriptContext) -> str """ - - BrachyPlanSetup = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> BrachyPlanSetup - """ Get: BrachyPlanSetup(self: ScriptContext) -> BrachyPlanSetup """ - - BrachyPlansInScope = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> IEnumerable[BrachyPlanSetup] - """ Get: BrachyPlansInScope(self: ScriptContext) -> IEnumerable[BrachyPlanSetup] """ - - Course = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> Course - """ Get: Course(self: ScriptContext) -> Course """ - - CurrentUser = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> User - """ Get: CurrentUser(self: ScriptContext) -> User """ - - ExternalPlanSetup = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> ExternalPlanSetup - """ Get: ExternalPlanSetup(self: ScriptContext) -> ExternalPlanSetup """ - - ExternalPlansInScope = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> IEnumerable[ExternalPlanSetup] - """ Get: ExternalPlansInScope(self: ScriptContext) -> IEnumerable[ExternalPlanSetup] """ - - Image = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> Image - """ Get: Image(self: ScriptContext) -> Image """ - - IonPlanSetup = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> IonPlanSetup - """ Get: IonPlanSetup(self: ScriptContext) -> IonPlanSetup """ - - IonPlansInScope = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> IEnumerable[IonPlanSetup] - """ Get: IonPlansInScope(self: ScriptContext) -> IEnumerable[IonPlanSetup] """ - - Patient = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> Patient - """ Get: Patient(self: ScriptContext) -> Patient """ - - PlanSetup = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> PlanSetup - """ Get: PlanSetup(self: ScriptContext) -> PlanSetup """ - - PlansInScope = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> IEnumerable[PlanSetup] - """ Get: PlansInScope(self: ScriptContext) -> IEnumerable[PlanSetup] """ - - PlanSumsInScope = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> IEnumerable[PlanSum] - """ Get: PlanSumsInScope(self: ScriptContext) -> IEnumerable[PlanSum] """ - - StructureSet = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> StructureSet - """ Get: StructureSet(self: ScriptContext) -> StructureSet """ - - VersionInfo = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptContext) -> str - """ Get: VersionInfo(self: ScriptContext) -> str """ - - - -class ScriptEnvironment(object): - # type: (appName: str, scripts: IEnumerable[IApplicationScript], scriptExecutionEngine: Action[Assembly, object, Window, object]) - """ ScriptEnvironment(appName: str, scripts: IEnumerable[IApplicationScript], scriptExecutionEngine: Action[Assembly, object, Window, object]) """ - def ExecuteScript(self, scriptAssembly, scriptContext, window): - # type: (self: ScriptEnvironment, scriptAssembly: Assembly, scriptContext: ScriptContext, window: Window) - """ ExecuteScript(self: ScriptEnvironment, scriptAssembly: Assembly, scriptContext: ScriptContext, window: Window) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, appName, scripts, scriptExecutionEngine): - """ __new__(cls: type, appName: str, scripts: IEnumerable[IApplicationScript], scriptExecutionEngine: Action[Assembly, object, Window, object]) """ - pass - - ApiVersionInfo = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptEnvironment) -> str - """ Get: ApiVersionInfo(self: ScriptEnvironment) -> str """ - - ApplicationName = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptEnvironment) -> str - """ Get: ApplicationName(self: ScriptEnvironment) -> str """ - - Scripts = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptEnvironment) -> IEnumerable[ApplicationScript] - """ Get: Scripts(self: ScriptEnvironment) -> IEnumerable[ApplicationScript] """ - - VersionInfo = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ScriptEnvironment) -> str - """ Get: VersionInfo(self: ScriptEnvironment) -> str """ - - - -class SearchBodyParameters(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def LoadDefaults(self): - # type: (self: SearchBodyParameters) - """ LoadDefaults(self: SearchBodyParameters) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: SearchBodyParameters, writer: XmlWriter) - """ WriteXml(self: SearchBodyParameters, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - FillAllCavities = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> bool - """ - Get: FillAllCavities(self: SearchBodyParameters) -> bool - - Set: FillAllCavities(self: SearchBodyParameters) = value - """ - - KeepLargestParts = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> bool - """ - Get: KeepLargestParts(self: SearchBodyParameters) -> bool - - Set: KeepLargestParts(self: SearchBodyParameters) = value - """ - - LowerHUThreshold = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> int - """ - Get: LowerHUThreshold(self: SearchBodyParameters) -> int - - Set: LowerHUThreshold(self: SearchBodyParameters) = value - """ - - MREdgeThresholdHigh = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> int - """ - Get: MREdgeThresholdHigh(self: SearchBodyParameters) -> int - - Set: MREdgeThresholdHigh(self: SearchBodyParameters) = value - """ - - MREdgeThresholdLow = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> int - """ - Get: MREdgeThresholdLow(self: SearchBodyParameters) -> int - - Set: MREdgeThresholdLow(self: SearchBodyParameters) = value - """ - - NumberOfLargestPartsToKeep = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> int - """ - Get: NumberOfLargestPartsToKeep(self: SearchBodyParameters) -> int - - Set: NumberOfLargestPartsToKeep(self: SearchBodyParameters) = value - """ - - PreCloseOpenings = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> bool - """ - Get: PreCloseOpenings(self: SearchBodyParameters) -> bool - - Set: PreCloseOpenings(self: SearchBodyParameters) = value - """ - - PreCloseOpeningsRadius = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> float - """ - Get: PreCloseOpeningsRadius(self: SearchBodyParameters) -> float - - Set: PreCloseOpeningsRadius(self: SearchBodyParameters) = value - """ - - PreDisconnect = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> bool - """ - Get: PreDisconnect(self: SearchBodyParameters) -> bool - - Set: PreDisconnect(self: SearchBodyParameters) = value - """ - - PreDisconnectRadius = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> float - """ - Get: PreDisconnectRadius(self: SearchBodyParameters) -> float - - Set: PreDisconnectRadius(self: SearchBodyParameters) = value - """ - - Smoothing = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> bool - """ - Get: Smoothing(self: SearchBodyParameters) -> bool - - Set: Smoothing(self: SearchBodyParameters) = value - """ - - SmoothingLevel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SearchBodyParameters) -> int - """ - Get: SmoothingLevel(self: SearchBodyParameters) -> int - - Set: SmoothingLevel(self: SearchBodyParameters) = value - """ - - - -class SeedCollection(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: SeedCollection, writer: XmlWriter) - """ WriteXml(self: SeedCollection, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - BrachyFieldReferencePoints = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SeedCollection) -> IEnumerable[BrachyFieldReferencePoint] - """ Get: BrachyFieldReferencePoints(self: SeedCollection) -> IEnumerable[BrachyFieldReferencePoint] """ - - Color = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SeedCollection) -> Color - """ Get: Color(self: SeedCollection) -> Color """ - - SourcePositions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SeedCollection) -> IEnumerable[SourcePosition] - """ Get: SourcePositions(self: SeedCollection) -> IEnumerable[SourcePosition] """ - - - -class SegmentVolume(SerializableObject, IXmlSerializable): - # no doc - def And(self, other): - # type: (self: SegmentVolume, other: SegmentVolume) -> SegmentVolume - """ And(self: SegmentVolume, other: SegmentVolume) -> SegmentVolume """ - pass - - def AsymmetricMargin(self, margins): - # type: (self: SegmentVolume, margins: AxisAlignedMargins) -> SegmentVolume - """ AsymmetricMargin(self: SegmentVolume, margins: AxisAlignedMargins) -> SegmentVolume """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def Margin(self, marginInMM): - # type: (self: SegmentVolume, marginInMM: float) -> SegmentVolume - """ Margin(self: SegmentVolume, marginInMM: float) -> SegmentVolume """ - pass - - def Not(self): - # type: (self: SegmentVolume) -> SegmentVolume - """ Not(self: SegmentVolume) -> SegmentVolume """ - pass - - def Or(self, other): - # type: (self: SegmentVolume, other: SegmentVolume) -> SegmentVolume - """ Or(self: SegmentVolume, other: SegmentVolume) -> SegmentVolume """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def Sub(self, other): - # type: (self: SegmentVolume, other: SegmentVolume) -> SegmentVolume - """ Sub(self: SegmentVolume, other: SegmentVolume) -> SegmentVolume """ - pass - - def WriteXml(self, writer): - # type: (self: SegmentVolume, writer: XmlWriter) - """ WriteXml(self: SegmentVolume, writer: XmlWriter) """ - pass - - def Xor(self, other): - # type: (self: SegmentVolume, other: SegmentVolume) -> SegmentVolume - """ Xor(self: SegmentVolume, other: SegmentVolume) -> SegmentVolume """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class Series(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def SetImagingDevice(self, imagingDeviceId): - # type: (self: Series, imagingDeviceId: str) - """ SetImagingDevice(self: Series, imagingDeviceId: str) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Series, writer: XmlWriter) - """ WriteXml(self: Series, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - FOR = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Series) -> str - """ Get: FOR(self: Series) -> str """ - - Images = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Series) -> IEnumerable[Image] - """ Get: Images(self: Series) -> IEnumerable[Image] """ - - ImagingDeviceId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Series) -> str - """ Get: ImagingDeviceId(self: Series) -> str """ - - ImagingDeviceManufacturer = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Series) -> str - """ Get: ImagingDeviceManufacturer(self: Series) -> str """ - - ImagingDeviceModel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Series) -> str - """ Get: ImagingDeviceModel(self: Series) -> str """ - - ImagingDeviceSerialNo = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Series) -> str - """ Get: ImagingDeviceSerialNo(self: Series) -> str """ - - Modality = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Series) -> SeriesModality - """ Get: Modality(self: Series) -> SeriesModality """ - - Study = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Series) -> Study - """ Get: Study(self: Series) -> Study """ - - UID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Series) -> str - """ Get: UID(self: Series) -> str """ - - - -class Slot(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Slot, writer: XmlWriter) - """ WriteXml(self: Slot, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Number = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Slot) -> int - """ Get: Number(self: Slot) -> int """ - - - -class SourcePosition(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: SourcePosition, writer: XmlWriter) - """ WriteXml(self: SourcePosition, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - DwellTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SourcePosition) -> float - """ Get: DwellTime(self: SourcePosition) -> float """ - - RadioactiveSource = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SourcePosition) -> RadioactiveSource - """ Get: RadioactiveSource(self: SourcePosition) -> RadioactiveSource """ - - Transform = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SourcePosition) -> Array[float] - """ Get: Transform(self: SourcePosition) -> Array[float] """ - - Translation = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SourcePosition) -> VVector - """ Get: Translation(self: SourcePosition) -> VVector """ - - - -class StandardWedge(Wedge, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: StandardWedge, writer: XmlWriter) - """ WriteXml(self: StandardWedge, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class Structure(ApiDataObject, IXmlSerializable): - # no doc - def AddContourOnImagePlane(self, contour, z): - # type: (self: Structure, contour: Array[VVector], z: int) - """ AddContourOnImagePlane(self: Structure, contour: Array[VVector], z: int) """ - pass - - def And(self, other): - # type: (self: Structure, other: SegmentVolume) -> SegmentVolume - """ And(self: Structure, other: SegmentVolume) -> SegmentVolume """ - pass - - def AsymmetricMargin(self, margins): - # type: (self: Structure, margins: AxisAlignedMargins) -> SegmentVolume - """ AsymmetricMargin(self: Structure, margins: AxisAlignedMargins) -> SegmentVolume """ - pass - - def CanConvertToHighResolution(self): - # type: (self: Structure) -> bool - """ CanConvertToHighResolution(self: Structure) -> bool """ - pass - - def CanEditSegmentVolume(self, errorMessage): - # type: (self: Structure) -> (bool, str) - """ CanEditSegmentVolume(self: Structure) -> (bool, str) """ - pass - - def CanSetAssignedHU(self, errorMessage): - # type: (self: Structure) -> (bool, str) - """ CanSetAssignedHU(self: Structure) -> (bool, str) """ - pass - - def ClearAllContoursOnImagePlane(self, z): - # type: (self: Structure, z: int) - """ ClearAllContoursOnImagePlane(self: Structure, z: int) """ - pass - - def ConvertDoseLevelToStructure(self, dose, doseLevel): - # type: (self: Structure, dose: Dose, doseLevel: DoseValue) - """ ConvertDoseLevelToStructure(self: Structure, dose: Dose, doseLevel: DoseValue) """ - pass - - def ConvertToHighResolution(self): - # type: (self: Structure) - """ ConvertToHighResolution(self: Structure) """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetAssignedHU(self, huValue): - # type: (self: Structure) -> (bool, float) - """ GetAssignedHU(self: Structure) -> (bool, float) """ - pass - - def GetContoursOnImagePlane(self, z): - # type: (self: Structure, z: int) -> Array[Array[VVector]] - """ GetContoursOnImagePlane(self: Structure, z: int) -> Array[Array[VVector]] """ - pass - - def GetNumberOfSeparateParts(self): - # type: (self: Structure) -> int - """ GetNumberOfSeparateParts(self: Structure) -> int """ - pass - - def GetReferenceLinePoints(self): - # type: (self: Structure) -> Array[VVector] - """ GetReferenceLinePoints(self: Structure) -> Array[VVector] """ - pass - - def GetSegmentProfile(self, start, stop, preallocatedBuffer): - # type: (self: Structure, start: VVector, stop: VVector, preallocatedBuffer: BitArray) -> SegmentProfile - """ GetSegmentProfile(self: Structure, start: VVector, stop: VVector, preallocatedBuffer: BitArray) -> SegmentProfile """ - pass - - def IsPointInsideSegment(self, point): - # type: (self: Structure, point: VVector) -> bool - """ IsPointInsideSegment(self: Structure, point: VVector) -> bool """ - pass - - def Margin(self, marginInMM): - # type: (self: Structure, marginInMM: float) -> SegmentVolume - """ Margin(self: Structure, marginInMM: float) -> SegmentVolume """ - pass - - def Not(self): - # type: (self: Structure) -> SegmentVolume - """ Not(self: Structure) -> SegmentVolume """ - pass - - def Or(self, other): - # type: (self: Structure, other: SegmentVolume) -> SegmentVolume - """ Or(self: Structure, other: SegmentVolume) -> SegmentVolume """ - pass - - def ResetAssignedHU(self): - # type: (self: Structure) -> bool - """ ResetAssignedHU(self: Structure) -> bool """ - pass - - def SetAssignedHU(self, huValue): - # type: (self: Structure, huValue: float) - """ SetAssignedHU(self: Structure, huValue: float) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def Sub(self, other): - # type: (self: Structure, other: SegmentVolume) -> SegmentVolume - """ Sub(self: Structure, other: SegmentVolume) -> SegmentVolume """ - pass - - def SubtractContourOnImagePlane(self, contour, z): - # type: (self: Structure, contour: Array[VVector], z: int) - """ SubtractContourOnImagePlane(self: Structure, contour: Array[VVector], z: int) """ - pass - - def WriteXml(self, writer): - # type: (self: Structure, writer: XmlWriter) - """ WriteXml(self: Structure, writer: XmlWriter) """ - pass - - def Xor(self, other): - # type: (self: Structure, other: SegmentVolume) -> SegmentVolume - """ Xor(self: Structure, other: SegmentVolume) -> SegmentVolume """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ApprovalHistory = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> IEnumerable[StructureApprovalHistoryEntry] - """ Get: ApprovalHistory(self: Structure) -> IEnumerable[StructureApprovalHistoryEntry] """ - - CenterPoint = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> VVector - """ Get: CenterPoint(self: Structure) -> VVector """ - - Color = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> Color - """ Get: Color(self: Structure) -> Color """ - - DicomType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> str - """ Get: DicomType(self: Structure) -> str """ - - HasSegment = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> bool - """ Get: HasSegment(self: Structure) -> bool """ - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> str - """ - Get: Id(self: Structure) -> str - - Set: Id(self: Structure) = value - """ - - IsEmpty = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> bool - """ Get: IsEmpty(self: Structure) -> bool """ - - IsHighResolution = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> bool - """ Get: IsHighResolution(self: Structure) -> bool """ - - MeshGeometry = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> MeshGeometry3D - """ Get: MeshGeometry(self: Structure) -> MeshGeometry3D """ - - ROINumber = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> int - """ Get: ROINumber(self: Structure) -> int """ - - SegmentVolume = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> SegmentVolume - """ - Get: SegmentVolume(self: Structure) -> SegmentVolume - - Set: SegmentVolume(self: Structure) = value - """ - - StructureCodeInfos = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> IEnumerable[StructureCodeInfo] - """ Get: StructureCodeInfos(self: Structure) -> IEnumerable[StructureCodeInfo] """ - - Volume = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Structure) -> float - """ Get: Volume(self: Structure) -> float """ - - - -class StructureSet(ApiDataObject, IXmlSerializable): - # no doc - def AddStructure(self, dicomType, id): - # type: (self: StructureSet, dicomType: str, id: str) -> Structure - """ AddStructure(self: StructureSet, dicomType: str, id: str) -> Structure """ - pass - - def CanAddStructure(self, dicomType, id): - # type: (self: StructureSet, dicomType: str, id: str) -> bool - """ CanAddStructure(self: StructureSet, dicomType: str, id: str) -> bool """ - pass - - def CanRemoveStructure(self, structure): - # type: (self: StructureSet, structure: Structure) -> bool - """ CanRemoveStructure(self: StructureSet, structure: Structure) -> bool """ - pass - - def Copy(self): - # type: (self: StructureSet) -> StructureSet - """ Copy(self: StructureSet) -> StructureSet """ - pass - - def CreateAndSearchBody(self, parameters): - # type: (self: StructureSet, parameters: SearchBodyParameters) -> Structure - """ CreateAndSearchBody(self: StructureSet, parameters: SearchBodyParameters) -> Structure """ - pass - - def Delete(self): - # type: (self: StructureSet) - """ Delete(self: StructureSet) """ - pass - - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def GetDefaultSearchBodyParameters(self): - # type: (self: StructureSet) -> SearchBodyParameters - """ GetDefaultSearchBodyParameters(self: StructureSet) -> SearchBodyParameters """ - pass - - def RemoveStructure(self, structure): - # type: (self: StructureSet, structure: Structure) - """ RemoveStructure(self: StructureSet, structure: Structure) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: StructureSet, writer: XmlWriter) - """ WriteXml(self: StructureSet, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ApplicationScriptLogs = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: StructureSet) -> IEnumerable[ApplicationScriptLog] - """ Get: ApplicationScriptLogs(self: StructureSet) -> IEnumerable[ApplicationScriptLog] """ - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: StructureSet) -> str - """ - Get: Id(self: StructureSet) -> str - - Set: Id(self: StructureSet) = value - """ - - Image = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: StructureSet) -> Image - """ Get: Image(self: StructureSet) -> Image """ - - Patient = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: StructureSet) -> Patient - """ Get: Patient(self: StructureSet) -> Patient """ - - Structures = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: StructureSet) -> IEnumerable[Structure] - """ Get: Structures(self: StructureSet) -> IEnumerable[Structure] """ - - UID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: StructureSet) -> str - """ Get: UID(self: StructureSet) -> str """ - - - -class Study(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Study, writer: XmlWriter) - """ WriteXml(self: Study, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CreationDateTime = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Study) -> Nullable[DateTime] - """ Get: CreationDateTime(self: Study) -> Nullable[DateTime] """ - - Series = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Study) -> IEnumerable[Series] - """ Get: Series(self: Study) -> IEnumerable[Series] """ - - UID = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Study) -> str - """ Get: UID(self: Study) -> str """ - - - -class Technique(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Technique, writer: XmlWriter) - """ WriteXml(self: Technique, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class TradeoffExplorationContext(object): - # no doc - def AddTargetHomogeneityObjective(self, targetStructure): - # type: (self: TradeoffExplorationContext, targetStructure: Structure) -> bool - """ AddTargetHomogeneityObjective(self: TradeoffExplorationContext, targetStructure: Structure) -> bool """ - pass - - def AddTradeoffObjective(self, *__args): - # type: (self: TradeoffExplorationContext, structure: Structure) -> bool - """ - AddTradeoffObjective(self: TradeoffExplorationContext, structure: Structure) -> bool - AddTradeoffObjective(self: TradeoffExplorationContext, objective: OptimizationObjective) -> bool - """ - pass - - def ApplyTradeoffExplorationResult(self): - # type: (self: TradeoffExplorationContext) - """ ApplyTradeoffExplorationResult(self: TradeoffExplorationContext) """ - pass - - def CreateDeliverableVmatPlan(self, useIntermediateDose): - # type: (self: TradeoffExplorationContext, useIntermediateDose: bool) -> bool - """ CreateDeliverableVmatPlan(self: TradeoffExplorationContext, useIntermediateDose: bool) -> bool """ - pass - - def CreatePlanCollection(self, continueOptimization, intermediateDoseMode, useHybridOptimizationForVmat): - # type: (self: TradeoffExplorationContext, continueOptimization: bool, intermediateDoseMode: TradeoffPlanGenerationIntermediateDoseMode, useHybridOptimizationForVmat: bool) -> bool - """ CreatePlanCollection(self: TradeoffExplorationContext, continueOptimization: bool, intermediateDoseMode: TradeoffPlanGenerationIntermediateDoseMode, useHybridOptimizationForVmat: bool) -> bool """ - pass - - def GetObjectiveCost(self, objective): - # type: (self: TradeoffExplorationContext, objective: TradeoffObjective) -> float - """ GetObjectiveCost(self: TradeoffExplorationContext, objective: TradeoffObjective) -> float """ - pass - - def GetObjectiveLowerLimit(self, objective): - # type: (self: TradeoffExplorationContext, objective: TradeoffObjective) -> float - """ GetObjectiveLowerLimit(self: TradeoffExplorationContext, objective: TradeoffObjective) -> float """ - pass - - def GetObjectiveUpperLimit(self, objective): - # type: (self: TradeoffExplorationContext, objective: TradeoffObjective) -> float - """ GetObjectiveUpperLimit(self: TradeoffExplorationContext, objective: TradeoffObjective) -> float """ - pass - - def GetObjectiveUpperRestrictor(self, objective): - # type: (self: TradeoffExplorationContext, objective: TradeoffObjective) -> float - """ GetObjectiveUpperRestrictor(self: TradeoffExplorationContext, objective: TradeoffObjective) -> float """ - pass - - def GetStructureDvh(self, structure): - # type: (self: TradeoffExplorationContext, structure: Structure) -> DVHData - """ GetStructureDvh(self: TradeoffExplorationContext, structure: Structure) -> DVHData """ - pass - - def LoadSavedPlanCollection(self): - # type: (self: TradeoffExplorationContext) -> bool - """ LoadSavedPlanCollection(self: TradeoffExplorationContext) -> bool """ - pass - - def RemoveAllTradeoffObjectives(self): - # type: (self: TradeoffExplorationContext) - """ RemoveAllTradeoffObjectives(self: TradeoffExplorationContext) """ - pass - - def RemovePlanCollection(self): - # type: (self: TradeoffExplorationContext) - """ RemovePlanCollection(self: TradeoffExplorationContext) """ - pass - - def RemoveTargetHomogeneityObjective(self, targetStructure): - # type: (self: TradeoffExplorationContext, targetStructure: Structure) -> bool - """ RemoveTargetHomogeneityObjective(self: TradeoffExplorationContext, targetStructure: Structure) -> bool """ - pass - - def RemoveTradeoffObjective(self, *__args): - # type: (self: TradeoffExplorationContext, tradeoffObjective: TradeoffObjective) -> bool - """ - RemoveTradeoffObjective(self: TradeoffExplorationContext, tradeoffObjective: TradeoffObjective) -> bool - RemoveTradeoffObjective(self: TradeoffExplorationContext, structure: Structure) -> bool - """ - pass - - def ResetToBalancedPlan(self): - # type: (self: TradeoffExplorationContext) - """ ResetToBalancedPlan(self: TradeoffExplorationContext) """ - pass - - def SetObjectiveCost(self, tradeoffObjective, cost): - # type: (self: TradeoffExplorationContext, tradeoffObjective: TradeoffObjective, cost: float) - """ SetObjectiveCost(self: TradeoffExplorationContext, tradeoffObjective: TradeoffObjective, cost: float) """ - pass - - def SetObjectiveUpperRestrictor(self, tradeoffObjective, restrictorValue): - # type: (self: TradeoffExplorationContext, tradeoffObjective: TradeoffObjective, restrictorValue: float) - """ SetObjectiveUpperRestrictor(self: TradeoffExplorationContext, tradeoffObjective: TradeoffObjective, restrictorValue: float) """ - pass - - CanCreatePlanCollection = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffExplorationContext) -> bool - """ Get: CanCreatePlanCollection(self: TradeoffExplorationContext) -> bool """ - - CanLoadSavedPlanCollection = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffExplorationContext) -> bool - """ Get: CanLoadSavedPlanCollection(self: TradeoffExplorationContext) -> bool """ - - CanUseHybridOptimizationInPlanGeneration = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffExplorationContext) -> bool - """ Get: CanUseHybridOptimizationInPlanGeneration(self: TradeoffExplorationContext) -> bool """ - - CanUsePlanDoseAsIntermediateDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffExplorationContext) -> bool - """ Get: CanUsePlanDoseAsIntermediateDose(self: TradeoffExplorationContext) -> bool """ - - CurrentDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffExplorationContext) -> Dose - """ Get: CurrentDose(self: TradeoffExplorationContext) -> Dose """ - - HasPlanCollection = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffExplorationContext) -> bool - """ Get: HasPlanCollection(self: TradeoffExplorationContext) -> bool """ - - TargetStructures = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffExplorationContext) -> IReadOnlyList[Structure] - """ Get: TargetStructures(self: TradeoffExplorationContext) -> IReadOnlyList[Structure] """ - - TradeoffObjectiveCandidates = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffExplorationContext) -> IReadOnlyList[OptimizationObjective] - """ Get: TradeoffObjectiveCandidates(self: TradeoffExplorationContext) -> IReadOnlyList[OptimizationObjective] """ - - TradeoffObjectives = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffExplorationContext) -> IReadOnlyCollection[TradeoffObjective] - """ Get: TradeoffObjectives(self: TradeoffExplorationContext) -> IReadOnlyCollection[TradeoffObjective] """ - - TradeoffStructureCandidates = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffExplorationContext) -> IReadOnlyList[Structure] - """ Get: TradeoffStructureCandidates(self: TradeoffExplorationContext) -> IReadOnlyList[Structure] """ - - - -class TradeoffObjective(object): - # no doc - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffObjective) -> int - """ Get: Id(self: TradeoffObjective) -> int """ - - OptimizationObjectives = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffObjective) -> IEnumerable[OptimizationObjective] - """ Get: OptimizationObjectives(self: TradeoffObjective) -> IEnumerable[OptimizationObjective] """ - - Structure = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TradeoffObjective) -> Structure - """ Get: Structure(self: TradeoffObjective) -> Structure """ - - - -class TradeoffPlanGenerationIntermediateDoseMode(Enum, IComparable, IFormattable, IConvertible): - # type: (2), NotUsed (0), UsePlanDose (1) - """ enum TradeoffPlanGenerationIntermediateDoseMode, values: Calculate (2), NotUsed (0), UsePlanDose (1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Calculate = None - NotUsed = None - UsePlanDose = None - value__ = None - - -class Tray(AddOn, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: Tray, writer: XmlWriter) - """ WriteXml(self: Tray, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - -class TreatmentPhase(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: TreatmentPhase, writer: XmlWriter) - """ WriteXml(self: TreatmentPhase, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - OtherInfo = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentPhase) -> str - """ Get: OtherInfo(self: TreatmentPhase) -> str """ - - PhaseGapNumberOfDays = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentPhase) -> int - """ Get: PhaseGapNumberOfDays(self: TreatmentPhase) -> int """ - - Prescriptions = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentPhase) -> IEnumerable[RTPrescription] - """ Get: Prescriptions(self: TreatmentPhase) -> IEnumerable[RTPrescription] """ - - TimeGapType = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentPhase) -> str - """ Get: TimeGapType(self: TreatmentPhase) -> str """ - - - -class TreatmentSession(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: TreatmentSession, writer: XmlWriter) - """ WriteXml(self: TreatmentSession, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SessionNumber = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentSession) -> Int64 - """ Get: SessionNumber(self: TreatmentSession) -> Int64 """ - - SessionPlans = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentSession) -> IEnumerable[PlanTreatmentSession] - """ Get: SessionPlans(self: TreatmentSession) -> IEnumerable[PlanTreatmentSession] """ - - - -class TreatmentUnitOperatingLimit(ApiDataObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: TreatmentUnitOperatingLimit, writer: XmlWriter) - """ WriteXml(self: TreatmentUnitOperatingLimit, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Label = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentUnitOperatingLimit) -> str - """ Get: Label(self: TreatmentUnitOperatingLimit) -> str """ - - MaxValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentUnitOperatingLimit) -> float - """ Get: MaxValue(self: TreatmentUnitOperatingLimit) -> float """ - - MinValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentUnitOperatingLimit) -> float - """ Get: MinValue(self: TreatmentUnitOperatingLimit) -> float """ - - Precision = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentUnitOperatingLimit) -> Nullable[int] - """ Get: Precision(self: TreatmentUnitOperatingLimit) -> Nullable[int] """ - - UnitString = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentUnitOperatingLimit) -> str - """ Get: UnitString(self: TreatmentUnitOperatingLimit) -> str """ - - - -class TreatmentUnitOperatingLimits(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def WriteXml(self, writer): - # type: (self: TreatmentUnitOperatingLimits, writer: XmlWriter) - """ WriteXml(self: TreatmentUnitOperatingLimits, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - CollimatorAngle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentUnitOperatingLimits) -> TreatmentUnitOperatingLimit - """ Get: CollimatorAngle(self: TreatmentUnitOperatingLimits) -> TreatmentUnitOperatingLimit """ - - GantryAngle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentUnitOperatingLimits) -> TreatmentUnitOperatingLimit - """ Get: GantryAngle(self: TreatmentUnitOperatingLimits) -> TreatmentUnitOperatingLimit """ - - MU = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentUnitOperatingLimits) -> TreatmentUnitOperatingLimit - """ Get: MU(self: TreatmentUnitOperatingLimits) -> TreatmentUnitOperatingLimit """ - - PatientSupportAngle = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: TreatmentUnitOperatingLimits) -> TreatmentUnitOperatingLimit - """ Get: PatientSupportAngle(self: TreatmentUnitOperatingLimits) -> TreatmentUnitOperatingLimit """ - - - -class TypeBasedIdValidator(object): - # no doc - @staticmethod - def IsValidId(id, dataObject, errorHint): - # type: (id: str, dataObject: ApiDataObject, errorHint: StringBuilder) -> bool - """ IsValidId(id: str, dataObject: ApiDataObject, errorHint: StringBuilder) -> bool """ - pass - - @staticmethod - def ThrowIfNotValidId(id, dataObject): - # type: (id: str, dataObject: ApiDataObject) - """ ThrowIfNotValidId(id: str, dataObject: ApiDataObject) """ - pass - - __all__ = [ - 'IsValidId', - 'ThrowIfNotValidId', - ] - - -class User(SerializableObject, IXmlSerializable): - # no doc - def EndSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject) - """ EndSerialization(self: SerializableObject) """ - pass - - def Equals(self, obj): - # type: (self: User, obj: object) -> bool - """ Equals(self: User, obj: object) -> bool """ - pass - - def GetHashCode(self): - # type: (self: User) -> int - """ GetHashCode(self: User) -> int """ - pass - - def StartSerialization(self, *args): #cannot find CLR method - # type: (self: SerializableObject, typeName: str, typeId: str) - """ StartSerialization(self: SerializableObject, typeName: str, typeId: str) """ - pass - - def ToString(self): - # type: (self: User) -> str - """ ToString(self: User) -> str """ - pass - - def WriteXml(self, writer): - # type: (self: User, writer: XmlWriter) - """ WriteXml(self: User, writer: XmlWriter) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Id = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: User) -> str - """ Get: Id(self: User) -> str """ - - Language = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: User) -> str - """ Get: Language(self: User) -> str """ - - Name = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: User) -> str - """ Get: Name(self: User) -> str """ - - - diff --git a/pyesapi/stubs/VMS/TPS/Common/Model/Types.py b/pyesapi/stubs/VMS/TPS/Common/Model/Types.py deleted file mode 100644 index c4a9af3..0000000 --- a/pyesapi/stubs/VMS/TPS/Common/Model/Types.py +++ /dev/null @@ -1,3263 +0,0 @@ -# encoding: utf-8 -# module VMS.TPS.Common.Model.Types calls itself Types -# from VMS.TPS.Common.Model.Types, Version=1.0.300.11, Culture=neutral, PublicKeyToken=305b81e210ec4b89 -# by generator 1.145 -# no doc -# no imports - -# no functions -# classes - -class ApplicationScriptApprovalStatus(Enum, IComparable, IFormattable, IConvertible): - # type: (2), ApprovedForEvaluation (1), Retired (3), Unapproved (0), Undefined (-1) - """ enum ApplicationScriptApprovalStatus, values: Approved (2), ApprovedForEvaluation (1), Retired (3), Unapproved (0), Undefined (-1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Approved = None - ApprovedForEvaluation = None - Retired = None - Unapproved = None - Undefined = None - value__ = None - - -class ApplicationScriptType(Enum, IComparable, IFormattable, IConvertible): - # type: (0), ESAPIActionPack (1), ESAPICustomExecutable (3), MIRS (2), Unknown (-1) - """ enum ApplicationScriptType, values: ESAPI (0), ESAPIActionPack (1), ESAPICustomExecutable (3), MIRS (2), Unknown (-1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ESAPI = None - ESAPIActionPack = None - ESAPICustomExecutable = None - MIRS = None - Unknown = None - value__ = None - - -class ApprovalHistoryEntry(object): - # no doc - ApprovalDateTime = None - ApprovalStatus = None - StatusComment = None - UserDisplayName = None - UserId = None - - -class AxisAlignedMargins(object): - # type: (geometry: StructureMarginGeometry, x1: float, y1: float, z1: float, x2: float, y2: float, z2: float) - """ AxisAlignedMargins(geometry: StructureMarginGeometry, x1: float, y1: float, z1: float, x2: float, y2: float, z2: float) """ - def ToString(self): - # type: (self: AxisAlignedMargins) -> str - """ ToString(self: AxisAlignedMargins) -> str """ - pass - - @staticmethod # known case of __new__ - def __new__(self, geometry, x1, y1, z1, x2, y2, z2): - """ - __new__[AxisAlignedMargins]() -> AxisAlignedMargins - - - - __new__(cls: type, geometry: StructureMarginGeometry, x1: float, y1: float, z1: float, x2: float, y2: float, z2: float) - """ - pass - - Geometry = None - X1 = None - X2 = None - Y1 = None - Y2 = None - Z1 = None - Z2 = None - - -class BeamNumber(object, IXmlSerializable, IEquatable[BeamNumber]): - # type: (number: int) - - """ - BeamNumber(number: int) - - BeamNumber(other: BeamNumber) - """ - def Equals(self, other): - # type: (self: BeamNumber, other: object) -> bool - - """ - Equals(self: BeamNumber, other: object) -> bool - - Equals(self: BeamNumber, other: BeamNumber) -> bool - """ - pass - - def GetHashCode(self): - # type: (self: BeamNumber) -> int - """ GetHashCode(self: BeamNumber) -> int """ - pass - - def GetSchema(self): - # type: (self: BeamNumber) -> XmlSchema - """ GetSchema(self: BeamNumber) -> XmlSchema """ - pass - - def ReadXml(self, reader): - # type: (self: BeamNumber, reader: XmlReader) - """ ReadXml(self: BeamNumber, reader: XmlReader) """ - pass - - def WriteXml(self, writer): - # type: (self: BeamNumber, writer: XmlWriter) - """ WriteXml(self: BeamNumber, writer: XmlWriter) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __int__(self, *args): #cannot find CLR method - """ __int__(bn: BeamNumber) -> int """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __long__(self, *args): #cannot find CLR method - """ __int__(bn: BeamNumber) -> int """ - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__[BeamNumber]() -> BeamNumber - - - - __new__(cls: type, number: int) - - __new__(cls: type, other: BeamNumber) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - IsValid = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamNumber) -> bool - """ Get: IsValid(self: BeamNumber) -> bool """ - - Number = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: BeamNumber) -> int - """ Get: Number(self: BeamNumber) -> int """ - - - NotABeamNumber = None - - -class BlockType(Enum, IComparable, IFormattable, IConvertible): - # type: (0), SHIELDING (1) - """ enum BlockType, values: APERTURE (0), SHIELDING (1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - APERTURE = None - SHIELDING = None - value__ = None - - -class CalculationType(Enum, IComparable, IFormattable, IConvertible): - # type: (6), PhotonIMRTOptimization (2), PhotonLeafMotions (4), PhotonSRSDose (1), PhotonVMATOptimization (3), PhotonVolumeDose (0), ProtonVolumeDose (5) - """ enum CalculationType, values: DVHEstimation (6), PhotonIMRTOptimization (2), PhotonLeafMotions (4), PhotonSRSDose (1), PhotonVMATOptimization (3), PhotonVolumeDose (0), ProtonVolumeDose (5) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - DVHEstimation = None - PhotonIMRTOptimization = None - PhotonLeafMotions = None - PhotonSRSDose = None - PhotonVMATOptimization = None - PhotonVolumeDose = None - ProtonVolumeDose = None - value__ = None - - -class ClosedLeavesMeetingPoint(Enum, IComparable, IFormattable, IConvertible): - # type: (0), ClosedLeavesMeetingPoint_BankTwo (1), ClosedLeavesMeetingPoint_Center (2) - """ enum ClosedLeavesMeetingPoint, values: ClosedLeavesMeetingPoint_BankOne (0), ClosedLeavesMeetingPoint_BankTwo (1), ClosedLeavesMeetingPoint_Center (2) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ClosedLeavesMeetingPoint_BankOne = None - ClosedLeavesMeetingPoint_BankTwo = None - ClosedLeavesMeetingPoint_Center = None - value__ = None - - -class LineProfile(object, IEnumerable[ProfilePoint], IEnumerable): - # type: (origin: VVector, step: VVector, data: Array[float]) - """ LineProfile(origin: VVector, step: VVector, data: Array[float]) """ - def GetEnumerator(self): - # type: (self: LineProfile) -> IEnumerator[ProfilePoint] - """ GetEnumerator(self: LineProfile) -> IEnumerator[ProfilePoint] """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[ProfilePoint](enumerable: IEnumerable[ProfilePoint], value: ProfilePoint) -> bool """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - @staticmethod # known case of __new__ - def __new__(self, origin, step, data): - """ __new__(cls: type, origin: VVector, step: VVector, data: Array[float]) """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: LineProfile) -> int - """ Get: Count(self: LineProfile) -> int """ - - - -class DoseProfile(LineProfile, IEnumerable[ProfilePoint], IEnumerable): - # type: (origin: VVector, step: VVector, data: Array[float], unit: DoseUnit) - """ DoseProfile(origin: VVector, step: VVector, data: Array[float], unit: DoseUnit) """ - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - @staticmethod # known case of __new__ - def __new__(self, origin, step, data, unit): - """ __new__(cls: type, origin: VVector, step: VVector, data: Array[float], unit: DoseUnit) """ - pass - - Unit = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DoseProfile) -> DoseUnit - """ Get: Unit(self: DoseProfile) -> DoseUnit """ - - - -class DoseValue(object, IXmlSerializable, IComparable[DoseValue], IEquatable[DoseValue]): - # type: (value: float, unitName: str) - - """ - DoseValue(value: float, unitName: str) - - DoseValue(value: float, unit: DoseUnit) - """ - def CompareTo(self, other): - # type: (self: DoseValue, other: DoseValue) -> int - """ CompareTo(self: DoseValue, other: DoseValue) -> int """ - pass - - def Equals(self, *__args): - # type: (self: DoseValue, obj: object) -> bool - - """ - Equals(self: DoseValue, obj: object) -> bool - - Equals(self: DoseValue, other: DoseValue) -> bool - - Equals(self: DoseValue, other: DoseValue, epsilon: float) -> bool - """ - pass - - def GetHashCode(self): - # type: (self: DoseValue) -> int - """ GetHashCode(self: DoseValue) -> int """ - pass - - def GetSchema(self): - # type: (self: DoseValue) -> XmlSchema - """ GetSchema(self: DoseValue) -> XmlSchema """ - pass - - @staticmethod - def IsAbsoluteDoseUnit(doseUnit): - # type: (doseUnit: DoseUnit) -> bool - """ IsAbsoluteDoseUnit(doseUnit: DoseUnit) -> bool """ - pass - - @staticmethod - def IsRelativeDoseUnit(doseUnit): - # type: (doseUnit: DoseUnit) -> bool - """ IsRelativeDoseUnit(doseUnit: DoseUnit) -> bool """ - pass - - def IsUndefined(self): - # type: (self: DoseValue) -> bool - """ IsUndefined(self: DoseValue) -> bool """ - pass - - def ReadXml(self, reader): - # type: (self: DoseValue, reader: XmlReader) - """ ReadXml(self: DoseValue, reader: XmlReader) """ - pass - - def ToString(self): - # type: (self: DoseValue) -> str - """ ToString(self: DoseValue) -> str """ - pass - - @staticmethod - def UndefinedDose(): - # type: () -> DoseValue - """ UndefinedDose() -> DoseValue """ - pass - - def WriteXml(self, writer): - # type: (self: DoseValue, writer: XmlWriter) - """ WriteXml(self: DoseValue, writer: XmlWriter) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/yx.__div__(y) <==> x/y """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*y """ - pass - - @staticmethod # known case of __new__ - def __new__(self, value, *__args): - """ - __new__[DoseValue]() -> DoseValue - - - - __new__(cls: type, value: float, unitName: str) - - __new__(cls: type, value: float, unit: DoseUnit) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __radd__(self, *args): #cannot find CLR method - """ __radd__(dv1: DoseValue, dv2: DoseValue) -> DoseValue """ - pass - - def __rdiv__(self, *args): #cannot find CLR method - """ __rdiv__(dv1: DoseValue, dv2: DoseValue) -> float """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ __rmul__(dbl: float, dv: DoseValue) -> DoseValue """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ __rsub__(dv1: DoseValue, dv2: DoseValue) -> DoseValue """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - Decimals = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DoseValue) -> int - """ Get: Decimals(self: DoseValue) -> int """ - - Dose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DoseValue) -> float - """ Get: Dose(self: DoseValue) -> float """ - - IsAbsoluteDoseValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DoseValue) -> bool - """ Get: IsAbsoluteDoseValue(self: DoseValue) -> bool """ - - IsRelativeDoseValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DoseValue) -> bool - """ Get: IsRelativeDoseValue(self: DoseValue) -> bool """ - - Unit = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DoseValue) -> DoseUnit - """ Get: Unit(self: DoseValue) -> DoseUnit """ - - UnitAsString = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DoseValue) -> str - """ Get: UnitAsString(self: DoseValue) -> str """ - - ValueAsString = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DoseValue) -> str - """ Get: ValueAsString(self: DoseValue) -> str """ - - - DoseUnit = None - Undefined = None - - -class DoseValueDisplayConfig(object): - # type: () - """ DoseValueDisplayConfig() """ - @staticmethod - def Decimals(unit): - # type: (unit: DoseUnit) -> int - """ Decimals(unit: DoseUnit) -> int """ - pass - - DisplaySettings = None - - -class DoseValuePresentation(Enum, IComparable, IFormattable, IConvertible): - # type: (1), Relative (0) - """ enum DoseValuePresentation, values: Absolute (1), Relative (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Absolute = None - Relative = None - value__ = None - - -class DosimeterUnit(Enum, IComparable, IFormattable, IConvertible): - # type: (2), MU (1), Null (0), Second (3) - """ enum DosimeterUnit, values: Minute (2), MU (1), Null (0), Second (3) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Minute = None - MU = None - Null = None - Second = None - value__ = None - - -class DRRCalculationParameters(object): - # type: () - - """ - DRRCalculationParameters() - - DRRCalculationParameters(drrSize: float) - - DRRCalculationParameters(drrSize: float, weight: float, ctFrom: float, ctTo: float) - - DRRCalculationParameters(drrSize: float, weight: float, ctFrom: float, ctTo: float, geoFrom: float, geoTo: float) - """ - def GetLayerParameters(self, index): - # type: (self: DRRCalculationParameters, index: int) -> SingleLayerParameters - """ GetLayerParameters(self: DRRCalculationParameters, index: int) -> SingleLayerParameters """ - pass - - def SetLayerParameters(self, index, weight, ctFrom, ctTo, geoFrom=None, geoTo=None): - # type: (self: DRRCalculationParameters, index: int, weight: float, ctFrom: float, ctTo: float)SetLayerParameters(self: DRRCalculationParameters, index: int, weight: float, ctFrom: float, ctTo: float, geoFrom: float, geoTo: float) - """ SetLayerParameters(self: DRRCalculationParameters, index: int, weight: float, ctFrom: float, ctTo: float)SetLayerParameters(self: DRRCalculationParameters, index: int, weight: float, ctFrom: float, ctTo: float, geoFrom: float, geoTo: float) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, drrSize=None, weight=None, ctFrom=None, ctTo=None, geoFrom=None, geoTo=None): - """ - __new__(cls: type) - - __new__(cls: type, drrSize: float) - - __new__(cls: type, drrSize: float, weight: float, ctFrom: float, ctTo: float) - - __new__(cls: type, drrSize: float, weight: float, ctFrom: float, ctTo: float, geoFrom: float, geoTo: float) - """ - pass - - DRRSize = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DRRCalculationParameters) -> float - - """ - Get: DRRSize(self: DRRCalculationParameters) -> float - - - - Set: DRRSize(self: DRRCalculationParameters) = value - """ - - FieldOutlines = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DRRCalculationParameters) -> bool - - """ - Get: FieldOutlines(self: DRRCalculationParameters) -> bool - - - - Set: FieldOutlines(self: DRRCalculationParameters) = value - """ - - StructureOutlines = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DRRCalculationParameters) -> bool - - """ - Get: StructureOutlines(self: DRRCalculationParameters) -> bool - - - - Set: StructureOutlines(self: DRRCalculationParameters) = value - """ - - - -class DVHEstimateType(Enum, IComparable, IFormattable, IConvertible): - # type: (1), Undefined (99), Upper (0) - """ enum DVHEstimateType, values: Lower (1), Undefined (99), Upper (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Lower = None - Undefined = None - Upper = None - value__ = None - - -class DVHPoint(object, IXmlSerializable): - # type: (dose: DoseValue, volume: float, volumeUnit: str) - """ DVHPoint(dose: DoseValue, volume: float, volumeUnit: str) """ - def GetSchema(self): - # type: (self: DVHPoint) -> XmlSchema - """ GetSchema(self: DVHPoint) -> XmlSchema """ - pass - - def ReadXml(self, reader): - # type: (self: DVHPoint, reader: XmlReader) - """ ReadXml(self: DVHPoint, reader: XmlReader) """ - pass - - def WriteXml(self, writer): - # type: (self: DVHPoint, writer: XmlWriter) - """ WriteXml(self: DVHPoint, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, dose, volume, volumeUnit): - """ - __new__[DVHPoint]() -> DVHPoint - - - - __new__(cls: type, dose: DoseValue, volume: float, volumeUnit: str) - """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - DoseValue = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHPoint) -> DoseValue - """ Get: DoseValue(self: DVHPoint) -> DoseValue """ - - Volume = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHPoint) -> float - """ Get: Volume(self: DVHPoint) -> float """ - - VolumeUnit = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: DVHPoint) -> str - """ Get: VolumeUnit(self: DVHPoint) -> str """ - - - -class ExternalBeamMachineParameters(object): - # type: (machineId: str, energyModeId: str, doseRate: int, techniqueId: str, primaryFluenceModeId: str) - """ ExternalBeamMachineParameters(machineId: str, energyModeId: str, doseRate: int, techniqueId: str, primaryFluenceModeId: str) """ - @staticmethod # known case of __new__ - def __new__(self, machineId, energyModeId, doseRate, techniqueId, primaryFluenceModeId): - """ __new__(cls: type, machineId: str, energyModeId: str, doseRate: int, techniqueId: str, primaryFluenceModeId: str) """ - pass - - DoseRate = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalBeamMachineParameters) -> int - - """ - Get: DoseRate(self: ExternalBeamMachineParameters) -> int - - - - Set: DoseRate(self: ExternalBeamMachineParameters) = value - """ - - EnergyModeId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalBeamMachineParameters) -> str - - """ - Get: EnergyModeId(self: ExternalBeamMachineParameters) -> str - - - - Set: EnergyModeId(self: ExternalBeamMachineParameters) = value - """ - - MachineId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalBeamMachineParameters) -> str - - """ - Get: MachineId(self: ExternalBeamMachineParameters) -> str - - - - Set: MachineId(self: ExternalBeamMachineParameters) = value - """ - - PrimaryFluenceModeId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalBeamMachineParameters) -> str - - """ - Get: PrimaryFluenceModeId(self: ExternalBeamMachineParameters) -> str - - - - Set: PrimaryFluenceModeId(self: ExternalBeamMachineParameters) = value - """ - - TechniqueId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ExternalBeamMachineParameters) -> str - - """ - Get: TechniqueId(self: ExternalBeamMachineParameters) -> str - - - - Set: TechniqueId(self: ExternalBeamMachineParameters) = value - """ - - - -class FitToStructureMargins(object): - # type: (x1: float, y1: float, x2: float, y2: float) - - """ - FitToStructureMargins(x1: float, y1: float, x2: float, y2: float) - - FitToStructureMargins(margin: float) - """ - def ToString(self): - # type: (self: FitToStructureMargins) -> str - """ ToString(self: FitToStructureMargins) -> str """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__[FitToStructureMargins]() -> FitToStructureMargins - - - - __new__(cls: type, x1: float, y1: float, x2: float, y2: float) - - __new__(cls: type, margin: float) - """ - pass - - Type = None - X1 = None - X2 = None - Y1 = None - Y2 = None - - -class FitToStructureMarginType(Enum, IComparable, IFormattable, IConvertible): - # type: (0), Elliptical (1) - """ enum FitToStructureMarginType, values: Circular (0), Elliptical (1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Circular = None - Elliptical = None - value__ = None - - -class Fluence(object): - # type: (fluenceMatrix: Array[Single], xOrigin: float, yOrigin: float) - - """ - Fluence(fluenceMatrix: Array[Single], xOrigin: float, yOrigin: float) - - Fluence(fluenceMatrix: Array[Single], xOrigin: float, yOrigin: float, mlcId: str) - """ - def GetPixels(self): - # type: (self: Fluence) -> Array[Single] - """ GetPixels(self: Fluence) -> Array[Single] """ - pass - - @staticmethod # known case of __new__ - def __new__(self, fluenceMatrix, xOrigin, yOrigin, mlcId=None): - """ - __new__(cls: type, fluenceMatrix: Array[Single], xOrigin: float, yOrigin: float) - - __new__(cls: type, fluenceMatrix: Array[Single], xOrigin: float, yOrigin: float, mlcId: str) - """ - pass - - MLCId = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Fluence) -> str - """ Get: MLCId(self: Fluence) -> str """ - - XOrigin = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Fluence) -> float - """ Get: XOrigin(self: Fluence) -> float """ - - XSizeMM = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Fluence) -> float - """ Get: XSizeMM(self: Fluence) -> float """ - - XSizePixel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Fluence) -> int - """ Get: XSizePixel(self: Fluence) -> int """ - - YOrigin = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Fluence) -> float - """ Get: YOrigin(self: Fluence) -> float """ - - YSizeMM = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Fluence) -> float - """ Get: YSizeMM(self: Fluence) -> float """ - - YSizePixel = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: Fluence) -> int - """ Get: YSizePixel(self: Fluence) -> int """ - - - MaxSizePixel = 1024 - - -class GantryDirection(Enum, IComparable, IFormattable, IConvertible): - # type: (1), CounterClockwise (2), None (0) - """ enum GantryDirection, values: Clockwise (1), CounterClockwise (2), None (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Clockwise = None - CounterClockwise = None - # None = None - value__ = None - - -class IDoseValueDisplaySettings: - # no doc - def Decimals(self, unit): - # type: (self: IDoseValueDisplaySettings, unit: DoseUnit) -> int - """ Decimals(self: IDoseValueDisplaySettings, unit: DoseUnit) -> int """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - -class ImageApprovalHistoryEntry(object): - # no doc - ApprovalDateTime = None - ApprovalStatus = None - StatusComment = None - UserDisplayName = None - UserId = None - - -class ImageApprovalStatus(Enum, IComparable, IFormattable, IConvertible): - # type: (3), Approved (2), Disposed (4), New (0), Reviewed (1) - """ enum ImageApprovalStatus, values: ActionRequired (3), Approved (2), Disposed (4), New (0), Reviewed (1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ActionRequired = None - Approved = None - Disposed = None - New = None - Reviewed = None - value__ = None - - -class ImageProfile(LineProfile, IEnumerable[ProfilePoint], IEnumerable): - # type: (origin: VVector, step: VVector, data: Array[float], unit: str) - """ ImageProfile(origin: VVector, step: VVector, data: Array[float], unit: str) """ - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - @staticmethod # known case of __new__ - def __new__(self, origin, step, data, unit): - """ __new__(cls: type, origin: VVector, step: VVector, data: Array[float], unit: str) """ - pass - - Unit = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ImageProfile) -> str - """ Get: Unit(self: ImageProfile) -> str """ - - - -class ImagingSetup(Enum, IComparable, IFormattable, IConvertible): - # type: (4), MV_MV_High_Quality (2), MV_MV_Low_Dose (3), MVCBCT_High_Quality (0), MVCBCT_Low_Dose (1) - """ enum ImagingSetup, values: kVCBCT (4), MV_MV_High_Quality (2), MV_MV_Low_Dose (3), MVCBCT_High_Quality (0), MVCBCT_Low_Dose (1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - kVCBCT = None - MVCBCT_High_Quality = None - MVCBCT_Low_Dose = None - MV_MV_High_Quality = None - MV_MV_Low_Dose = None - value__ = None - - -class IonBeamScanMode(Enum, IComparable, IFormattable, IConvertible): - # type: (4), Modulated (2), None (0), Uniform (1), Unknown (999), Wobbling (3) - """ enum IonBeamScanMode, values: Line (4), Modulated (2), None (0), Uniform (1), Unknown (999), Wobbling (3) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Line = None - Modulated = None - # None = None - Uniform = None - Unknown = None - value__ = None - Wobbling = None - - -class JawFitting(Enum, IComparable, IFormattable, IConvertible): - # type: (1), FitToStructure (2), None (0) - """ enum JawFitting, values: FitToRecommended (1), FitToStructure (2), None (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - FitToRecommended = None - FitToStructure = None - # None = None - value__ = None - - -class LateralSpreadingDeviceType(Enum, IComparable, IFormattable, IConvertible): - # type: (1), Scatterer (0) - """ enum LateralSpreadingDeviceType, values: Magnet (1), Scatterer (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Magnet = None - Scatterer = None - value__ = None - - -class LMCMSSOptions(object): - # type: (numberOfIterations: int) - """ LMCMSSOptions(numberOfIterations: int) """ - @staticmethod # known case of __new__ - def __new__(self, numberOfIterations): - """ __new__(cls: type, numberOfIterations: int) """ - pass - - NumberOfIterations = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: LMCMSSOptions) -> int - """ Get: NumberOfIterations(self: LMCMSSOptions) -> int """ - - - -class LMCVOptions(object): - # type: (fixedJaws: bool) - """ LMCVOptions(fixedJaws: bool) """ - @staticmethod # known case of __new__ - def __new__(self, fixedJaws): - """ __new__(cls: type, fixedJaws: bool) """ - pass - - FixedJaws = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: LMCVOptions) -> bool - """ Get: FixedJaws(self: LMCVOptions) -> bool """ - - - -class MeasureModifier(Enum, IComparable, IFormattable, IConvertible): - # type: (0), MeasureModifierAtMost (1), MeasureModifierNone (99), MeasureModifierTarget (2) - """ enum MeasureModifier, values: MeasureModifierAtLeast (0), MeasureModifierAtMost (1), MeasureModifierNone (99), MeasureModifierTarget (2) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - MeasureModifierAtLeast = None - MeasureModifierAtMost = None - MeasureModifierNone = None - MeasureModifierTarget = None - value__ = None - - -class MeasureType(Enum, IComparable, IFormattable, IConvertible): - # type: (0), MeasureTypeDQP_DXXX (4), MeasureTypeDQP_DXXXcc (5), MeasureTypeDQP_VXXX (2), MeasureTypeDQP_VXXXGy (3), MeasureTypeGradient (1), MeasureTypeNone (99) - """ enum MeasureType, values: MeasureTypeDoseConformity (0), MeasureTypeDQP_DXXX (4), MeasureTypeDQP_DXXXcc (5), MeasureTypeDQP_VXXX (2), MeasureTypeDQP_VXXXGy (3), MeasureTypeGradient (1), MeasureTypeNone (99) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - MeasureTypeDoseConformity = None - MeasureTypeDQP_DXXX = None - MeasureTypeDQP_DXXXcc = None - MeasureTypeDQP_VXXX = None - MeasureTypeDQP_VXXXGy = None - MeasureTypeGradient = None - MeasureTypeNone = None - value__ = None - - -class MetersetValue(object, IXmlSerializable): - # type: (value: float, unit: DosimeterUnit) - """ MetersetValue(value: float, unit: DosimeterUnit) """ - def GetSchema(self): - # type: (self: MetersetValue) -> XmlSchema - """ GetSchema(self: MetersetValue) -> XmlSchema """ - pass - - def ReadXml(self, reader): - # type: (self: MetersetValue, reader: XmlReader) - """ ReadXml(self: MetersetValue, reader: XmlReader) """ - pass - - def WriteXml(self, writer): - # type: (self: MetersetValue, writer: XmlWriter) - """ WriteXml(self: MetersetValue, writer: XmlWriter) """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, value, unit): - """ - __new__[MetersetValue]() -> MetersetValue - - - - __new__(cls: type, value: float, unit: DosimeterUnit) - """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Unit = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: MetersetValue) -> DosimeterUnit - """ Get: Unit(self: MetersetValue) -> DosimeterUnit """ - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: MetersetValue) -> float - """ Get: Value(self: MetersetValue) -> float """ - - - -class MLCPlanType(Enum, IComparable, IFormattable, IConvertible): - # type: (2), DoseDynamic (1), NotDefined (999), ProtonLayerStacking (4), Static (0), VMAT (3) - """ enum MLCPlanType, values: ArcDynamic (2), DoseDynamic (1), NotDefined (999), ProtonLayerStacking (4), Static (0), VMAT (3) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ArcDynamic = None - DoseDynamic = None - NotDefined = None - ProtonLayerStacking = None - Static = None - value__ = None - VMAT = None - - -class OpenLeavesMeetingPoint(Enum, IComparable, IFormattable, IConvertible): - # type: (0), OpenLeavesMeetingPoint_Middle (2), OpenLeavesMeetingPoint_Outside (1) - """ enum OpenLeavesMeetingPoint, values: OpenLeavesMeetingPoint_Inside (0), OpenLeavesMeetingPoint_Middle (2), OpenLeavesMeetingPoint_Outside (1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - OpenLeavesMeetingPoint_Inside = None - OpenLeavesMeetingPoint_Middle = None - OpenLeavesMeetingPoint_Outside = None - value__ = None - - -class OptimizationConvergenceOption(Enum, IComparable, IFormattable, IConvertible): - # type: (0), TerminateIfConverged (1) - """ enum OptimizationConvergenceOption, values: NoEarlyTermination (0), TerminateIfConverged (1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - NoEarlyTermination = None - TerminateIfConverged = None - value__ = None - - -class OptimizationIntermediateDoseOption(Enum, IComparable, IFormattable, IConvertible): - # type: (0), UseIntermediateDose (1) - """ enum OptimizationIntermediateDoseOption, values: NoIntermediateDose (0), UseIntermediateDose (1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - NoIntermediateDose = None - UseIntermediateDose = None - value__ = None - - -class OptimizationObjectiveOperator(Enum, IComparable, IFormattable, IConvertible): - # type: (2), Lower (1), None (99), Upper (0) - """ enum OptimizationObjectiveOperator, values: Exact (2), Lower (1), None (99), Upper (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Exact = None - Lower = None - # None = None - Upper = None - value__ = None - - -class OptimizationOption(Enum, IComparable, IFormattable, IConvertible): - # type: (1), ContinueOptimizationWithPlanDoseAsIntermediateDose (2), RestartOptimization (0) - """ enum OptimizationOption, values: ContinueOptimization (1), ContinueOptimizationWithPlanDoseAsIntermediateDose (2), RestartOptimization (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - ContinueOptimization = None - ContinueOptimizationWithPlanDoseAsIntermediateDose = None - RestartOptimization = None - value__ = None - - -class OptimizationOptionsBase(object): - # no doc - IntermediateDoseOption = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationOptionsBase) -> OptimizationIntermediateDoseOption - """ Get: IntermediateDoseOption(self: OptimizationOptionsBase) -> OptimizationIntermediateDoseOption """ - - MLC = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationOptionsBase) -> str - """ Get: MLC(self: OptimizationOptionsBase) -> str """ - - StartOption = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationOptionsBase) -> OptimizationOption - """ Get: StartOption(self: OptimizationOptionsBase) -> OptimizationOption """ - - - -class OptimizationOptionsIMRT(OptimizationOptionsBase): - # type: (maxIterations: int, initialState: OptimizationOption, numberOfStepsBeforeIntermediateDose: int, convergenceOption: OptimizationConvergenceOption, mlcId: str) - - """ - OptimizationOptionsIMRT(maxIterations: int, initialState: OptimizationOption, numberOfStepsBeforeIntermediateDose: int, convergenceOption: OptimizationConvergenceOption, mlcId: str) - - OptimizationOptionsIMRT(maxIterations: int, initialState: OptimizationOption, convergenceOption: OptimizationConvergenceOption, intermediateDoseOption: OptimizationIntermediateDoseOption, mlcId: str) - - OptimizationOptionsIMRT(maxIterations: int, initialState: OptimizationOption, convergenceOption: OptimizationConvergenceOption, mlcId: str) - """ - @staticmethod # known case of __new__ - def __new__(self, maxIterations, initialState, *__args): - """ - __new__(cls: type, maxIterations: int, initialState: OptimizationOption, numberOfStepsBeforeIntermediateDose: int, convergenceOption: OptimizationConvergenceOption, mlcId: str) - - __new__(cls: type, maxIterations: int, initialState: OptimizationOption, convergenceOption: OptimizationConvergenceOption, intermediateDoseOption: OptimizationIntermediateDoseOption, mlcId: str) - - __new__(cls: type, maxIterations: int, initialState: OptimizationOption, convergenceOption: OptimizationConvergenceOption, mlcId: str) - """ - pass - - ConvergenceOption = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationOptionsIMRT) -> OptimizationConvergenceOption - """ Get: ConvergenceOption(self: OptimizationOptionsIMRT) -> OptimizationConvergenceOption """ - - MaximumNumberOfIterations = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationOptionsIMRT) -> int - """ Get: MaximumNumberOfIterations(self: OptimizationOptionsIMRT) -> int """ - - NumberOfStepsBeforeIntermediateDose = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationOptionsIMRT) -> int - """ Get: NumberOfStepsBeforeIntermediateDose(self: OptimizationOptionsIMRT) -> int """ - - - -class OptimizationOptionsVMAT(OptimizationOptionsBase): - # type: (startOption: OptimizationOption, mlcId: str) - - """ - OptimizationOptionsVMAT(startOption: OptimizationOption, mlcId: str) - - OptimizationOptionsVMAT(intermediateDoseOption: OptimizationIntermediateDoseOption, mlcId: str) - - OptimizationOptionsVMAT(numberOfCycles: int, mlcId: str) - - OptimizationOptionsVMAT(options: OptimizationOptionsVMAT) - """ - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, startOption: OptimizationOption, mlcId: str) - - __new__(cls: type, intermediateDoseOption: OptimizationIntermediateDoseOption, mlcId: str) - - __new__(cls: type, numberOfCycles: int, mlcId: str) - - __new__(cls: type, startOption: OptimizationOption, intermediateDoseOption: OptimizationIntermediateDoseOption, numberOfCycles: int, mlcId: str) - - __new__(cls: type, options: OptimizationOptionsVMAT) - """ - pass - - NumberOfOptimizationCycles = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: OptimizationOptionsVMAT) -> int - """ Get: NumberOfOptimizationCycles(self: OptimizationOptionsVMAT) -> int """ - - - -class PatientOrientation(Enum, IComparable, IFormattable, IConvertible): - # type: (8), FeetFirstDecubitusRight (7), FeetFirstProne (6), FeetFirstSupine (5), HeadFirstDecubitusLeft (4), HeadFirstDecubitusRight (3), HeadFirstProne (2), HeadFirstSupine (1), NoOrientation (0), Sitting (9) - """ enum PatientOrientation, values: FeetFirstDecubitusLeft (8), FeetFirstDecubitusRight (7), FeetFirstProne (6), FeetFirstSupine (5), HeadFirstDecubitusLeft (4), HeadFirstDecubitusRight (3), HeadFirstProne (2), HeadFirstSupine (1), NoOrientation (0), Sitting (9) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - FeetFirstDecubitusLeft = None - FeetFirstDecubitusRight = None - FeetFirstProne = None - FeetFirstSupine = None - HeadFirstDecubitusLeft = None - HeadFirstDecubitusRight = None - HeadFirstProne = None - HeadFirstSupine = None - NoOrientation = None - Sitting = None - value__ = None - - -class PatientSupportType(Enum, IComparable, IFormattable, IConvertible): - # type: (1), Table (0) - """ enum PatientSupportType, values: Chair (1), Table (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Chair = None - Table = None - value__ = None - - -class PlanSetupApprovalStatus(Enum, IComparable, IFormattable, IConvertible): - # type: (6), CompletedEarly (5), ExternallyApproved (9), PlanningApproved (3), Rejected (0), Retired (7), Reviewed (2), TreatmentApproved (4), UnApproved (1), Unknown (999), UnPlannedTreatment (8) - """ enum PlanSetupApprovalStatus, values: Completed (6), CompletedEarly (5), ExternallyApproved (9), PlanningApproved (3), Rejected (0), Retired (7), Reviewed (2), TreatmentApproved (4), UnApproved (1), Unknown (999), UnPlannedTreatment (8) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Completed = None - CompletedEarly = None - ExternallyApproved = None - PlanningApproved = None - Rejected = None - Retired = None - Reviewed = None - TreatmentApproved = None - UnApproved = None - Unknown = None - UnPlannedTreatment = None - value__ = None - - -class PlanSumOperation(Enum, IComparable, IFormattable, IConvertible): - # type: (0), Subtraction (1), Undefined (-1) - """ enum PlanSumOperation, values: Addition (0), Subtraction (1), Undefined (-1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Addition = None - Subtraction = None - Undefined = None - value__ = None - - -class PlanType(Enum, IComparable, IFormattable, IConvertible): - # type: (3), ExternalBeam (0), ExternalBeam_IRREG (1), ExternalBeam_Proton (2) - """ enum PlanType, values: Brachy (3), ExternalBeam (0), ExternalBeam_IRREG (1), ExternalBeam_Proton (2) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Brachy = None - ExternalBeam = None - ExternalBeam_IRREG = None - ExternalBeam_Proton = None - value__ = None - - -class PlanUncertaintyType(Enum, IComparable, IFormattable, IConvertible): - # type: (3), IsocenterShiftUncertainty (2), RangeUncertainty (1), RobustOptimizationUncertainty (4), UncertaintyTypeNotDefined (0) - """ enum PlanUncertaintyType, values: BaselineShiftUncertainty (3), IsocenterShiftUncertainty (2), RangeUncertainty (1), RobustOptimizationUncertainty (4), UncertaintyTypeNotDefined (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - BaselineShiftUncertainty = None - IsocenterShiftUncertainty = None - RangeUncertainty = None - RobustOptimizationUncertainty = None - UncertaintyTypeNotDefined = None - value__ = None - - -class PrescriptionModifier(Enum, IComparable, IFormattable, IConvertible): - # type: (0), PrescriptionModifierAtMost (1), PrescriptionModifierDMax (20), PrescriptionModifierEUD (6), PrescriptionModifierIsodose (40), PrescriptionModifierMaxDose (3), PrescriptionModifierMaxDoseAtMost (10), PrescriptionModifierMeanDose (2), PrescriptionModifierMeanDoseAtLeast (7), PrescriptionModifierMeanDoseAtMost (8), PrescriptionModifierMidPoint (21), PrescriptionModifierMinDose (4), PrescriptionModifierMinDoseAtLeast (9), PrescriptionModifierNone (99), PrescriptionModifierRefPoint (5), PrescriptionModifierUser (22) - """ enum PrescriptionModifier, values: PrescriptionModifierAtLeast (0), PrescriptionModifierAtMost (1), PrescriptionModifierDMax (20), PrescriptionModifierEUD (6), PrescriptionModifierIsodose (40), PrescriptionModifierMaxDose (3), PrescriptionModifierMaxDoseAtMost (10), PrescriptionModifierMeanDose (2), PrescriptionModifierMeanDoseAtLeast (7), PrescriptionModifierMeanDoseAtMost (8), PrescriptionModifierMidPoint (21), PrescriptionModifierMinDose (4), PrescriptionModifierMinDoseAtLeast (9), PrescriptionModifierNone (99), PrescriptionModifierRefPoint (5), PrescriptionModifierUser (22) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - PrescriptionModifierAtLeast = None - PrescriptionModifierAtMost = None - PrescriptionModifierDMax = None - PrescriptionModifierEUD = None - PrescriptionModifierIsodose = None - PrescriptionModifierMaxDose = None - PrescriptionModifierMaxDoseAtMost = None - PrescriptionModifierMeanDose = None - PrescriptionModifierMeanDoseAtLeast = None - PrescriptionModifierMeanDoseAtMost = None - PrescriptionModifierMidPoint = None - PrescriptionModifierMinDose = None - PrescriptionModifierMinDoseAtLeast = None - PrescriptionModifierNone = None - PrescriptionModifierRefPoint = None - PrescriptionModifierUser = None - value__ = None - - -class PrescriptionType(Enum, IComparable, IFormattable, IConvertible): - # type: (1), PrescriptionTypeIsodose (2), PrescriptionTypeNone (99), PrescriptionTypeVolume (0) - """ enum PrescriptionType, values: PrescriptionTypeDepth (1), PrescriptionTypeIsodose (2), PrescriptionTypeNone (99), PrescriptionTypeVolume (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - PrescriptionTypeDepth = None - PrescriptionTypeIsodose = None - PrescriptionTypeNone = None - PrescriptionTypeVolume = None - value__ = None - - -class ProfilePoint(object): - # type: (position: VVector, value: float) - """ ProfilePoint(position: VVector, value: float) """ - @staticmethod # known case of __new__ - def __new__(self, position, value): - """ - __new__[ProfilePoint]() -> ProfilePoint - - - - __new__(cls: type, position: VVector, value: float) - """ - pass - - Position = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProfilePoint) -> VVector - """ Get: Position(self: ProfilePoint) -> VVector """ - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: ProfilePoint) -> float - """ Get: Value(self: ProfilePoint) -> float """ - - - -class RangeModulatorType(Enum, IComparable, IFormattable, IConvertible): - # type: (0), Whl_FixedWeights (1), Whl_ModWeights (2) - """ enum RangeModulatorType, values: Fixed (0), Whl_FixedWeights (1), Whl_ModWeights (2) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Fixed = None - value__ = None - Whl_FixedWeights = None - Whl_ModWeights = None - - -class RangeShifterType(Enum, IComparable, IFormattable, IConvertible): - # type: (0), Binary (1) - """ enum RangeShifterType, values: Analog (0), Binary (1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Analog = None - Binary = None - value__ = None - - -class RegistrationApprovalStatus(Enum, IComparable, IFormattable, IConvertible): - # type: (1), Retired (2), Reviewed (3), Unapproved (0) - """ enum RegistrationApprovalStatus, values: Approved (1), Retired (2), Reviewed (3), Unapproved (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Approved = None - Retired = None - Reviewed = None - Unapproved = None - value__ = None - - -class RendererStrings(Enum, IComparable, IFormattable, IConvertible): - # type: (20), BrachyFractions (11), Catheters (18), CumulativeDVH (13), DoseZRes (21), FinalSpotList (10), Isodoses (7), LengthUnit (6), NormalizationInvalid (12), OrientationLabelAnterior (2), OrientationLabelFeet (5), OrientationLabelHead (4), OrientationLabelLeft (0), OrientationLabelPosterior (3), OrientationLabelRight (1), PlanInTreatment (15), Seeds (19), WarningAddOns (8), WarningArc (9), WarningCAXOnly (14), WarningConcurrency (16), WarningPlanWeights (17) - """ enum RendererStrings, values: Applicators (20), BrachyFractions (11), Catheters (18), CumulativeDVH (13), DoseZRes (21), FinalSpotList (10), Isodoses (7), LengthUnit (6), NormalizationInvalid (12), OrientationLabelAnterior (2), OrientationLabelFeet (5), OrientationLabelHead (4), OrientationLabelLeft (0), OrientationLabelPosterior (3), OrientationLabelRight (1), PlanInTreatment (15), Seeds (19), WarningAddOns (8), WarningArc (9), WarningCAXOnly (14), WarningConcurrency (16), WarningPlanWeights (17) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Applicators = None - BrachyFractions = None - Catheters = None - CumulativeDVH = None - DoseZRes = None - FinalSpotList = None - Isodoses = None - LengthUnit = None - NormalizationInvalid = None - OrientationLabelAnterior = None - OrientationLabelFeet = None - OrientationLabelHead = None - OrientationLabelLeft = None - OrientationLabelPosterior = None - OrientationLabelRight = None - PlanInTreatment = None - Seeds = None - value__ = None - WarningAddOns = None - WarningArc = None - WarningCAXOnly = None - WarningConcurrency = None - WarningPlanWeights = None - - -class RTPrescriptionConstraintType(Enum, IComparable, IFormattable, IConvertible): - # type: (5), MaximumDose (1), MaximumDvhDose (3), MaximumMeanDose (4), MinimumDose (0), MinimumDvhDose (2) - """ enum RTPrescriptionConstraintType, values: FreeText (5), MaximumDose (1), MaximumDvhDose (3), MaximumMeanDose (4), MinimumDose (0), MinimumDvhDose (2) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - FreeText = None - MaximumDose = None - MaximumDvhDose = None - MaximumMeanDose = None - MinimumDose = None - MinimumDvhDose = None - value__ = None - - -class RTPrescriptionTargetType(Enum, IComparable, IFormattable, IConvertible): - # type: (1), Isocenter (2), IsodoseLine (3), Undefined (99), Volume (0) - """ enum RTPrescriptionTargetType, values: Depth (1), Isocenter (2), IsodoseLine (3), Undefined (99), Volume (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Depth = None - Isocenter = None - IsodoseLine = None - Undefined = None - value__ = None - Volume = None - - -class SegmentProfile(object, IEnumerable[SegmentProfilePoint], IEnumerable): - # type: (origin: VVector, step: VVector, data: BitArray) - """ SegmentProfile(origin: VVector, step: VVector, data: BitArray) """ - def GetEnumerator(self): - # type: (self: SegmentProfile) -> IEnumerator[SegmentProfilePoint] - """ GetEnumerator(self: SegmentProfile) -> IEnumerator[SegmentProfilePoint] """ - pass - - def __contains__(self, *args): #cannot find CLR method - """ __contains__[SegmentProfilePoint](enumerable: IEnumerable[SegmentProfilePoint], value: SegmentProfilePoint) -> bool """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - @staticmethod # known case of __new__ - def __new__(self, origin, step, data): - """ __new__(cls: type, origin: VVector, step: VVector, data: BitArray) """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Count = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SegmentProfile) -> int - """ Get: Count(self: SegmentProfile) -> int """ - - EdgeCoordinates = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SegmentProfile) -> IList[VVector] - """ Get: EdgeCoordinates(self: SegmentProfile) -> IList[VVector] """ - - - -class SegmentProfilePoint(object): - # type: (position: VVector, value: bool) - """ SegmentProfilePoint(position: VVector, value: bool) """ - @staticmethod # known case of __new__ - def __new__(self, position, value): - """ - __new__[SegmentProfilePoint]() -> SegmentProfilePoint - - - - __new__(cls: type, position: VVector, value: bool) - """ - pass - - Position = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SegmentProfilePoint) -> VVector - """ Get: Position(self: SegmentProfilePoint) -> VVector """ - - Value = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SegmentProfilePoint) -> bool - """ Get: Value(self: SegmentProfilePoint) -> bool """ - - - -class SeriesModality(Enum, IComparable, IFormattable, IConvertible): - # type: (0), MR (1), Other (8), PT (2), REG (7), RTDOSE (6), RTIMAGE (3), RTPLAN (5), RTSTRUCT (4) - """ enum SeriesModality, values: CT (0), MR (1), Other (8), PT (2), REG (7), RTDOSE (6), RTIMAGE (3), RTPLAN (5), RTSTRUCT (4) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - CT = None - MR = None - Other = None - PT = None - REG = None - RTDOSE = None - RTIMAGE = None - RTPLAN = None - RTSTRUCT = None - value__ = None - - -class SetupTechnique(Enum, IComparable, IFormattable, IConvertible): - # type: (4), FixedSSD (2), Isocentric (1), SkinApposition (5), TBI (3), Unknown (0) - """ enum SetupTechnique, values: BreastBridge (4), FixedSSD (2), Isocentric (1), SkinApposition (5), TBI (3), Unknown (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - BreastBridge = None - FixedSSD = None - Isocentric = None - SkinApposition = None - TBI = None - Unknown = None - value__ = None - - -class SingleLayerParameters(object): - # no doc - CTFrom = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SingleLayerParameters) -> float - - """ - Get: CTFrom(self: SingleLayerParameters) -> float - - - - Set: CTFrom(self: SingleLayerParameters) = value - """ - - CTTo = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SingleLayerParameters) -> float - - """ - Get: CTTo(self: SingleLayerParameters) -> float - - - - Set: CTTo(self: SingleLayerParameters) = value - """ - - GeoClipping = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SingleLayerParameters) -> bool - - """ - Get: GeoClipping(self: SingleLayerParameters) -> bool - - - - Set: GeoClipping(self: SingleLayerParameters) = value - """ - - GeoFrom = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SingleLayerParameters) -> float - - """ - Get: GeoFrom(self: SingleLayerParameters) -> float - - - - Set: GeoFrom(self: SingleLayerParameters) = value - """ - - GeoTo = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SingleLayerParameters) -> float - - """ - Get: GeoTo(self: SingleLayerParameters) -> float - - - - Set: GeoTo(self: SingleLayerParameters) = value - """ - - LayerOn = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SingleLayerParameters) -> bool - - """ - Get: LayerOn(self: SingleLayerParameters) -> bool - - - - Set: LayerOn(self: SingleLayerParameters) = value - """ - - Weight = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SingleLayerParameters) -> float - - """ - Get: Weight(self: SingleLayerParameters) -> float - - - - Set: Weight(self: SingleLayerParameters) = value - """ - - - -class SmartLMCOptions(object): - # type: (fixedFieldBorders: bool, jawTracking: bool) - """ SmartLMCOptions(fixedFieldBorders: bool, jawTracking: bool) """ - @staticmethod # known case of __new__ - def __new__(self, fixedFieldBorders, jawTracking): - """ __new__(cls: type, fixedFieldBorders: bool, jawTracking: bool) """ - pass - - FixedFieldBorders = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SmartLMCOptions) -> bool - """ Get: FixedFieldBorders(self: SmartLMCOptions) -> bool """ - - JawTracking = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: SmartLMCOptions) -> bool - """ Get: JawTracking(self: SmartLMCOptions) -> bool """ - - - -class StructureApprovalHistoryEntry(object): - # no doc - ApprovalDateTime = None - ApprovalStatus = None - StatusComment = None - UserDisplayName = None - UserId = None - - -class StructureApprovalStatus(Enum, IComparable, IFormattable, IConvertible): - # type: (1), Rejected (2), Reviewed (3), UnApproved (0) - """ enum StructureApprovalStatus, values: Approved (1), Rejected (2), Reviewed (3), UnApproved (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Approved = None - Rejected = None - Reviewed = None - UnApproved = None - value__ = None - - -class StructureCodeInfo(object, IXmlSerializable, IEquatable[StructureCodeInfo]): - # type: (codingScheme: str, code: str) - """ StructureCodeInfo(codingScheme: str, code: str) """ - def Equals(self, *__args): - # type: (self: StructureCodeInfo, obj: object) -> bool - - """ - Equals(self: StructureCodeInfo, obj: object) -> bool - - Equals(self: StructureCodeInfo, other: StructureCodeInfo) -> bool - """ - pass - - def GetHashCode(self): - # type: (self: StructureCodeInfo) -> int - """ GetHashCode(self: StructureCodeInfo) -> int """ - pass - - def GetSchema(self): - # type: (self: StructureCodeInfo) -> XmlSchema - """ GetSchema(self: StructureCodeInfo) -> XmlSchema """ - pass - - def ReadXml(self, reader): - # type: (self: StructureCodeInfo, reader: XmlReader) - """ ReadXml(self: StructureCodeInfo, reader: XmlReader) """ - pass - - def ToString(self): - # type: (self: StructureCodeInfo) -> str - """ ToString(self: StructureCodeInfo) -> str """ - pass - - def WriteXml(self, writer): - # type: (self: StructureCodeInfo, writer: XmlWriter) - """ WriteXml(self: StructureCodeInfo, writer: XmlWriter) """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, codingScheme, code): - """ - __new__[StructureCodeInfo]() -> StructureCodeInfo - - - - __new__(cls: type, codingScheme: str, code: str) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Code = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: StructureCodeInfo) -> str - """ Get: Code(self: StructureCodeInfo) -> str """ - - CodingScheme = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: StructureCodeInfo) -> str - """ Get: CodingScheme(self: StructureCodeInfo) -> str """ - - - -class StructureMarginGeometry(Enum, IComparable, IFormattable, IConvertible): - # type: (1), Outer (0) - """ enum StructureMarginGeometry, values: Inner (1), Outer (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Inner = None - Outer = None - value__ = None - - -class TreatmentSessionStatus(Enum, IComparable, IFormattable, IConvertible): - # type: (3), CompletedPartially (4), InActiveResume (6), InActiveTreat (5), Null (0), Resume (2), Treat (1) - """ enum TreatmentSessionStatus, values: Completed (3), CompletedPartially (4), InActiveResume (6), InActiveTreat (5), Null (0), Resume (2), Treat (1) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - Completed = None - CompletedPartially = None - InActiveResume = None - InActiveTreat = None - Null = None - Resume = None - Treat = None - value__ = None - - -class UserIdentity(object): - # type: (id: str, displayName: str) - """ UserIdentity(id: str, displayName: str) """ - @staticmethod # known case of __new__ - def __new__(self, id, displayName): - """ - __new__[UserIdentity]() -> UserIdentity - - - - __new__(cls: type, id: str, displayName: str) - """ - pass - - DisplayName = None - Id = None - - -class ValidationException(ApplicationException, ISerializable, _Exception): - # type: (reason: str) - """ ValidationException(reason: str) """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, reason): - """ __new__(cls: type, reason: str) """ - pass - - def __str__(self, *args): #cannot find CLR method - pass - - SerializeObjectState = None - - -class VolumePresentation(Enum, IComparable, IFormattable, IConvertible): - # type: (1), Relative (0) - """ enum VolumePresentation, values: AbsoluteCm3 (1), Relative (0) """ - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==yx.__eq__(y) <==> x==yx.__eq__(y) <==> x==y """ - pass - - def __format__(self, *args): #cannot find CLR method - """ __format__(formattable: IFormattable, format: str) -> str """ - pass - - def __ge__(self, *args): #cannot find CLR method - pass - - def __gt__(self, *args): #cannot find CLR method - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __le__(self, *args): #cannot find CLR method - pass - - def __lt__(self, *args): #cannot find CLR method - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - def __reduce_ex__(self, *args): #cannot find CLR method - pass - - def __str__(self, *args): #cannot find CLR method - pass - - AbsoluteCm3 = None - Relative = None - value__ = None - - -class VRect(object): - # type: (x1: T, y1: T, x2: T, y2: T) - """ VRect[T](x1: T, y1: T, x2: T, y2: T) """ - def Equals(self, *__args): - # type: (self: VRect[T], obj: object) -> bool - - """ - Equals(self: VRect[T], obj: object) -> bool - - Equals(self: VRect[T], other: VRect[T]) -> bool - """ - pass - - def GetHashCode(self): - # type: (self: VRect[T]) -> int - """ GetHashCode(self: VRect[T]) -> int """ - pass - - def ToString(self): - # type: (self: VRect[T]) -> str - """ ToString(self: VRect[T]) -> str """ - pass - - def __eq__(self, *args): #cannot find CLR method - """ x.__eq__(y) <==> x==y """ - pass - - @staticmethod # known case of __new__ - def __new__(self, x1, y1, x2, y2): - """ - __new__[VRect`1]() -> VRect[T] - - - - __new__(cls: type, x1: T, y1: T, x2: T, y2: T) - """ - pass - - def __ne__(self, *args): #cannot find CLR method - pass - - X1 = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: VRect[T]) -> T - """ Get: X1(self: VRect[T]) -> T """ - - X2 = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: VRect[T]) -> T - """ Get: X2(self: VRect[T]) -> T """ - - Y1 = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: VRect[T]) -> T - """ Get: Y1(self: VRect[T]) -> T """ - - Y2 = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: VRect[T]) -> T - """ Get: Y2(self: VRect[T]) -> T """ - - - -class VVector(object): - # type: (xi: float, yi: float, zi: float) - """ VVector(xi: float, yi: float, zi: float) """ - @staticmethod - def Distance(left, right): - # type: (left: VVector, right: VVector) -> float - """ Distance(left: VVector, right: VVector) -> float """ - pass - - def ScalarProduct(self, left): - # type: (self: VVector, left: VVector) -> float - """ ScalarProduct(self: VVector, left: VVector) -> float """ - pass - - def ScaleToUnitLength(self): - # type: (self: VVector) - """ ScaleToUnitLength(self: VVector) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+y """ - pass - - def __div__(self, *args): #cannot find CLR method - """ x.__div__(y) <==> x/y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __mul__(self, *args): #cannot find CLR method - """ x.__mul__(y) <==> x*y """ - pass - - @staticmethod # known case of __new__ - def __new__(self, xi, yi, zi): - """ - __new__[VVector]() -> VVector - - - - __new__(cls: type, xi: float, yi: float, zi: float) - """ - pass - - def __radd__(self, *args): #cannot find CLR method - """ __radd__(left: VVector, right: VVector) -> VVector """ - pass - - def __rmul__(self, *args): #cannot find CLR method - """ __rmul__(mul: float, val: VVector) -> VVector """ - pass - - def __rsub__(self, *args): #cannot find CLR method - """ __rsub__(left: VVector, right: VVector) -> VVector """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - def __sub__(self, *args): #cannot find CLR method - """ x.__sub__(y) <==> x-y """ - pass - - Length = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: VVector) -> float - """ Get: Length(self: VVector) -> float """ - - LengthSquared = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: VVector) -> float - """ Get: LengthSquared(self: VVector) -> float """ - - x = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: VVector) -> float - - """ - Get: x(self: VVector) -> float - - - - Set: x(self: VVector) = value - """ - - y = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: VVector) -> float - - """ - Get: y(self: VVector) -> float - - - - Set: y(self: VVector) = value - """ - - z = property(lambda self: object(), lambda self, v: None, lambda self: None) # default - # type: (self: VVector) -> float - - """ - Get: z(self: VVector) -> float - - - - Set: z(self: VVector) = value - """ - - - diff --git a/pyesapi/stubs/VMS/TPS/Common/Model/__init__.py b/pyesapi/stubs/VMS/TPS/Common/Model/__init__.py deleted file mode 100644 index dffaed2..0000000 --- a/pyesapi/stubs/VMS/TPS/Common/Model/__init__.py +++ /dev/null @@ -1,11 +0,0 @@ -# encoding: utf-8 -# module VMS.TPS.Common.Model calls itself Model -# from VMS.TPS.Common.Model.API, Version=1.0.300.11, Culture=neutral, PublicKeyToken=305b81e210ec4b89, VMS.TPS.Common.Model.Types, Version=1.0.300.11, Culture=neutral, PublicKeyToken=305b81e210ec4b89 -# by generator 1.145 -# no doc -# no imports - -# no functions -# no classes -# variables with complex values - diff --git a/pyesapi/stubs/VMS/TPS/Common/__init__.py b/pyesapi/stubs/VMS/TPS/Common/__init__.py deleted file mode 100644 index 071abda..0000000 --- a/pyesapi/stubs/VMS/TPS/Common/__init__.py +++ /dev/null @@ -1,11 +0,0 @@ -# encoding: utf-8 -# module VMS.TPS.Common calls itself Common -# from VMS.TPS.Common.Model.API, Version=1.0.300.11, Culture=neutral, PublicKeyToken=305b81e210ec4b89, VMS.TPS.Common.Model.Types, Version=1.0.300.11, Culture=neutral, PublicKeyToken=305b81e210ec4b89 -# by generator 1.145 -# no doc -# no imports - -# no functions -# no classes -# variables with complex values - diff --git a/pyesapi/stubs/VMS/TPS/__init__.py b/pyesapi/stubs/VMS/TPS/__init__.py deleted file mode 100644 index 210314e..0000000 --- a/pyesapi/stubs/VMS/TPS/__init__.py +++ /dev/null @@ -1,11 +0,0 @@ -# encoding: utf-8 -# module VMS.TPS calls itself TPS -# from VMS.TPS.Common.Model.API, Version=1.0.300.11, Culture=neutral, PublicKeyToken=305b81e210ec4b89, VMS.TPS.Common.Model.Types, Version=1.0.300.11, Culture=neutral, PublicKeyToken=305b81e210ec4b89 -# by generator 1.145 -# no doc -# no imports - -# no functions -# no classes -# variables with complex values - diff --git a/pyesapi/stubs/VMS/__init__.py b/pyesapi/stubs/VMS/__init__.py deleted file mode 100644 index c4cd722..0000000 --- a/pyesapi/stubs/VMS/__init__.py +++ /dev/null @@ -1,11 +0,0 @@ -# encoding: utf-8 -# module VMS -# from VMS.TPS.Common.Model.API, Version=1.0.300.11, Culture=neutral, PublicKeyToken=305b81e210ec4b89, VMS.TPS.Common.Model.Types, Version=1.0.300.11, Culture=neutral, PublicKeyToken=305b81e210ec4b89 -# by generator 1.145 -# no doc -# no imports - -# no functions -# no classes -# variables with complex values - diff --git a/pyesapi/stubs/clr.py b/pyesapi/stubs/clr.py deleted file mode 100644 index 3cab911..0000000 --- a/pyesapi/stubs/clr.py +++ /dev/null @@ -1,364 +0,0 @@ -# encoding: utf-8 -# module clr -# from (built-in) -# by generator 1.145 -# type: () -""" module() """ -# no imports - -# Variables with simple values - -IsDebug = False -IsMacOS = False -IsMono = False -IsNetCoreApp = False - -TargetFramework = '.NETFramework,Version=v4.5' - -# functions - -def accepts(*types, p_object=None): # real signature unknown; restored from __doc__ - # type: (*types: Array[object]) -> object - """ accepts(*types: Array[object]) -> object """ - return object() - -def AddReference(*args, **kwargs): # real signature unknown - """ - Adds a reference to a .NET assembly. Parameters can be an already loaded - Assembly object, a full assembly name, or a partial assembly name. After the - load the assemblies namespaces and top-level types will be available via - import Namespace. - """ - pass - -def AddReferenceByName(*args, **kwargs): # real signature unknown - """ - Adds a reference to a .NET assembly. Parameters are an assembly name. - After the load the assemblies namespaces and top-level types will be available via - import Namespace. - """ - pass - -def AddReferenceByPartialName(*args, **kwargs): # real signature unknown - """ - Adds a reference to a .NET assembly. Parameters are a partial assembly name. - After the load the assemblies namespaces and top-level types will be available via - import Namespace. - """ - pass - -def AddReferenceToFile(*args, **kwargs): # real signature unknown - """ - Adds a reference to a .NET assembly. One or more assembly names can - be provided. The assembly is searched for in the directories specified in - sys.path and dependencies will be loaded from sys.path as well. The assembly - name should be the filename on disk without a directory specifier and - optionally including the .EXE or .DLL extension. After the load the assemblies - namespaces and top-level types will be available via import Namespace. - """ - pass - -def AddReferenceToFileAndPath(*args, **kwargs): # real signature unknown - """ - Adds a reference to a .NET assembly. One or more assembly names can - be provided which are fully qualified names to the file on disk. The - directory is added to sys.path and AddReferenceToFile is then called. After the - load the assemblies namespaces and top-level types will be available via - import Namespace. - """ - pass - -def AddReferenceToTypeLibrary(rcw): # real signature unknown; restored from __doc__ - # type: (rcw: object)AddReferenceToTypeLibrary(typeLibGuid: Guid) - """ AddReferenceToTypeLibrary(rcw: object)AddReferenceToTypeLibrary(typeLibGuid: Guid) """ - pass - -def ClearProfilerData(): # real signature unknown; restored from __doc__ - # type: () - """ ClearProfilerData() """ - pass - -def CompileModules(assemblyName, **kwArgs, p_str=None, p_object=None, *args): # real signature unknown; NOTE: unreliably restored from __doc__ - # type: (assemblyName: str, **kwArgs: IDictionary[str, object], *filenames: Array[str]) - """ CompileModules(assemblyName: str, **kwArgs: IDictionary[str, object], *filenames: Array[str]) """ - pass - -def CompileSubclassTypes(assemblyName, *newTypes, p_object=None): # real signature unknown; restored from __doc__ - # type: (assemblyName: str, *newTypes: Array[object]) - """ CompileSubclassTypes(assemblyName: str, *newTypes: Array[object]) """ - pass - -def Convert(o, toType): # real signature unknown; restored from __doc__ - # type: (o: object, toType: Type) -> object - """ Convert(o: object, toType: Type) -> object """ - return object() - -def Deserialize(serializationFormat, data): # real signature unknown; restored from __doc__ - # type: (serializationFormat: str, data: str) -> object - """ Deserialize(serializationFormat: str, data: str) -> object """ - return object() - -def Dir(o): # real signature unknown; restored from __doc__ - # type: (o: object) -> list - """ Dir(o: object) -> list """ - return [] - -def DirClr(o): # real signature unknown; restored from __doc__ - # type: (o: object) -> list - """ DirClr(o: object) -> list """ - return [] - -def EnableProfiler(enable): # real signature unknown; restored from __doc__ - # type: (enable: bool) - """ EnableProfiler(enable: bool) """ - pass - -def GetBytes(*args, **kwargs): # real signature unknown - """ Converts a string to an array of bytesConverts maxCount of a string to an array of bytes """ - pass - -def GetClrType(type): # real signature unknown; restored from __doc__ - # type: (type: Type) -> Type - """ GetClrType(type: Type) -> Type """ - pass - -def GetCurrentRuntime(): # real signature unknown; restored from __doc__ - # type: () -> ScriptDomainManager - """ GetCurrentRuntime() -> ScriptDomainManager """ - pass - -def GetDynamicType(t): # real signature unknown; restored from __doc__ - # type: (t: Type) -> type - """ GetDynamicType(t: Type) -> type """ - return type(*(), **{}) - -def GetProfilerData(includeUnused): # real signature unknown; restored from __doc__ - # type: (includeUnused: bool) -> tuple - """ GetProfilerData(includeUnused: bool) -> tuple """ - return () - -def GetPythonType(t): # real signature unknown; restored from __doc__ - # type: (t: Type) -> type - """ GetPythonType(t: Type) -> type """ - return type(*(), **{}) - -def GetString(*args, **kwargs): # real signature unknown - """ Converts an array of bytes to a string.Converts maxCount of an array of bytes to a string """ - pass - -def GetSubclassedTypes(): # real signature unknown; restored from __doc__ - # type: () -> tuple - """ GetSubclassedTypes() -> tuple """ - return () - -def ImportExtensions(type): # real signature unknown; restored from __doc__ - # type: (type: type)ImportExtensions(namespace: namespace#) - """ ImportExtensions(type: type)ImportExtensions(namespace: namespace#) """ - pass - -def LoadAssemblyByName(*args, **kwargs): # real signature unknown - """ - Loads an assembly from the specified assembly name and returns the assembly - object. Namespaces or types in the assembly can be accessed directly from - the assembly object. - """ - pass - -def LoadAssemblyByPartialName(*args, **kwargs): # real signature unknown - """ - Loads an assembly from the specified partial assembly name and returns the - assembly object. Namespaces or types in the assembly can be accessed directly - from the assembly object. - """ - pass - -def LoadAssemblyFromFile(*args, **kwargs): # real signature unknown - """ - Loads an assembly from the specified filename and returns the assembly - object. Namespaces or types in the assembly can be accessed directly from - the assembly object. - """ - pass - -def LoadAssemblyFromFileWithPath(*args, **kwargs): # real signature unknown - """ - Adds a reference to a .NET assembly. Parameters are a full path to an. - assembly on disk. After the load the assemblies namespaces and top-level types - will be available via import Namespace. - """ - pass - -def LoadTypeLibrary(rcw): # real signature unknown; restored from __doc__ - # type: (rcw: object) -> ComTypeLibInfo - """ - LoadTypeLibrary(rcw: object) -> ComTypeLibInfo - LoadTypeLibrary(typeLibGuid: Guid) -> ComTypeLibInfo - """ - pass - -def returns(type): # real signature unknown; restored from __doc__ - # type: (type: object) -> object - """ returns(type: object) -> object """ - return object() - -def Self(): # real signature unknown; restored from __doc__ - # type: () -> object - """ Self() -> object """ - return object() - -def Serialize(self): # real signature unknown; restored from __doc__ - # type: (self: object) -> tuple - """ Serialize(self: object) -> tuple """ - return () - -def SetCommandDispatcher(dispatcher, Action=None): # real signature unknown; restored from __doc__ - # type: (dispatcher: Action[Action]) -> Action[Action] - """ SetCommandDispatcher(dispatcher: Action[Action]) -> Action[Action] """ - pass - -def Use(name): # real signature unknown; restored from __doc__ - # type: (name: str) -> object - """ - Use(name: str) -> object - Use(path: str, language: str) -> object - """ - return object() - -# classes - -class ArgChecker(object): - # type: (prms: Array[object]) - """ ArgChecker(prms: Array[object]) """ - def __call__(self, *args): #cannot find CLR method - """ x.__call__(...) <==> x(...) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, prms): - """ __new__(cls: type, prms: Array[object]) """ - pass - - -class StrongBox(object, IStrongBox): - # type: () - """ - StrongBox[T]() - StrongBox[T](value: T) - """ - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - @staticmethod # known case of __new__ - def __new__(self, value=None): - """ - __new__(cls: type) - __new__(cls: type, value: T) - """ - pass - - def __repr__(self, *args): #cannot find CLR method - """ __repr__(self: object) -> str """ - pass - - Value = None - - -Reference = StrongBox - - -class ReferencesList(List[Assembly], IList[Assembly], ICollection[Assembly], IEnumerable[Assembly], IEnumerable, IList, ICollection, IReadOnlyList[Assembly], IReadOnlyCollection[Assembly], ICodeFormattable): - # type: () - """ ReferencesList() """ - def Add(self, *__args): - # type: (self: ReferencesList, other: Assembly) - """ Add(self: ReferencesList, other: Assembly) """ - pass - - def __add__(self, *args): #cannot find CLR method - """ x.__add__(y) <==> x+yx.__add__(y) <==> x+y """ - pass - - def __getitem__(self, *args): #cannot find CLR method - """ x.__getitem__(y) <==> x[y] """ - pass - - def __init__(self, *args): #cannot find CLR method - """ x.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signaturex.__init__(...) initializes x; see x.__class__.__doc__ for signature """ - pass - - def __iter__(self, *args): #cannot find CLR method - """ __iter__(self: IEnumerable) -> object """ - pass - - def __repr__(self, context): - """ __repr__(self: ReferencesList) -> str """ - pass - - def __setitem__(self, *args): #cannot find CLR method - """ x.__setitem__(i, y) <==> x[i]= """ - pass - - -class ReturnChecker(object): - # type: (returnType: object) - """ ReturnChecker(returnType: object) """ - def __call__(self, *args): #cannot find CLR method - """ x.__call__(...) <==> x(...) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, returnType): - """ __new__(cls: type, returnType: object) """ - pass - - retType = None - - -class RuntimeArgChecker(PythonTypeSlot): - # type: (function: object, expectedArgs: Array[object]) - """ - RuntimeArgChecker(function: object, expectedArgs: Array[object]) - RuntimeArgChecker(instance: object, function: object, expectedArgs: Array[object]) - """ - def __call__(self, *args): #cannot find CLR method - """ x.__call__(...) <==> x(...)x.__call__(...) <==> x(...) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, function: object, expectedArgs: Array[object]) - __new__(cls: type, instance: object, function: object, expectedArgs: Array[object]) - """ - pass - - -class RuntimeReturnChecker(PythonTypeSlot): - # type: (function: object, expectedReturn: object) - """ - RuntimeReturnChecker(function: object, expectedReturn: object) - RuntimeReturnChecker(instance: object, function: object, expectedReturn: object) - """ - def GetAttribute(self, instance, owner): - # type: (self: RuntimeReturnChecker, instance: object, owner: object) -> object - """ GetAttribute(self: RuntimeReturnChecker, instance: object, owner: object) -> object """ - pass - - def __call__(self, *args): #cannot find CLR method - """ x.__call__(...) <==> x(...)x.__call__(...) <==> x(...) """ - pass - - @staticmethod # known case of __new__ - def __new__(self, *__args): - """ - __new__(cls: type, function: object, expectedReturn: object) - __new__(cls: type, instance: object, function: object, expectedReturn: object) - """ - pass - - -# variables with complex values - -References = None - diff --git a/pyesapi/stubs/pythoncom.py b/pyesapi/stubs/pythoncom.py deleted file mode 100644 index ed3314f..0000000 --- a/pyesapi/stubs/pythoncom.py +++ /dev/null @@ -1,2 +0,0 @@ -def CoInitialize(): - ... \ No newline at end of file diff --git a/stubgen/xml_to_stubs.py b/stubgen/dotnet_to_stubs.py similarity index 54% rename from stubgen/xml_to_stubs.py rename to stubgen/dotnet_to_stubs.py index a2a02b3..cb347d0 100644 --- a/stubgen/xml_to_stubs.py +++ b/stubgen/dotnet_to_stubs.py @@ -4,24 +4,14 @@ Generates Python type stubs (.pyi) from .NET XML documentation files Usage: - python xml_to_stubs.py [out # Handle malformed generic types like VRect{`0} -> VRect[T] - malformed_generic = re.match(r'([^{<]+)[{<](`+\d+)[}>]', csharp_type) - if malformed_generic: - base_name = malformed_generic.group(1).split('.')[-1] - param_ref = malformed_generic.group(2) - param_num = int(re.search(r'\d+', param_ref).group()) - param_name = 'T' if param_num == 0 else f'T{param_num + 1}' - return f'{base_name}[{param_name}]' - - # Handle full namespace generic types like VMS.TPS.Common.Model.Types.VRect{`0} - namespace_generic = re.match(r'(VMS\.TPS\.Common\.Model\.[^{<]+)[{<](`+\d+)[}>]', csharp_type) - if namespace_generic: - full_type = namespace_generic.group(1) - base_name = full_type.split('.')[-1] - param_ref = namespace_generic.group(2) - param_num = int(re.search(r'\d+', param_ref).group()) - param_name = 'T' if param_num == 0 else f'T{param_num + 1}' - return f'{base_name}[{param_name}]'er] + python dotnet_to_stubs.py [output_folder] + +Arguments: + library_folder: Folder containing XML documentation and DLL files (will be searched recursively) + output_folder: Output folder for generated stubs (default: stubs) + +Example: + python dotnet_to_stubs.py "C:\Program Files\Varian\RTM\18.0\esapi\API" stubs """ import os @@ -32,6 +22,66 @@ from typing import Dict, List, Set, Optional, Tuple from collections import defaultdict +try: + import clr + import System + HAS_PYTHONNET = True +except ImportError: + HAS_PYTHONNET = False + print("Warning: pythonnet not available. Type introspection will be limited.") + +def detect_pythonnet_conversions() -> Dict[str, str]: + """ + Detect which .NET types pythonnet automatically converts to Python types. + Returns a mapping of .NET type names to their Python equivalents. + """ + if not HAS_PYTHONNET: + return {} + + conversions = {} + + # Test basic types by creating instances and checking their Python types + test_cases = [ + ('System.String', 'hello'), + ('System.Boolean', True), + ('System.Int32', 42), + ('System.Int64', 42), + ('System.Double', 3.14), + ('System.Single', 3.14), + ('System.Byte', 255), + ] + + for net_type_name, test_value in test_cases: + try: + # Get the .NET type + net_type = getattr(System, net_type_name.replace('System.', '')) + + # Create an instance (this may get converted by pythonnet) + if net_type_name == 'System.String': + instance = System.String(test_value) + else: + instance = net_type(test_value) + + # Check what Python type we actually get + python_type = type(instance) + + if python_type == str: + conversions[net_type_name] = 'str' + elif python_type == bool: + conversions[net_type_name] = 'bool' + elif python_type == int: + conversions[net_type_name] = 'int' + elif python_type == float: + conversions[net_type_name] = 'float' + else: + # If it's still a .NET type, don't convert it in stubs + print(f"Type {net_type_name} remains as .NET type: {python_type}") + + except Exception as e: + print(f"Could not test {net_type_name}: {e}") + + return conversions + # Type mappings from C# to Python TYPE_MAPPINGS = { 'System.String': 'str', @@ -66,6 +116,370 @@ 'Array': 'Array', } +class DllTypeIntrospector: + """Uses pythonnet to introspect DLL types for accurate type information""" + + def __init__(self, dll_paths: List[str] = None): + self.dll_paths = dll_paths or [] + self.loaded_assemblies = {} + self.type_cache = {} + self.method_cache = {} + + # Detect what pythonnet actually converts + self.pythonnet_conversions = detect_pythonnet_conversions() if HAS_PYTHONNET else {} + + if HAS_PYTHONNET: + self._load_dlls() + + def _load_dlls(self): + """Load DLLs using pythonnet""" + if not HAS_PYTHONNET: + return + + for dll_path in self.dll_paths: + try: + clr.AddReference(str(dll_path)) + print(f"Loaded DLL: {dll_path}") + except Exception as e: + print(f"Failed to load {dll_path}: {e}") + continue + + def get_method_signature(self, class_full_name: str, method_name: str) -> Optional[Dict]: + """Get method signature information from the DLL""" + if not HAS_PYTHONNET: + return None + + cache_key = f"{class_full_name}.{method_name}" + if cache_key in self.method_cache: + return self.method_cache[cache_key] + + try: + # Try to import the type directly using pythonnet + namespace_parts = class_full_name.split('.') + if len(namespace_parts) < 2: + return None + + module_name = '.'.join(namespace_parts[:-1]) + class_name = namespace_parts[-1] + + # Import the namespace module + exec(f"import {module_name}") + namespace_module = eval(module_name) + + if not hasattr(namespace_module, class_name): + self.method_cache[cache_key] = None + return None + + type_obj = getattr(namespace_module, class_name) + clr_type = clr.GetClrType(type_obj) + + if not clr_type: + self.method_cache[cache_key] = None + return None + + signature = { + 'parameters': [], + 'return_type': 'Any' + } + + if method_name == '__init__': + # Get constructors + constructors = clr_type.GetConstructors() + constructor_sigs = [] + + for ctor in constructors: + ctor_sig = { + 'parameters': [], + 'return_type': 'None' + } + + parameters = ctor.GetParameters() + for param in parameters: + param_type = self._convert_net_type_to_python(param.ParameterType) + ctor_sig['parameters'].append({ + 'name': param.Name, + 'type': param_type + }) + + constructor_sigs.append(ctor_sig) + + result = {'constructors': constructor_sigs} + self.method_cache[cache_key] = result + return result + else: + # Get regular methods + methods = clr_type.GetMethods() + for method in methods: + if method.Name == method_name: + parameters = method.GetParameters() + for param in parameters: + param_type = self._convert_net_type_to_python(param.ParameterType) + signature['parameters'].append({ + 'name': param.Name, + 'type': param_type + }) + + # Get return type + return_type = self._convert_net_type_to_python(method.ReturnType) + signature['return_type'] = return_type + + self.method_cache[cache_key] = signature + return signature + + except Exception as e: + # Silently fail for now - we'll use XML fallback + pass + + self.method_cache[cache_key] = None + return None + + def _extract_method_signature(self, method_info) -> Optional[Dict]: + """Extract signature information from a method object""" + try: + signature = { + 'parameters': [], + 'return_type': 'Any' + } + + # Try to get parameter information + if hasattr(method_info, '__annotations__'): + annotations = method_info.__annotations__ + for param_name, param_type in annotations.items(): + if param_name != 'return': + signature['parameters'].append({ + 'name': param_name, + 'type': self._convert_net_type_to_python(param_type) + }) + + if 'return' in annotations: + signature['return_type'] = self._convert_net_type_to_python(annotations['return']) + + # Try to get from .NET reflection if available + if hasattr(method_info, 'GetParameters'): + params = method_info.GetParameters() + signature['parameters'] = [] + for param in params: + signature['parameters'].append({ + 'name': param.Name, + 'type': self._convert_net_type_to_python(param.ParameterType) + }) + + if hasattr(method_info, 'ReturnType'): + signature['return_type'] = self._convert_net_type_to_python(method_info.ReturnType) + + return signature + + except Exception: + return None + + def _convert_net_type_to_python(self, net_type) -> str: + """Convert .NET type to Python type string""" + if net_type is None: + return 'Any' + + # Get the full type name + if hasattr(net_type, 'FullName') and net_type.FullName: + type_name = net_type.FullName + elif hasattr(net_type, 'Name') and net_type.Name: + type_name = net_type.Name + else: + type_name = str(net_type) + + # First, check if pythonnet automatically converts this type + if type_name in self.pythonnet_conversions: + return self.pythonnet_conversions[type_name] + + # Handle types that we know pythonnet converts (fallback if detection failed) + known_conversions = { + # Basic types that pythonnet typically converts + 'System.String': 'str', + 'System.Boolean': 'bool', + 'System.Int32': 'int', + 'System.Int64': 'int', + 'System.Int16': 'int', + 'System.UInt32': 'int', + 'System.UInt64': 'int', + 'System.UInt16': 'int', + 'System.Byte': 'int', + 'System.SByte': 'int', + 'System.Double': 'float', + 'System.Single': 'float', + 'System.Decimal': 'float', + 'System.DateTime': 'datetime', + 'System.TimeSpan': 'timedelta', + 'System.Guid': 'str', + 'System.Void': 'None', + 'System.Object': 'Any', + + # Nullable types - these get converted to Optional + 'System.Nullable`1[System.Int32]': 'Optional[int]', + 'System.Nullable`1[System.Double]': 'Optional[float]', + 'System.Nullable`1[System.Boolean]': 'Optional[bool]', + 'System.Nullable`1[System.DateTime]': 'Optional[datetime]', + + # Collections - these typically stay as .NET types but we provide Python-like interfaces + 'System.Collections.Generic.IEnumerable': 'Iterable[Any]', + 'System.Collections.Generic.ICollection': 'Collection[Any]', + 'System.Collections.Generic.IList': 'List[Any]', + 'System.Collections.Generic.IDictionary': 'Dict[Any, Any]', + 'System.Array': 'Array[Any]', + } + + if type_name in known_conversions: + return known_conversions[type_name] + + # Handle arrays + if hasattr(net_type, 'IsArray') and net_type.IsArray: + element_type = net_type.GetElementType() + element_python_type = self._convert_net_type_to_python(element_type) + + # .NET Array is already multidimensional, so Array[float] can represent + # both 1D and multidimensional arrays of float + return f'Array[{element_python_type}]' + + # Handle generic types + if hasattr(net_type, 'IsGenericType') and net_type.IsGenericType: + generic_def = net_type.GetGenericTypeDefinition() + generic_args = net_type.GetGenericArguments() + + generic_def_name = generic_def.FullName if hasattr(generic_def, 'FullName') else str(generic_def) + + # Handle VRect specifically + if 'VRect' in generic_def_name: + if len(generic_args) > 0: + arg_type = self._convert_net_type_to_python(generic_args[0]) + return f'VRect[{arg_type}]' # Preserve the generic type parameter + return 'VRect' + + # Handle KeyValuePair + if 'KeyValuePair' in generic_def_name: + if len(generic_args) >= 2: + key_type = self._convert_net_type_to_python(generic_args[0]) + value_type = self._convert_net_type_to_python(generic_args[1]) + return f'KeyValuePair[{key_type}, {value_type}]' + return 'KeyValuePair[Any, Any]' + + # Handle IEnumerator + if 'IEnumerator' in generic_def_name: + if len(generic_args) > 0: + arg_type = self._convert_net_type_to_python(generic_args[0]) + return f'Iterable[{arg_type}]' + return 'Iterable[Any]' + + # Handle IReadOnlyCollection + if 'IReadOnlyCollection' in generic_def_name: + if len(generic_args) > 0: + arg_type = self._convert_net_type_to_python(generic_args[0]) + return f'Collections.Generic.IReadOnlyCollection[{arg_type}]' + return 'Collections.Generic.IReadOnlyCollection[Any]' + + # Handle ICollection + if 'ICollection' in generic_def_name and 'IReadOnlyCollection' not in generic_def_name: + if len(generic_args) > 0: + arg_type = self._convert_net_type_to_python(generic_args[0]) + return f'Collections.Generic.ICollection[{arg_type}]' + return 'Collections.Generic.ICollection[Any]' + + # Handle other VMS generic types + if generic_def_name and 'VMS.TPS.Common.Model' in generic_def_name: + # Extract just the class name from the generic definition + simple_name = generic_def_name.split('.')[-1].split('`')[0] # Remove `1 suffix + + # For specific VMS types that should preserve generic parameters + if simple_name in ['VRect', 'VVector'] and len(generic_args) > 0: + converted_args = [self._convert_net_type_to_python(arg) for arg in generic_args] + return f'{simple_name}[{", ".join(converted_args)}]' + + # For other VMS types, just return the simple name + return simple_name + + if 'List' in generic_def_name or 'IEnumerable' in generic_def_name: + if len(generic_args) > 0: + arg_type = self._convert_net_type_to_python(generic_args[0]) + return f'List[{arg_type}]' + return 'List[Any]' + elif 'Dictionary' in generic_def_name: + if len(generic_args) >= 2: + key_type = self._convert_net_type_to_python(generic_args[0]) + value_type = self._convert_net_type_to_python(generic_args[1]) + return f'Dict[{key_type}, {value_type}]' + return 'Dict[str, Any]' + elif 'Nullable' in generic_def_name: + if len(generic_args) > 0: + arg_type = self._convert_net_type_to_python(generic_args[0]) + return f'Optional[{arg_type}]' + + # Handle VMS types - these remain as .NET objects, so keep class names + if type_name and type_name.startswith('VMS.TPS.Common.Model'): + return type_name.split('.')[-1] + + # Handle System types + if type_name and type_name.startswith('System.'): + system_type = type_name.replace('System.', '') + return known_conversions.get(f'System.{system_type}', system_type) + + # For unknown types, extract the last part (class name) + # These are likely complex .NET types that don't get converted + if '.' in type_name: + return type_name.split('.')[-1] + + return type_name or 'Any' + + def get_property_type(self, class_full_name: str, property_name: str) -> Optional[str]: + """Get property type information from the DLL""" + if not HAS_PYTHONNET: + return None + + cache_key = f"{class_full_name}.{property_name}" + if cache_key in self.type_cache: + return self.type_cache[cache_key] + + try: + # Try to import the type directly using pythonnet + namespace_parts = class_full_name.split('.') + if len(namespace_parts) < 2: + return None + + module_name = '.'.join(namespace_parts[:-1]) + class_name = namespace_parts[-1] + + # Import the namespace module + exec(f"import {module_name}") + namespace_module = eval(module_name) + + if not hasattr(namespace_module, class_name): + self.type_cache[cache_key] = None + return None + + type_obj = getattr(namespace_module, class_name) + clr_type = clr.GetClrType(type_obj) + + if not clr_type: + self.type_cache[cache_key] = None + return None + + # Get property info + properties = clr_type.GetProperties() + for prop in properties: + if prop.Name == property_name: + prop_type = self._convert_net_type_to_python(prop.PropertyType) + self.type_cache[cache_key] = prop_type + return prop_type + + # Also check fields + fields = clr_type.GetFields() + for field in fields: + if field.Name == property_name: + field_type = self._convert_net_type_to_python(field.FieldType) + self.type_cache[cache_key] = field_type + return field_type + + except Exception: + pass + + self.type_cache[cache_key] = None + return None + class XmlApiElement: """Represents a .NET API element parsed from XML documentation""" @@ -194,19 +608,21 @@ def _parse_parameter_types(self, params_str: str) -> List[str]: if not params_str.strip(): return [] - # Handle generic types and nested commas - work with original curly braces + # Handle generic types, arrays, and nested commas params = [] current_param = "" bracket_depth = 0 for char in params_str + ',': # Add comma at end to process last param - if char in '<{': + if char in '<{[': bracket_depth += 1 current_param += char - elif char in '>}': + elif char in '>}]': bracket_depth -= 1 current_param += char elif char == ',' and bracket_depth == 0: + # Only split on comma if we're not inside brackets/braces + # This handles cases like System.Single[0:,0:] where the comma is part of array bounds if current_param.strip(): params.append(current_param.strip()) current_param = "" @@ -217,16 +633,86 @@ def _parse_parameter_types(self, params_str: str) -> List[str]: def _convert_csharp_type_to_python(self, csharp_type: str, preserve_net_types: bool = False) -> str: """Convert C# type to Python type""" - # Remove ref/out keywords + # If the type is already in Python format (from DLL introspector), don't convert it + if (csharp_type.startswith('Array[') or csharp_type.startswith('List[') or + csharp_type.startswith('Dict[') or csharp_type.startswith('Optional[') or + csharp_type.startswith('Iterable[') or csharp_type.startswith('KeyValuePair[') or + csharp_type.startswith('Collections.Generic.IReadOnlyCollection[') or + csharp_type.startswith('Collections.Generic.ICollection[')): + return csharp_type + + # Remove ref/out keywords and & or @ suffix (@ indicates reference parameters in XML) csharp_type = re.sub(r'\b(ref|out)\s+', '', csharp_type) + csharp_type = csharp_type.rstrip('&@') + + # More robust assembly-qualified cleanup for deeply nested generic types + # Handle patterns like [[TypeName, Assembly, Version=...]] -> [TypeName] + def clean_assembly_qualified(text): + """Recursively clean assembly-qualified type names in nested generics""" + # First, handle double brackets [[Type, Assembly...]] -> [Type] + double_bracket_pattern = r'\[\[([^\[\],]+)(?:,\s*[^\[\]]*?)\]\]' + text = re.sub(double_bracket_pattern, r'[\1]', text) + + # Then handle single brackets [Type, Assembly...] -> [Type] but only if it contains assembly info + # Look for the pattern: [TypeName, something with Version or Culture or PublicKeyToken] + single_bracket_assembly_pattern = r'\[([^,\[\]]+),\s*[^\[\]]*?(?:Version|Culture|PublicKeyToken)[^\[\]]*?\]' + text = re.sub(single_bracket_assembly_pattern, r'[\1]', text) + + return text + + csharp_type = clean_assembly_qualified(csharp_type) + + # Handle assembly-qualified names - remove everything after the comma + # Example: String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -> String + # But only do this AFTER cleaning nested brackets + if ', ' in csharp_type and 'Version=' in csharp_type: + csharp_type = csharp_type.split(', ')[0] # Handle curly braces in the entire string recursively while '{' in csharp_type and '}' in csharp_type: csharp_type = csharp_type.replace('{', '<').replace('}', '>') - # Handle C# generic type syntax with backticks (e.g., VRect`1 -> VRect[T]) - # Only match when backtick immediately follows the class name (not inside angle brackets) - if '`' in csharp_type and '<' not in csharp_type: + # Convert C# backtick generic syntax to angle bracket syntax for further processing + # Example: List`1[String] -> List + backtick_generic_pattern = r'([^`\[]+)`\d+\[([^\]]+)\]' + backtick_match = re.match(backtick_generic_pattern, csharp_type) + if backtick_match: + base_type = backtick_match.group(1) + args = backtick_match.group(2) + csharp_type = f'{base_type}<{args}>' + + # Handle .NET 2D array syntax like System.Single[0:,0:] -> System.Single with 2D array marker + # This pattern: Type[bounds] where bounds contains comma(s) indicates multidimensional array + array_bounds_match = re.match(r'([^[]+)\[([^\]]*:[^\]]*,.*?)\]', csharp_type) + if array_bounds_match: + base_type = array_bounds_match.group(1) + bounds = array_bounds_match.group(2) + # Count commas to determine dimensions (1 comma = 2D, 2 commas = 3D, etc.) + dimensions = bounds.count(',') + 1 + + # Convert the base type + python_base_type = self._convert_csharp_type_to_python(base_type, preserve_net_types=False) + + # .NET Array is already multidimensional, so Array[float] represents all dimensions + return f'Array[{python_base_type}]' + + # Handle C# generic type syntax with backticks + # The number after backtick indicates how many type parameters the generic type takes + + # Case 1: Backtick with square brackets (e.g., List`1[String] -> List) + if '`' in csharp_type and '[' in csharp_type and ']' in csharp_type: + # Convert backtick syntax to angle bracket syntax: List`1[String] -> List + backtick_match = re.match(r'([^`]+)`\d+(\[.+\])', csharp_type) + if backtick_match: + base_name = backtick_match.group(1) + type_args = backtick_match.group(2) # [String] or [String, Int32] + # Convert [String] to + angle_bracket_args = type_args.replace('[', '<').replace(']', '>') + csharp_type = f'{base_name}{angle_bracket_args}' + + # Case 2: Backtick without brackets (e.g., VRect`1 -> VRect[T]) + # Only match when backtick immediately follows the class name and there are no square brackets + elif '`' in csharp_type and '<' not in csharp_type and '[' not in csharp_type: match = re.match(r'([^`]+)`(\d+)', csharp_type) if match: base_name = match.group(1).split('.')[-1] # Get just the class name @@ -289,11 +775,32 @@ def _convert_csharp_type_to_python(self, csharp_type: str, preserve_net_types: b generic_args = match.group(2) # Convert collection types to Python equivalents - if base_type in ['System.Collections.Generic.List', 'System.Collections.Generic.IList', - 'System.Collections.Generic.ICollection', 'System.Collections.Generic.IEnumerable']: + # Handle specific collection types first (before generic handling) + if base_type in ['System.Collections.Generic.IReadOnlyCollection', 'Collections.Generic.IReadOnlyCollection']: + # Preserve IReadOnlyCollection as a more specific type with full namespace + arg_type = self._convert_csharp_type_to_python(generic_args, preserve_net_types) + # For VMS types, extract just the class name + if arg_type.startswith('VMS.TPS.Common.Model'): + arg_type = arg_type.split('.')[-1] + return f'Collections.Generic.IReadOnlyCollection[{arg_type}]' + elif base_type in ['System.Collections.Generic.ICollection', 'Collections.Generic.ICollection']: + # Preserve ICollection as a more specific type with full namespace arg_type = self._convert_csharp_type_to_python(generic_args, preserve_net_types) + # For VMS types, extract just the class name + if arg_type.startswith('VMS.TPS.Common.Model'): + arg_type = arg_type.split('.')[-1] + return f'Collections.Generic.ICollection[{arg_type}]' + elif base_type in ['System.Collections.Generic.List', 'System.Collections.Generic.IList', + 'System.Collections.Generic.IEnumerable', + 'Collections.Generic.List', 'Collections.Generic.IList', + 'Collections.Generic.IEnumerable']: + arg_type = self._convert_csharp_type_to_python(generic_args, preserve_net_types) + # For VMS types, extract just the class name + if arg_type.startswith('VMS.TPS.Common.Model'): + arg_type = arg_type.split('.')[-1] return f'List[{arg_type}]' - elif base_type in ['System.Collections.Generic.Dictionary', 'System.Collections.Generic.IDictionary']: + elif base_type in ['System.Collections.Generic.Dictionary', 'System.Collections.Generic.IDictionary', + 'Collections.Generic.Dictionary', 'Collections.Generic.IDictionary']: # Handle Dictionary args = self._parse_parameter_types(generic_args) if len(args) >= 2: @@ -366,10 +873,11 @@ def __repr__(self): class XmlDocumentationParser: """Parser for .NET XML documentation files""" - def __init__(self): + def __init__(self, dll_paths: List[str] = None): self.elements: List[XmlApiElement] = [] self.types_by_namespace: Dict[str, List[XmlApiElement]] = defaultdict(list) self.members_by_class: Dict[str, List[XmlApiElement]] = defaultdict(list) + self.dll_introspector = DllTypeIntrospector(dll_paths) if HAS_PYTHONNET else None def parse_xml_file(self, xml_file: str) -> List[XmlApiElement]: """Parse XML documentation file and extract API elements""" @@ -428,6 +936,14 @@ def parse_xml_file(self, xml_file: str) -> List[XmlApiElement]: # Store parameter info for methods without parsed parameters element.param_descriptions = xml_param_info + + # Enhance with DLL introspection if available + if self.dll_introspector: + self._enhance_method_with_dll_info(element) + + # Enhance property types with DLL introspection + elif element_type == 'P' and self.dll_introspector: + self._enhance_property_with_dll_info(element) elements.append(element) self.elements.append(element) @@ -441,6 +957,61 @@ def parse_xml_file(self, xml_file: str) -> List[XmlApiElement]: print(f"Error parsing XML file: {e}") return [] + def _enhance_method_with_dll_info(self, element: XmlApiElement): + """Enhance method element with DLL type information (only supplement missing types)""" + if not element.namespace or not element.class_name: + return + + class_full_name = f"{element.namespace}.{element.class_name}" + method_signature = self.dll_introspector.get_method_signature(class_full_name, element.name) + + if method_signature: + if element.name == '__init__' and 'constructors' in method_signature: + # Handle constructor overloads + constructors = method_signature['constructors'] + if constructors and len(constructors) > 0: + # Use the first constructor for now, could be enhanced to handle overloads + ctor_info = constructors[0] + if 'parameters' in ctor_info: + # Only update parameter types if they are "Any" (missing from XML) + for i, dll_param in enumerate(ctor_info['parameters']): + if i < len(element.parameters): + if element.parameters[i]['type'] == 'Any': + element.parameters[i]['type'] = dll_param['type'] + # Always update parameter names if DLL has better info + if dll_param['name'] and element.parameters[i]['name'].startswith('param'): + element.parameters[i]['name'] = dll_param['name'] + else: + # Regular method + if 'parameters' in method_signature: + # Only update parameter types if they are "Any" (missing from XML) + for i, dll_param in enumerate(method_signature['parameters']): + if i < len(element.parameters): + if element.parameters[i]['type'] == 'Any': + element.parameters[i]['type'] = dll_param['type'] + # Always update parameter names if DLL has better info + if dll_param['name'] and element.parameters[i]['name'].startswith('param'): + element.parameters[i]['name'] = dll_param['name'] + + # Always update return type if it's "Any" (missing from XML) + if 'return_type' in method_signature and element.return_type == 'Any': + raw_return_type = method_signature['return_type'] + # The DLL introspector already returns properly formatted Python types, + # so we don't need to convert them again + element.return_type = raw_return_type + + def _enhance_property_with_dll_info(self, element: XmlApiElement): + """Enhance property element with DLL type information (only supplement missing types)""" + if not element.namespace or not element.class_name: + return + + class_full_name = f"{element.namespace}.{element.class_name}" + prop_type = self.dll_introspector.get_property_type(class_full_name, element.name) + + # Only update property type if it's "Any" (missing from XML) + if prop_type and element.return_type == 'Any': + element.return_type = prop_type + def _clean_text(self, text: str) -> str: """Clean and format documentation text""" if not text: @@ -509,8 +1080,8 @@ def _generate_namespace_stubs(self, namespace: str, elements: List[XmlApiElement current_path = current_path / part current_path.mkdir(exist_ok=True) - # Create __init__.py - init_file = current_path / "__init__.py" + # Create __init__.pyi + init_file = current_path / "__init__.pyi" if not init_file.exists(): init_file.write_text("") @@ -550,6 +1121,8 @@ def _write_module_stub(self, file_path: Path, namespace: str, types: List[XmlApi f.write(f"from typing import {', '.join(imports)}\n") f.write("from datetime import datetime\n") f.write("from System import Array, Double, Single, Int32, Boolean, String\n") + f.write("from System.Collections.Generic import KeyValuePair\n") + f.write("from System import Collections\n") # Write TypeVar declarations for generic classes if has_generics: @@ -567,18 +1140,6 @@ def _write_module_stub(self, file_path: Path, namespace: str, types: List[XmlApi f.write("\n") - # Write common array type aliases - f.write("# Common array type aliases for Python.NET\n") - f.write("DoubleArray = Array[Double]\n") - f.write("SingleArray = Array[Single]\n") - f.write("IntArray = Array[Int32]\n") - f.write("BoolArray = Array[Boolean]\n") - f.write("StringArray = Array[String]\n") - f.write("DoubleJaggedArray = Array[DoubleArray]\n") - f.write("SingleJaggedArray = Array[SingleArray]\n") - - f.write("\n") - # Write each type for type_element in types: self._write_type_stub(f, type_element) @@ -720,7 +1281,12 @@ def _write_type_stub(self, f, type_element: XmlApiElement): if properties: f.write('\n Attributes:\n') for prop in properties: - prop_type = self._infer_property_type(prop.name, prop.summary) + # Use DLL-enhanced type if available, otherwise infer + if prop.return_type and prop.return_type != "Any": + prop_type = prop.return_type + else: + prop_type = self._infer_property_type(prop.name, prop.summary) + if prop.summary: f.write(f' {prop.name} ({prop_type}): {prop.summary}\n') else: @@ -768,8 +1334,12 @@ def _write_property_stub(self, f, prop: XmlApiElement): """Write a property stub""" # Skip individual comments since they're now in the class docstring - # Try to infer type from property name and summary - prop_type = self._infer_property_type(prop.name, prop.summary) + # Use DLL-enhanced type if available, otherwise infer from name/summary + if prop.return_type and prop.return_type != "Any": + prop_type = prop.return_type + else: + prop_type = self._infer_property_type(prop.name, prop.summary) + f.write(f' {prop.name}: {prop_type}\n') def _infer_property_type(self, prop_name: str, summary: str) -> str: @@ -829,8 +1399,11 @@ def _write_method_stub(self, f, method: XmlApiElement, is_overload: bool = False if param_str: param_str = ", " + param_str - # Infer return type from summary if available, otherwise use Any - return_type = self._infer_return_type_from_summary(method.summary) + # Use DLL-enhanced return type if available, otherwise infer from summary + if method.return_type and method.return_type != "Any": + return_type = method.return_type + else: + return_type = self._infer_return_type_from_summary(method.summary) # Add @overload decorator for constructors only when there are multiple overloads if method.name == '__init__': @@ -917,22 +1490,84 @@ def _infer_return_type_from_summary(self, summary: str) -> str: return "Any" +def find_xml_files(library_folder: str) -> List[str]: + """Find all XML documentation files in the library folder""" + xml_files = [] + library_path = Path(library_folder) + + if not library_path.exists(): + print(f"Warning: Library folder does not exist: {library_folder}") + return xml_files + + # Search for .xml files in the specified folder only + for xml_file in library_path.glob("*.xml"): + xml_files.append(str(xml_file)) + + return xml_files + +def find_dll_files(library_folder: str) -> List[str]: + """Find all DLL files in the library folder""" + dll_files = [] + library_path = Path(library_folder) + + if not library_path.exists(): + print(f"Warning: Library folder does not exist: {library_folder}") + return dll_files + + # Search for .dll files in the specified folder only + for dll_file in library_path.glob("*.dll"): + dll_files.append(str(dll_file)) + + return dll_files + def main(): if len(sys.argv) < 2: - print("Usage: python xml_to_stubs.py [output_folder]") + print("Usage: python dotnet_to_stubs.py [output_folder]") + print(" library_folder: Folder containing XML documentation and DLL files") + print(" output_folder: Output folder for generated stubs (default: stubs)") + print("Example: python dotnet_to_stubs.py C:/ARIA/bin stubs") sys.exit(1) - xml_file = sys.argv[1] - output_folder = sys.argv[2] if len(sys.argv) > 2 else "xml_stubs" + library_folder = sys.argv[1] + output_folder = sys.argv[2] if len(sys.argv) > 2 else "stubs" - # Parse XML documentation - parser = XmlDocumentationParser() - elements = parser.parse_xml_file(xml_file) + # Find XML and DLL files in the library folder + print(f"Scanning library folder: {library_folder}") + xml_files = find_xml_files(library_folder) + dll_files = find_dll_files(library_folder) - if not elements: - print("No elements found in XML file") + if not xml_files: + print(f"No XML documentation files found in {library_folder}") sys.exit(1) + print(f"Found {len(xml_files)} XML file(s):") + for xml_file in xml_files: + print(f" - {xml_file}") + + print(f"Found {len(dll_files)} DLL file(s):") + for dll_file in dll_files: + print(f" - {dll_file}") + + # Process each XML file + all_elements = [] + parser = XmlDocumentationParser(dll_files) + + for xml_file in xml_files: + print(f"\nProcessing XML file: {xml_file}") + elements = parser.parse_xml_file(xml_file) + + if elements: + all_elements.extend(elements) + print(f" Found {len(elements)} API elements") + else: + print(f" No elements found in {xml_file}") + + if not all_elements: + print("No elements found in any XML files") + sys.exit(1) + + print(f"\nTotal elements found: {len(all_elements)}") + # Generate stubs generator = XmlStubGenerator(parser) generator.generate_stubs(output_folder) From 12b2880c59bd7e247bd4ed2ff8c15fce7158b658 Mon Sep 17 00:00:00 2001 From: Michael Folkerts Date: Fri, 25 Jul 2025 06:14:00 -0700 Subject: [PATCH 3/7] re-written with claude, stubbing based on .net DLL introspection with additional documentation from XML. --- pyesapi/VMS/TPS/Common/Model/API/API.pyi | 28349 ---------------- .../Common/Model/API/AsyncPump/AsyncPump.pyi | 211 - .../Model/API/Calculation/Calculation.pyi | 39 - .../Model/Types/DoseValue/DoseValue.pyi | 18 - .../PlanValidationResultDetail.pyi | 18 - pyesapi/VMS/TPS/Common/Model/Types/Types.pyi | 2468 -- .../Common/Model/Types/VVector/VVector.pyi | 18 - pyesapi/VMS/TPS/Version/Version.pyi | 29 - pyesapi/__init__.py | 6 +- .../Microsoft/Win32/__init__.py} | 0 pyesapi/stubs/Microsoft/Win32/__init__.pyi | 267 + .../Microsoft/__init__.py} | 0 .../Python/Runtime/__init__.py} | 0 pyesapi/stubs/Python/Runtime/__init__.pyi | 38 + .../__init__.pyi => stubs/Python/__init__.py} | 0 .../System/Collections/__init__.py} | 0 pyesapi/stubs/System/Collections/__init__.pyi | 289 + .../System/ComponentModel/__init__.py} | 0 .../stubs/System/ComponentModel/__init__.pyi | 59 + .../System/Globalization/__init__.py} | 0 .../stubs/System/Globalization/__init__.pyi | 270 + .../System/IO/Compression/__init__.py} | 0 .../stubs/System/IO/Compression/__init__.pyi | 14 + .../System/IO/__init__.py} | 0 pyesapi/stubs/System/IO/__init__.pyi | 47 + .../System/Net/Mime/__init__.py} | 0 pyesapi/stubs/System/Net/Mime/__init__.pyi | 59 + .../System/Net/__init__.py} | 0 .../System/Reflection/__init__.py} | 0 pyesapi/stubs/System/Reflection/__init__.pyi | 1075 + .../WindowsRuntime/__init__.py} | 0 .../WindowsRuntime/__init__.pyi | 27 + .../Runtime/InteropServices/__init__.py} | 0 .../Runtime/InteropServices/__init__.pyi | 102 + .../System/Runtime/Serialization/__init__.py} | 0 .../System/Runtime/Serialization/__init__.pyi | 262 + .../System/Runtime/__init__.py} | 0 .../System/Text/__init__.py} | 0 pyesapi/stubs/System/Text/__init__.pyi | 370 + .../System/Threading/__init__.py} | 0 pyesapi/stubs/System/Threading/__init__.pyi | 132 + .../System/Xml/Schema/__init__.py} | 0 pyesapi/stubs/System/Xml/Schema/__init__.pyi | 260 + .../System/Xml/__init__.py} | 0 pyesapi/stubs/System/Xml/__init__.pyi | 1073 + .../__init__.pyi => stubs/System/__init__.py} | 0 pyesapi/stubs/System/__init__.pyi | 2564 ++ .../VMS/TPS/Common/Model/API/__init__.py} | 0 .../VMS/TPS/Common/Model/API/__init__.pyi | 15547 +++++++++ .../VMS/TPS/Common/Model/Types/__init__.py} | 0 .../VMS/TPS/Common/Model/Types/__init__.pyi | 3091 ++ .../VMS/TPS/Common/Model/__init__.py} | 0 .../VMS/TPS/Common/__init__.py} | 0 .../VMS/TPS/Version/__init__.py} | 0 pyesapi/stubs/VMS/TPS/Version/__init__.pyi | 46 + .../py.typed => stubs/VMS/TPS/__init__.py} | 0 pyesapi/stubs/VMS/__init__.py | 0 pyesapi/stubs/py.typed | 0 stubgen/dotnet_stubs.py | 1891 ++ stubgen/dotnet_to_stubs.py | 1576 - 60 files changed, 27485 insertions(+), 32730 deletions(-) delete mode 100644 pyesapi/VMS/TPS/Common/Model/API/API.pyi delete mode 100644 pyesapi/VMS/TPS/Common/Model/API/AsyncPump/AsyncPump.pyi delete mode 100644 pyesapi/VMS/TPS/Common/Model/API/Calculation/Calculation.pyi delete mode 100644 pyesapi/VMS/TPS/Common/Model/Types/DoseValue/DoseValue.pyi delete mode 100644 pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/PlanValidationResultDetail.pyi delete mode 100644 pyesapi/VMS/TPS/Common/Model/Types/Types.pyi delete mode 100644 pyesapi/VMS/TPS/Common/Model/Types/VVector/VVector.pyi delete mode 100644 pyesapi/VMS/TPS/Version/Version.pyi rename pyesapi/{VMS/TPS/Common/Model/API/AsyncPump/__init__.pyi => stubs/Microsoft/Win32/__init__.py} (100%) create mode 100644 pyesapi/stubs/Microsoft/Win32/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/API/Calculation/__init__.pyi => stubs/Microsoft/__init__.py} (100%) rename pyesapi/{VMS/TPS/Common/Model/API/ControlPointCollection/__init__.pyi => stubs/Python/Runtime/__init__.py} (100%) create mode 100644 pyesapi/stubs/Python/Runtime/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/API/IonControlPointCollection/__init__.pyi => stubs/Python/__init__.py} (100%) rename pyesapi/{VMS/TPS/Common/Model/API/IonControlPointPairCollection/__init__.pyi => stubs/System/Collections/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/Collections/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/API/IonSpotCollection/__init__.pyi => stubs/System/ComponentModel/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/ComponentModel/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/API/IonSpotParametersCollection/__init__.pyi => stubs/System/Globalization/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/Globalization/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/API/StructureCodeDictionary/__init__.pyi => stubs/System/IO/Compression/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/IO/Compression/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/API/__init__.pyi => stubs/System/IO/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/IO/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/Types/DoseValue/__init__.pyi => stubs/System/Net/Mime/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/Net/Mime/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/Types/DoseValueDisplayConfig/__init__.pyi => stubs/System/Net/__init__.py} (100%) rename pyesapi/{VMS/TPS/Common/Model/Types/LineProfile/__init__.pyi => stubs/System/Reflection/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/Reflection/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/Types/PlanValidationResultDetail/__init__.pyi => stubs/System/Runtime/InteropServices/WindowsRuntime/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/Runtime/InteropServices/WindowsRuntime/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/Types/SegmentProfile/__init__.pyi => stubs/System/Runtime/InteropServices/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/Runtime/InteropServices/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/Types/__init__.pyi => stubs/System/Runtime/Serialization/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/Runtime/Serialization/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/__init__.pyi => stubs/System/Runtime/__init__.py} (100%) rename pyesapi/{VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/__init__.pyi => stubs/System/Text/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/Text/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/__init__.pyi => stubs/System/Threading/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/Threading/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/Types/VVector/Item(VMS/__init__.pyi => stubs/System/Xml/Schema/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/Xml/Schema/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/Types/VVector/__init__.pyi => stubs/System/Xml/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/Xml/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/Types/__init__.pyi => stubs/System/__init__.py} (100%) create mode 100644 pyesapi/stubs/System/__init__.pyi rename pyesapi/{VMS/TPS/Common/Model/__init__.pyi => stubs/VMS/TPS/Common/Model/API/__init__.py} (100%) create mode 100644 pyesapi/stubs/VMS/TPS/Common/Model/API/__init__.pyi rename pyesapi/{VMS/TPS/Common/__init__.pyi => stubs/VMS/TPS/Common/Model/Types/__init__.py} (100%) create mode 100644 pyesapi/stubs/VMS/TPS/Common/Model/Types/__init__.pyi rename pyesapi/{VMS/TPS/Version/__init__.pyi => stubs/VMS/TPS/Common/Model/__init__.py} (100%) rename pyesapi/{VMS/TPS/__init__.pyi => stubs/VMS/TPS/Common/__init__.py} (100%) rename pyesapi/{VMS/__init__.pyi => stubs/VMS/TPS/Version/__init__.py} (100%) create mode 100644 pyesapi/stubs/VMS/TPS/Version/__init__.pyi rename pyesapi/{VMS/py.typed => stubs/VMS/TPS/__init__.py} (100%) create mode 100644 pyesapi/stubs/VMS/__init__.py create mode 100644 pyesapi/stubs/py.typed create mode 100644 stubgen/dotnet_stubs.py delete mode 100644 stubgen/dotnet_to_stubs.py diff --git a/pyesapi/VMS/TPS/Common/Model/API/API.pyi b/pyesapi/VMS/TPS/Common/Model/API/API.pyi deleted file mode 100644 index 5d3dde5..0000000 --- a/pyesapi/VMS/TPS/Common/Model/API/API.pyi +++ /dev/null @@ -1,28349 +0,0 @@ -""" -Type stubs for VMS.TPS.Common.Model.API -Generated from .NET XML documentation -""" - -from typing import Any, List, Optional, Union, Dict, Iterable, overload -from datetime import datetime -from System import Array, Double, Single, Int32, Boolean, String -from System.Collections.Generic import KeyValuePair -from System import Collections - -# Type imports -from ..Types.Types import AxisAlignedMargins -from ..Types.Types import BrachyTreatmentTechniqueType -from ..Types.Types import CalculationType -from ..Types.Types import ClosedLeavesMeetingPoint -from ..Types.Types import DRRCalculationParameters -from ..Types.Types import DoseValue -from ..Types.Types import DoseValuePresentation -from ..Types.Types import ExternalBeamMachineParameters -from ..Types.Types import FitToStructureMargins -from ..Types.Types import Fluence -from ..Types.Types import GantryDirection -from ..Types.Types import ImagingBeamSetupParameters -from ..Types.Types import IonPlanNormalizationParameters -from ..Types.Types import IonPlanOptimizationMode -from ..Types.Types import JawFitting -from ..Types.Types import LMCMSSOptions -from ..Types.Types import LMCVOptions -from ..Types.Types import LogSeverity -from ..Types.Types import OpenLeavesMeetingPoint -from ..Types.Types import OptimizationObjectiveOperator -from ..Types.Types import OptimizationOption -from ..Types.Types import OptimizationOptionsIMPT -from ..Types.Types import OptimizationOptionsIMRT -from ..Types.Types import OptimizationOptionsVMAT -from ..Types.Types import PatientOrientation -from ..Types.Types import PlanSumOperation -from ..Types.Types import PlanUncertaintyType -from ..Types.Types import ProtonBeamMachineParameters -from ..Types.Types import RailPosition -from ..Types.Types import SmartLMCOptions -from ..Types.Types import StructureCodeInfo -from ..Types.Types import VRect -from ..Types.Types import VVector -from ..Types.Types import VolumePresentation - -class AddOn: - """ - Represents an add-on, which is a beam modifying device that is inserted into a beam in an accessory slot of the external beam machine. An add-on is used to shape the beam or modulate its intensity or both. Add-ons are blocks, MLCs, wedges, compensators, applicators, a tray, and other devices or materials that can be fixed to a tray to be mounted into an accessory slot. - - Attributes: - CreationDateTime (Optional[datetime]): The date when this object was created. - CreationDateTime (Optional[datetime]): The date when this object was created. - """ - def __init__(self) -> None: ... - - CreationDateTime: Optional[datetime] - - CreationDateTime: Optional[datetime] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class AddOnMaterial: - """ - Add-on material describes the dosimetric and physical properties of the metal alloy or other substance used to create the add-on. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ApplicationPackage: - """ - Presents the application package information in the system. Note: not all methods are necessarily Published at the moment. - - Attributes: - ApprovalStatus (ApplicationScriptApprovalStatus): The status of the application package. Possible values are defined by a lookup RT_APP_EXTENSION_STATUS. - Description (str): Description of functionality provided by the package. - ExpirationDate (Optional[datetime]): An optional expiration date of the package. The package cannot be executed after expiration date. The date is presented in UTC. - PackageId (str): Unique Package ID. - PackageName (str): The full name of the package. - PackageVersion (str): The version number of the package. - PublisherData (str): Optional JSON data that can be used by package internally, e.g. customer key. - PublisherName (str): The name of the organization or author that created the package. This is a free text that can be set by the approver. - ApprovalStatus (ApplicationScriptApprovalStatus): The status of the application package. Possible values are defined by a lookup RT_APP_EXTENSION_STATUS. - Description (str): Description of functionality provided by the package. - ExpirationDate (Optional[datetime]): An optional expiration date of the package. The package cannot be executed after expiration date. The date is presented in UTC. - PackageId (str): Unique Package ID. - PackageName (str): The full name of the package. - PackageVersion (str): The version number of the package. - PublisherData (str): Optional JSON data that can be used by package internally, e.g. customer key. - PublisherName (str): The name of the organization or author that created the package. This is a free text that can be set by the approver. - """ - def __init__(self) -> None: ... - - ApprovalStatus: ApplicationScriptApprovalStatus - - Description: str - - ExpirationDate: Optional[datetime] - - PackageId: str - - PackageName: str - - PackageVersion: str - - PublisherData: str - - PublisherName: str - - ApprovalStatus: ApplicationScriptApprovalStatus - - Description: str - - ExpirationDate: Optional[datetime] - - PackageId: str - - PackageName: str - - PackageVersion: str - - PublisherData: str - - PublisherName: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ApplicationScript: - """ - Presents the application script information in the system. The location of the script file is not stored in the system. - - Attributes: - ApprovalStatus (ApplicationScriptApprovalStatus): The status of the script. - ApprovalStatusDisplayText (str): The display text of the approval status. - AssemblyName (Reflection.AssemblyName): The full name of the script assembly. - ExpirationDate (Optional[datetime]): An optional expiration date of the script. The script cannot be executed after expiration date. The date is presented in UTC. - IsReadOnlyScript (bool): Returns true if the script is intended only to read patient data. - IsWriteableScript (bool): Returns true if the script is intended to modify persistent data. - PublisherName (str): The name of the organization or author that created the script. This is a free text that can be set by the approver. - ScriptType (ApplicationScriptType): The type of the application script. - StatusDate (Optional[datetime]): A timestamp of the last approval status modification. - StatusUserIdentity (UserIdentity): The identity of the user who last modified the approval status. - ApprovalStatus (ApplicationScriptApprovalStatus): The status of the script. - ApprovalStatusDisplayText (str): The display text of the approval status. - AssemblyName (Reflection.AssemblyName): The full name of the script assembly. - ExpirationDate (Optional[datetime]): An optional expiration date of the script. The script cannot be executed after expiration date. The date is presented in UTC. - IsReadOnlyScript (bool): Returns true if the script is intended only to read patient data. - IsWriteableScript (bool): Returns true if the script is intended to modify persistent data. - PublisherName (str): The name of the organization or author that created the script. This is a free text that can be set by the approver. - ScriptType (ApplicationScriptType): The type of the application script. - StatusDate (Optional[datetime]): A timestamp of the last approval status modification. - StatusUserIdentity (UserIdentity): The identity of the user who last modified the approval status. - """ - def __init__(self) -> None: ... - - ApprovalStatus: ApplicationScriptApprovalStatus - - ApprovalStatusDisplayText: str - - AssemblyName: Reflection.AssemblyName - - ExpirationDate: Optional[datetime] - - IsReadOnlyScript: bool - - IsWriteableScript: bool - - PublisherName: str - - ScriptType: ApplicationScriptType - - StatusDate: Optional[datetime] - - StatusUserIdentity: UserIdentity - - ApprovalStatus: ApplicationScriptApprovalStatus - - ApprovalStatusDisplayText: str - - AssemblyName: Reflection.AssemblyName - - ExpirationDate: Optional[datetime] - - IsReadOnlyScript: bool - - IsWriteableScript: bool - - PublisherName: str - - ScriptType: ApplicationScriptType - - StatusDate: Optional[datetime] - - StatusUserIdentity: UserIdentity - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ApplicationScriptLog: - """ - The log entry of the application script execution. - - Attributes: - CourseId (str): The identifier of the course that was modified by the script. - PatientId (str): The identifier of the patient that was modified by the script. - PlanSetupId (str): The identifier of the plan that was modified by the script, or an empty string if the script did not modify the plan. - PlanUID (str): The DICOM UID of the plan that was modified by the script, or an empty string if the script did not modify the plan. - Script (ApplicationScript): The script that modified the plan or structure set. - ScriptFullName (str): The full name of the script assembly that modified the plan or structure set. A System.Reflection.AssemblyName object can be created from the string. - StructureSetId (str): The identifier of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. - StructureSetUID (str): The DICOM UID of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. - CourseId (str): The identifier of the course that was modified by the script. - PatientId (str): The identifier of the patient that was modified by the script. - PlanSetupId (str): The identifier of the plan that was modified by the script, or an empty string if the script did not modify the plan. - PlanUID (str): The DICOM UID of the plan that was modified by the script, or an empty string if the script did not modify the plan. - Script (ApplicationScript): The script that modified the plan or structure set. - ScriptFullName (str): The full name of the script assembly that modified the plan or structure set. A System.Reflection.AssemblyName object can be created from the string. - StructureSetId (str): The identifier of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. - StructureSetUID (str): The DICOM UID of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. - """ - def __init__(self) -> None: ... - - CourseId: str - - PatientId: str - - PlanSetupId: str - - PlanUID: str - - Script: ApplicationScript - - ScriptFullName: str - - StructureSetId: str - - StructureSetUID: str - - CourseId: str - - PatientId: str - - PlanSetupId: str - - PlanUID: str - - Script: ApplicationScript - - ScriptFullName: str - - StructureSetId: str - - StructureSetUID: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Applicator: - """ - An applicator add-on, either an electron applicator or cone applicator. - - Attributes: - ApplicatorLengthInMM (float): Applicator length in mm. - DiameterInMM (float): Applicator Diameter in mm. - FieldSizeX (float): The field width in direction X (cm). - FieldSizeY (float): The field width in direction Y (cm). - IsStereotactic (bool): Is stereotactic. - ApplicatorLengthInMM (float): Applicator length in mm. - DiameterInMM (float): Applicator Diameter in mm. - FieldSizeX (float): The field width in direction X (cm). - FieldSizeY (float): The field width in direction Y (cm). - IsStereotactic (bool): Is stereotactic. - """ - def __init__(self) -> None: ... - - ApplicatorLengthInMM: float - - DiameterInMM: float - - FieldSizeX: float - - FieldSizeY: float - - IsStereotactic: bool - - ApplicatorLengthInMM: float - - DiameterInMM: float - - FieldSizeX: float - - FieldSizeY: float - - IsStereotactic: bool - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class BeamDose: - """ - Represents a dose that is connected to a Beam. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts a relative beam dose value into absolute units. This method factors in the field weight, dose prescription, prescribed percentage and plan normalization. - def GetAbsoluteBeamDoseValue(self, relative: DoseValue) -> DoseValue: - """ - Args: - relative: The relative dose value from this beam dose matrix to be converted. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts a relative beam dose value into absolute units. This method factors in the field weight, dose prescription, prescribed percentage and plan normalization. - def GetAbsoluteBeamDoseValue(self, relative: DoseValue) -> DoseValue: - """ - Args: - relative: The relative dose value from this beam dose matrix to be converted. - """ - ... - - - -class BeamParameters: - """ - An editable copy of the parameters of a treatment beam. - - Attributes: - ControlPoints (List[ControlPointParameters]): Editable control point parameters copied from the treatment beam. - GantryDirection (GantryDirection): The direction of gantry rotation (clockwise or counterclockwise). - Isocenter (VVector): A copy of the isocenter position, in millimeters. - WeightFactor (float): The weight factor of the beam. - ControlPoints (List[ControlPointParameters]): Editable control point parameters copied from the treatment beam. - GantryDirection (GantryDirection): The direction of gantry rotation (clockwise or counterclockwise). - Isocenter (VVector): A copy of the isocenter position, in millimeters. - WeightFactor (float): The weight factor of the beam. - - Note: - To apply the parameters, call the - """ - def __init__(self) -> None: ... - - ControlPoints: List[ControlPointParameters] - - GantryDirection: GantryDirection - - Isocenter: VVector - - WeightFactor: float - - ControlPoints: List[ControlPointParameters] - - GantryDirection: GantryDirection - - Isocenter: VVector - - WeightFactor: float - - # Assigns the given leaf positions to each of the control point parameters. - def SetAllLeafPositions(self, leafPositions: Array[float]) -> None: - """ - Args: - leafPositions: The positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. - """ - ... - - - # Assigns the given jaw positions to each of the control point parameters. - def SetJawPositions(self, positions: VRect[float]) -> None: - """ - Args: - positions: A rectangle describing the jaw positions in millimeters in IEC BEAM LIMITING DEVICE coordinates. - """ - ... - - - # Assigns the given leaf positions to each of the control point parameters. - def SetAllLeafPositions(self, leafPositions: Array[float]) -> None: - """ - Args: - leafPositions: The positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. - """ - ... - - - # Assigns the given jaw positions to each of the control point parameters. - def SetJawPositions(self, positions: VRect[float]) -> None: - """ - Args: - positions: A rectangle describing the jaw positions in millimeters in IEC BEAM LIMITING DEVICE coordinates. - """ - ... - - - -class BeamUncertainty: - """ - Access to beam uncertainty. - - Attributes: - Beam (Beam): The beam to which this uncertainty is linked. - BeamNumber (BeamNumber): Beam number of the related beam. - Dose (Dose): Dose of this beam uncertainty. - Beam (Beam): The beam to which this uncertainty is linked. - BeamNumber (BeamNumber): Beam number of the related beam. - Dose (Dose): Dose of this beam uncertainty. - """ - def __init__(self) -> None: ... - - Beam: Beam - - BeamNumber: BeamNumber - - Dose: Dose - - Beam: Beam - - BeamNumber: BeamNumber - - Dose: Dose - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class BrachyFieldReferencePoint: - """ - This object links a Brachy field to a reference point. - - Attributes: - FieldDose (DoseValue): The field dose. - IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. - IsPrimaryReferencePoint (bool): Checks if the reference point is primary. - ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. - RefPointLocation (VVector): The location of the reference point. - FieldDose (DoseValue): The field dose. - IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. - IsPrimaryReferencePoint (bool): Checks if the reference point is primary. - ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. - RefPointLocation (VVector): The location of the reference point. - """ - def __init__(self) -> None: ... - - FieldDose: DoseValue - - IsFieldDoseNominal: bool - - IsPrimaryReferencePoint: bool - - ReferencePoint: ReferencePoint - - RefPointLocation: VVector - - FieldDose: DoseValue - - IsFieldDoseNominal: bool - - IsPrimaryReferencePoint: bool - - ReferencePoint: ReferencePoint - - RefPointLocation: VVector - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class BrachyPlanSetup: - """ - Represents a brachytherapy treatment plan. - - Attributes: - ApplicationSetupType (str): The application setup type of this brachytherapy plan. Possible types are: "FLETCHER_SUIT", "DELCLOS", "BLOEDORN", "JOSLIN_FLYNN", "CHANDIGARH", "MANCHESTER", "HENSCHKE", "NASOPHARYNGEAL", "OESOPHAGEAL", "ENDOBRONCHIAL", "SYED_NEBLETT", "ENDORECTAL", "PERINEAL", "HAM_FLAB", "EYE_PLAQUE", and "OTHER". - BrachyTreatmentTechnique (BrachyTreatmentTechniqueType): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". - Catheters (List[Catheter]): The catheters or applicator channel centerlines of this brachytherapy plan, including any catheters associated with - NumberOfPdrPulses (Optional[int]): The number of pulses in a brachytherapy Pulse Dose Rate (PDR) treatment. Null if the plan is not for a PDR treatment. - PdrPulseInterval (Optional[float]): The pulse interval in a brachytherapy Pulse Dose Rate (PDR) treatment in seconds. Null if the plan is not for a PDR treatment. - ReferenceLines (List[Structure]): Collection of reference lines in the plan. - SeedCollections (List[SeedCollection]): The seed collections of this brachytherapy plan. - SolidApplicators (List[BrachySolidApplicator]): The solid applicator parts of this brachytherapy plan. - TreatmentTechnique (str): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". - TreatmentDateTime (Optional[datetime]): The treatment date of this brachytherapy plan. - ApplicationSetupType (str): The application setup type of this brachytherapy plan. Possible types are: "FLETCHER_SUIT", "DELCLOS", "BLOEDORN", "JOSLIN_FLYNN", "CHANDIGARH", "MANCHESTER", "HENSCHKE", "NASOPHARYNGEAL", "OESOPHAGEAL", "ENDOBRONCHIAL", "SYED_NEBLETT", "ENDORECTAL", "PERINEAL", "HAM_FLAB", "EYE_PLAQUE", and "OTHER". - BrachyTreatmentTechnique (BrachyTreatmentTechniqueType): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". - Catheters (List[Catheter]): The catheters or applicator channel centerlines of this brachytherapy plan, including any catheters associated with - NumberOfPdrPulses (Optional[int]): The number of pulses in a brachytherapy Pulse Dose Rate (PDR) treatment. Null if the plan is not for a PDR treatment. - PdrPulseInterval (Optional[float]): The pulse interval in a brachytherapy Pulse Dose Rate (PDR) treatment in seconds. Null if the plan is not for a PDR treatment. - ReferenceLines (List[Structure]): Collection of reference lines in the plan. - SeedCollections (List[SeedCollection]): The seed collections of this brachytherapy plan. - SolidApplicators (List[BrachySolidApplicator]): The solid applicator parts of this brachytherapy plan. - TreatmentTechnique (str): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". - TreatmentDateTime (Optional[datetime]): The treatment date of this brachytherapy plan. - """ - def __init__(self) -> None: ... - - ApplicationSetupType: str - - BrachyTreatmentTechnique: BrachyTreatmentTechniqueType - - Catheters: List[Catheter] - - NumberOfPdrPulses: Optional[int] - - PdrPulseInterval: Optional[float] - - ReferenceLines: List[Structure] - - SeedCollections: List[SeedCollection] - - SolidApplicators: List[BrachySolidApplicator] - - TreatmentTechnique: str - - TreatmentDateTime: Optional[datetime] - - ApplicationSetupType: str - - BrachyTreatmentTechnique: BrachyTreatmentTechniqueType - - Catheters: List[Catheter] - - NumberOfPdrPulses: Optional[int] - - PdrPulseInterval: Optional[float] - - ReferenceLines: List[Structure] - - SeedCollections: List[SeedCollection] - - SolidApplicators: List[BrachySolidApplicator] - - TreatmentTechnique: str - - TreatmentDateTime: Optional[datetime] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new brachyterapy applicator to the plan. - def AddCatheter(self, catheterId: str, treatmentUnit: BrachyTreatmentUnit, outputDiagnostics: Text.StringBuilder, appendChannelNumToId: bool, channelNum: int) -> Catheter: - """ - Args: - catheterId: Id of the catheter. - treatmentUnit: The - outputDiagnostics: Additional information about brachytherapy applicator creation. - appendChannelNumToId: If true, channel number will be appended to the given catheterId. - channelNum: Channel number of the catheter. 0 assigns next available free channel number. -1 assigns empty channel number. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add location to reference point. - def AddLocationToExistingReferencePoint(self, location: VVector, referencePoint: ReferencePoint) -> None: - """ - Args: - location: Reference point location in mm. - referencePoint: Reference point. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point without location. Created reference point is linked to the plan. - def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: - """ - Args: - target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). - id: Reference point ID. - """ - ... - - - # Calculates and returns the dose profile. Profile is calculated on the fly with TG-43 formalism. - def CalculateAccurateTG43DoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Changes the brachy treatment unit for all applicators in the brachy plan. - def ChangeTreatmentUnit(self, treatmentUnit: BrachyTreatmentUnit, messages: bool, keepDoseIntact: List[str]) -> ChangeBrachyTreatmentUnitResult: - """ - Args: - treatmentUnit: The - messages: An output parameter that may be populated with 1..n messages of additional information. - keepDoseIntact: If true, the dwell times are scaled to keep the dose intact. If false, dwell times are not scaled, and the dose may be invalidated. - """ - ... - - - # Calculates 3D dose using the TG-43 brachy calculator. - def CalculateTG43Dose(self) -> CalculateBrachy3DDoseResult: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new brachyterapy applicator to the plan. - def AddCatheter(self, catheterId: str, treatmentUnit: BrachyTreatmentUnit, outputDiagnostics: Text.StringBuilder, appendChannelNumToId: bool, channelNum: int) -> Catheter: - """ - Args: - catheterId: Id of the catheter. - treatmentUnit: The - outputDiagnostics: Additional information about brachytherapy applicator creation. - appendChannelNumToId: If true, channel number will be appended to the given catheterId. - channelNum: Channel number of the catheter. 0 assigns next available free channel number. -1 assigns empty channel number. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add location to reference point. - def AddLocationToExistingReferencePoint(self, location: VVector, referencePoint: ReferencePoint) -> None: - """ - Args: - location: Reference point location in mm. - referencePoint: Reference point. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point without location. Created reference point is linked to the plan. - def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: - """ - Args: - target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). - id: Reference point ID. - """ - ... - - - # Calculates and returns the dose profile. Profile is calculated on the fly with TG-43 formalism. - def CalculateAccurateTG43DoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Changes the brachy treatment unit for all applicators in the brachy plan. - def ChangeTreatmentUnit(self, treatmentUnit: BrachyTreatmentUnit, messages: bool, keepDoseIntact: List[str]) -> ChangeBrachyTreatmentUnitResult: - """ - Args: - treatmentUnit: The - messages: An output parameter that may be populated with 1..n messages of additional information. - keepDoseIntact: If true, the dwell times are scaled to keep the dose intact. If false, dwell times are not scaled, and the dose may be invalidated. - """ - ... - - - # Calculates 3D dose using the TG-43 brachy calculator. - def CalculateTG43Dose(self) -> CalculateBrachy3DDoseResult: - ... - - - -class BrachySolidApplicator: - """ - Represents a brachytherapy solid applicator part, such as a tandem or ovoid in a Fletcher Suit Delclos (FSD) applicator set. This class holds only the metadata related to the solid applicator part, and links to the - - Attributes: - ApplicatorSetName (str): The name of the solid applicator set to which this part belongs. - ApplicatorSetType (str): The type of the solid applicator set to which this part belongs. - Category (str): The category of the solid applicator set to which this part belongs. - Catheters (List[Catheter]): The channel(s) of this solid applicator part. - GroupNumber (int): Applicator Group number. - Note (str): A note or short description of the solid applicator part. - PartName (str): The name of the solid applicator part. - PartNumber (str): The part number of the solid applicator. - Summary (str): A summary of the solid applicator set to which this part belongs. - UID (str): The unique identifier of the solid applicator part. - Vendor (str): The vendor of the solid applicator set to which this part belongs. - Version (str): The version of the solid applicator part. - ApplicatorSetName (str): The name of the solid applicator set to which this part belongs. - ApplicatorSetType (str): The type of the solid applicator set to which this part belongs. - Category (str): The category of the solid applicator set to which this part belongs. - Catheters (List[Catheter]): The channel(s) of this solid applicator part. - GroupNumber (int): Applicator Group number. - Note (str): A note or short description of the solid applicator part. - PartName (str): The name of the solid applicator part. - PartNumber (str): The part number of the solid applicator. - Summary (str): A summary of the solid applicator set to which this part belongs. - UID (str): The unique identifier of the solid applicator part. - Vendor (str): The vendor of the solid applicator set to which this part belongs. - Version (str): The version of the solid applicator part. - """ - def __init__(self) -> None: ... - - ApplicatorSetName: str - - ApplicatorSetType: str - - Category: str - - Catheters: List[Catheter] - - GroupNumber: int - - Note: str - - PartName: str - - PartNumber: str - - Summary: str - - UID: str - - Vendor: str - - Version: str - - ApplicatorSetName: str - - ApplicatorSetType: str - - Category: str - - Catheters: List[Catheter] - - GroupNumber: int - - Note: str - - PartName: str - - PartNumber: str - - Summary: str - - UID: str - - Vendor: str - - Version: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class BrachyTreatmentUnit: - """ - Represents a brachytherapy afterloader. - - Attributes: - DoseRateMode (str): The dose rate mode of this treatment unit. Supported modes are "HDR", "PDR", "MDR", and "LDR". - DwellTimeResolution (float): The dwell time resolution supported by this treatment unit in seconds. - MachineInterface (str): The interface type for communicating with this brachytherapy treatment unit. Possible types are "GammaMed12i", "GammaMedPlus", "VariSource", "Other", and "Omnitron" (obsolete type). - MachineModel (str): The model identifier for this treatment unit. Possible models are "VariSource_5", "VariSource_10", "Remote_Afterloading", "Manual_Loading", "GammaMed12i", and "GammaMedPlus". - MaxDwellTimePerChannel (float): The maximum combined dwell time in a single channel in seconds. - MaxDwellTimePerPos (float): The maximum dwell time in a single dwell position in seconds. - MaxDwellTimePerTreatment (float): The maximum combined dwell time in all the channels during a single treatment session. The value is in seconds. - MaximumChannelLength (float): The maximum channel length supported by this treatment unit in millimeters. - MaximumDwellPositionsPerChannel (int): The maximum number of dwell positions per channel supported by this treatment unit. - MaximumStepSize (float): The maximum distance between adjacent source positions in millimeters. - MinAllowedSourcePos (float): The minimum allowed distance (in millimeters) from the tip of the inner lumen of the applicator to the center of the first dwell position. In other words, no source positions should be placed within this distance from the tip of the inner lumen. - MinimumChannelLength (float): The minimum channel length supported by this treatment unit in millimeters. - MinimumStepSize (float): The minimum distance between adjacent source positions in millimeters. - NumberOfChannels (int): The number of channels in this treatment unit. - SourceCenterOffsetFromTip (float): The offset distance (in millimeters) from the tip of the applicator to the center of the source at its first possible dwell position. In other words, the offset accounts for half of the active source length and encapsulation. - SourceMovementType (str): The source movement type as defined in DICOM. Possible types are "STEPWISE", "FIXED", and "OSCILLATING". - StepSizeResolution (float): The default step size resolution for this treatment unit in millimeters. - DoseRateMode (str): The dose rate mode of this treatment unit. Supported modes are "HDR", "PDR", "MDR", and "LDR". - DwellTimeResolution (float): The dwell time resolution supported by this treatment unit in seconds. - MachineInterface (str): The interface type for communicating with this brachytherapy treatment unit. Possible types are "GammaMed12i", "GammaMedPlus", "VariSource", "Other", and "Omnitron" (obsolete type). - MachineModel (str): The model identifier for this treatment unit. Possible models are "VariSource_5", "VariSource_10", "Remote_Afterloading", "Manual_Loading", "GammaMed12i", and "GammaMedPlus". - MaxDwellTimePerChannel (float): The maximum combined dwell time in a single channel in seconds. - MaxDwellTimePerPos (float): The maximum dwell time in a single dwell position in seconds. - MaxDwellTimePerTreatment (float): The maximum combined dwell time in all the channels during a single treatment session. The value is in seconds. - MaximumChannelLength (float): The maximum channel length supported by this treatment unit in millimeters. - MaximumDwellPositionsPerChannel (int): The maximum number of dwell positions per channel supported by this treatment unit. - MaximumStepSize (float): The maximum distance between adjacent source positions in millimeters. - MinAllowedSourcePos (float): The minimum allowed distance (in millimeters) from the tip of the inner lumen of the applicator to the center of the first dwell position. In other words, no source positions should be placed within this distance from the tip of the inner lumen. - MinimumChannelLength (float): The minimum channel length supported by this treatment unit in millimeters. - MinimumStepSize (float): The minimum distance between adjacent source positions in millimeters. - NumberOfChannels (int): The number of channels in this treatment unit. - SourceCenterOffsetFromTip (float): The offset distance (in millimeters) from the tip of the applicator to the center of the source at its first possible dwell position. In other words, the offset accounts for half of the active source length and encapsulation. - SourceMovementType (str): The source movement type as defined in DICOM. Possible types are "STEPWISE", "FIXED", and "OSCILLATING". - StepSizeResolution (float): The default step size resolution for this treatment unit in millimeters. - """ - def __init__(self) -> None: ... - - DoseRateMode: str - - DwellTimeResolution: float - - MachineInterface: str - - MachineModel: str - - MaxDwellTimePerChannel: float - - MaxDwellTimePerPos: float - - MaxDwellTimePerTreatment: float - - MaximumChannelLength: float - - MaximumDwellPositionsPerChannel: int - - MaximumStepSize: float - - MinAllowedSourcePos: float - - MinimumChannelLength: float - - MinimumStepSize: float - - NumberOfChannels: int - - SourceCenterOffsetFromTip: float - - SourceMovementType: str - - StepSizeResolution: float - - DoseRateMode: str - - DwellTimeResolution: float - - MachineInterface: str - - MachineModel: str - - MaxDwellTimePerChannel: float - - MaxDwellTimePerPos: float - - MaxDwellTimePerTreatment: float - - MaximumChannelLength: float - - MaximumDwellPositionsPerChannel: int - - MaximumStepSize: float - - MinAllowedSourcePos: float - - MinimumChannelLength: float - - MinimumStepSize: float - - NumberOfChannels: int - - SourceCenterOffsetFromTip: float - - SourceMovementType: str - - StepSizeResolution: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns the active radioactive source of this treatment unit. - def GetActiveRadioactiveSource(self) -> RadioactiveSource: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns the active radioactive source of this treatment unit. - def GetActiveRadioactiveSource(self) -> RadioactiveSource: - ... - - - -class CalculateBrachy3DDoseResult: - """ - Brachy 3D dose calculation result - - Attributes: - Errors (List[str]): Error messages if "Success" is false. - RoundedDwellTimeAdjustRatio (float): The ratio with which the dwell times were adjusted to meet the resolution of the treatment unit. A value of zero (0.0) means no adjustment to dwell times was made. Value is undefined if "Success" is false - Success (bool): Was the dose calculation successful? - Errors (List[str]): Error messages if "Success" is false. - RoundedDwellTimeAdjustRatio (float): The ratio with which the dwell times were adjusted to meet the resolution of the treatment unit. A value of zero (0.0) means no adjustment to dwell times was made. Value is undefined if "Success" is false - Success (bool): Was the dose calculation successful? - """ - def __init__(self) -> None: ... - - Errors: List[str] - - RoundedDwellTimeAdjustRatio: float - - Success: bool - - Errors: List[str] - - RoundedDwellTimeAdjustRatio: float - - Success: bool - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Calculation: - """ - Contains a calculation specific functions - - Attributes: - AlgorithmsRootPath (str): Algorithms Root Path - AlgorithmsRootPath (str): Algorithms Root Path - """ - # Calculation object constructor - @overload - def __init__(self, dvhEstimationModelLibrary: IDVHEstimationModelLibrary) -> None: - """ - Args: - dvhEstimationModelLibrary: DVH Estimation Model Library - """ - ... - - - # Calculation object constructor - @overload - def __init__(self, dvhEstimationModelLibrary: IDVHEstimationModelLibrary) -> None: - """ - Args: - dvhEstimationModelLibrary: DVH Estimation Model Library - """ - ... - - - AlgorithmsRootPath: str - - AlgorithmsRootPath: str - - # Installed Algorithms - def GetInstalledAlgorithms(self) -> List[Calculation+Algorithm]: - ... - - - # Retrieves calculation models - def GetCalculationModels(self) -> List[Calculation+CalculationModel]: - ... - - - # Retrieves the list of DVH Estimation Model structures - def GetDvhEstimationModelStructures(self, modelId: Guid) -> List[DVHEstimationModelStructure]: - """ - Args: - modelId: Model ID. - """ - ... - - - # List of DVH Estimation Model summaries. - def GetDvhEstimationModelSummaries(self) -> List[DVHEstimationModelSummary]: - ... - - - # Installed Algorithms - def GetInstalledAlgorithms(self) -> List[Calculation+Algorithm]: - ... - - - # Retrieves calculation models - def GetCalculationModels(self) -> List[Calculation+CalculationModel]: - ... - - - # Retrieves the list of DVH Estimation Model structures - def GetDvhEstimationModelStructures(self, modelId: Guid) -> List[DVHEstimationModelStructure]: - """ - Args: - modelId: Model ID. - """ - ... - - - # List of DVH Estimation Model summaries. - def GetDvhEstimationModelSummaries(self) -> List[DVHEstimationModelSummary]: - ... - - - -class Catheter: - """ - Represents a brachytherapy catheter or an applicator channel centerline. Catheters are associated with a - - Attributes: - ApplicatorLength (float): The total length from the tip of the catheter to the treatment unit in millimeters. - BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): A collection of brachy field reference points. - BrachySolidApplicatorPartID (int): The unique identifier of the - ChannelNumber (int): The channel number of this catheter. - Color (Windows.Media.Color): The color of the catheter in 2D views. - DeadSpaceLength (float): The total length from the tip of the catheter to the start of the inner lumen in millimeters. - FirstSourcePosition (float): The first source position in millimeters in this catheter. This is the source position closest to the tip of the catheter. - GroupNumber (int): Catheter Group number. - LastSourcePosition (float): The last source position in millimeters in this catheter. This is the source position furthest away from the tip of the catheter. - Shape (Array[VVector]): The DICOM coordinates of the applicator shape starting from the tip. - SourcePositions (List[SourcePosition]): The source positions in the catheter starting from the tip. - StepSize (float): The step size of the catheter in millimeters. - TreatmentUnit (BrachyTreatmentUnit): The brachytherapy treatment unit associated with this catheter. - ApplicatorLength (float): The total length from the tip of the catheter to the treatment unit in millimeters. - BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): A collection of brachy field reference points. - BrachySolidApplicatorPartID (int): The unique identifier of the - ChannelNumber (int): The channel number of this catheter. - Color (Windows.Media.Color): The color of the catheter in 2D views. - DeadSpaceLength (float): The total length from the tip of the catheter to the start of the inner lumen in millimeters. - FirstSourcePosition (float): The first source position in millimeters in this catheter. This is the source position closest to the tip of the catheter. - GroupNumber (int): Catheter Group number. - LastSourcePosition (float): The last source position in millimeters in this catheter. This is the source position furthest away from the tip of the catheter. - Shape (Array[VVector]): The DICOM coordinates of the applicator shape starting from the tip. - SourcePositions (List[SourcePosition]): The source positions in the catheter starting from the tip. - StepSize (float): The step size of the catheter in millimeters. - TreatmentUnit (BrachyTreatmentUnit): The brachytherapy treatment unit associated with this catheter. - """ - def __init__(self) -> None: ... - - ApplicatorLength: float - - BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] - - BrachySolidApplicatorPartID: int - - ChannelNumber: int - - Color: Windows.Media.Color - - DeadSpaceLength: float - - FirstSourcePosition: float - - GroupNumber: int - - LastSourcePosition: float - - Shape: Array[VVector] - - SourcePositions: List[SourcePosition] - - StepSize: float - - TreatmentUnit: BrachyTreatmentUnit - - ApplicatorLength: float - - BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] - - BrachySolidApplicatorPartID: int - - ChannelNumber: int - - Color: Windows.Media.Color - - DeadSpaceLength: float - - FirstSourcePosition: float - - GroupNumber: int - - LastSourcePosition: float - - Shape: Array[VVector] - - SourcePositions: List[SourcePosition] - - StepSize: float - - TreatmentUnit: BrachyTreatmentUnit - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # The distance (in millimeters) from the tip of the catheter (in the first possible source position) to the center of the source position. This is an offset from the actual catheter inner lumen tip by half of the source length and encapsulation. - def GetSourcePosCenterDistanceFromTip(self, sourcePosition: SourcePosition) -> float: - """ - Args: - sourcePosition: The source position for which the distance from the catheter tip is got. - """ - ... - - - # The total dwell time in this catheter in seconds. - def GetTotalDwellTime(self) -> float: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Link reference line to applicator. - def LinkRefLine(self, refLine: Structure) -> None: - """ - Args: - refLine: Reference line to link with applicator. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Link reference point to applicator. - def LinkRefPoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to link with applicator. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the ID of the applicator. - def SetId(self, id: str, message: str) -> bool: - """ - Args: - id: The new ID for the applicator. - message: May be populated with a reason why setting the ID failed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the step size, first source position, and last source position, and resets the source positions of the catheter. - def SetSourcePositions(self, stepSize: float, firstSourcePosition: float, lastSourcePosition: float) -> SetSourcePositionsResult: - """ - Args: - stepSize: Step size in millimeters. - firstSourcePosition: First source position in millimeters. - lastSourcePosition: Last source position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference line from applicator. - def UnlinkRefLine(self, refLine: Structure) -> None: - """ - Args: - refLine: Reference line to unlink from applicator - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference point from applicator. - def UnlinkRefPoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to unlink from applicator - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # The distance (in millimeters) from the tip of the catheter (in the first possible source position) to the center of the source position. This is an offset from the actual catheter inner lumen tip by half of the source length and encapsulation. - def GetSourcePosCenterDistanceFromTip(self, sourcePosition: SourcePosition) -> float: - """ - Args: - sourcePosition: The source position for which the distance from the catheter tip is got. - """ - ... - - - # The total dwell time in this catheter in seconds. - def GetTotalDwellTime(self) -> float: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Link reference line to applicator. - def LinkRefLine(self, refLine: Structure) -> None: - """ - Args: - refLine: Reference line to link with applicator. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Link reference point to applicator. - def LinkRefPoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to link with applicator. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the ID of the applicator. - def SetId(self, id: str, message: str) -> bool: - """ - Args: - id: The new ID for the applicator. - message: May be populated with a reason why setting the ID failed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the step size, first source position, and last source position, and resets the source positions of the catheter. - def SetSourcePositions(self, stepSize: float, firstSourcePosition: float, lastSourcePosition: float) -> SetSourcePositionsResult: - """ - Args: - stepSize: Step size in millimeters. - firstSourcePosition: First source position in millimeters. - lastSourcePosition: Last source position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference line from applicator. - def UnlinkRefLine(self, refLine: Structure) -> None: - """ - Args: - refLine: Reference line to unlink from applicator - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference point from applicator. - def UnlinkRefPoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to unlink from applicator - """ - ... - - - -class ControlPointParameters: - """ - An editable copy of the parameters of a control point. - - Attributes: - CollimatorAngle (float): A copy of the collimator angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. - JawPositions (VRect[float]): A copy of the jaw positions of the treatment beams at this control point in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - LeafPositions (Array[float]): A copy of the positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If no MLC exists, a (0,0)-length array is returned. - PatientSupportAngle (float): A copy of the patient support angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. - GantryAngle (float): A copy of the gantry angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - MetersetWeight (float): A copy of the cumulative meterset weight to this control point. - CollimatorAngle (float): A copy of the collimator angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. - JawPositions (VRect[float]): A copy of the jaw positions of the treatment beams at this control point in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - LeafPositions (Array[float]): A copy of the positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If no MLC exists, a (0,0)-length array is returned. - PatientSupportAngle (float): A copy of the patient support angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. - GantryAngle (float): A copy of the gantry angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - MetersetWeight (float): A copy of the cumulative meterset weight to this control point. - - Note: - To apply the parameters, call the ApplyParameters method of the Beam class. Because the parameters are simple copies, they do not reflect the current state of the data model. - """ - def __init__(self) -> None: ... - - CollimatorAngle: float - - Index: int - - JawPositions: VRect[float] - - LeafPositions: Array[float] - - PatientSupportAngle: float - - TableTopLateralPosition: float - - TableTopLongitudinalPosition: float - - TableTopVerticalPosition: float - - GantryAngle: float - - MetersetWeight: float - - CollimatorAngle: float - - Index: int - - JawPositions: VRect[float] - - LeafPositions: Array[float] - - PatientSupportAngle: float - - TableTopLateralPosition: float - - TableTopLongitudinalPosition: float - - TableTopVerticalPosition: float - - GantryAngle: float - - MetersetWeight: float - - -class AsyncPump: - """ - Provides a pump that supports running asynchronous methods on the current thread. - """ - def __init__(self) -> None: ... - - # Helper for executing an async (Task-returning) function on a single thread. This can be used in cases where calling Wait() or Result on the Task would cause a deadlock, i.e., when the async part of the Task-returning function cannot be executed purely on a background thread. Exceptions thrown by the async function are re-thrown. If the exception is an - def RunAsyncOnCurrentThread(self, asynchronousFunction: Func[Task[T]]) -> Any: - """ - Args: - asynchronousFunction: The async function to be executed - """ - ... - - - # Helper for executing an async (Task-returning) function on a single thread. This can be used in cases where calling Wait() or Result on the Task would cause a deadlock, i.e., when the async part of the Task-returning function cannot be executed purely on a background thread. Exceptions thrown by the async function are re-thrown. If the exception is an - def RunAsyncOnCurrentThread(self, asynchronousFunction: Func[Task[T]]) -> Any: - """ - Args: - asynchronousFunction: The async function to be executed - """ - ... - - - -class Beam: - """ - Represents one beam (also referred to as "field") of an external beam treatment plan. See the definition of DICOM RT Beam for more details. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Beam. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Beam. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] The Beam comment. - Meterset (MetersetValue): The meterset value of the beam. - BeamNumber (int): DICOM RT Beam Number. The value is unique within the plan in which it is created. - Applicator (Applicator): An applicator is a specific add-on used in the beam. - ArcLength (float): The arc length. - AreControlPointJawsMoving (bool): Checks if jaws are moving. - AverageSSD (float): The average Source-to-Skin Distance (SSD) of an arc beam. - BeamTechnique (BeamTechnique): Returns an enumeration that describes the type of the treatment field. - Blocks (List[Block]): A collection of installed blocks. - Boluses (List[Bolus]): A collection of beam boluses. - CalculationLogs (List[BeamCalculationLog]): A collection of beam calculation logs. - CollimatorRotation (float): Collimator rotation - Compensator (Compensator): The compensator. - ControlPoints (ControlPointCollection): An enumerable sequence of machine parameters that describe the planned treatment beam. - CreationDateTime (Optional[datetime]): The date when this object was created. - Dose (BeamDose): The dose for the beam. Returns null if the dose is not calculated. - DoseRate (int): The dose rate of the treatment machine in MU/min. - DosimetricLeafGap (float): The dosimetric leaf gap that has been configured for the Dynamic Multileaf Collimator (DMLC) beams in the system. The dosimetric leaf gap is used for accounting for dose transmission through rounded MLC leaves. - EnergyMode (EnergyMode): Energy mode of the treatment machine. - EnergyModeDisplayName (str): The display name of the energy mode. For example '18E' or '6X-SRS'. - FieldReferencePoints (List[FieldReferencePoint]): A collection of field reference points. - GantryDirection (GantryDirection): The gantry rotation direction: clockwise (CW), counterclockwise (CCW), or none. - HasAllMLCLeavesClosed (bool): Returns true if all MLC leaves are closed. - IsGantryExtended (bool): Checks if the gantry rotation is extended. For arc beams, checks if the gantry rotation is extended at the start angle. - IsGantryExtendedAtStopAngle (bool): Checks if the gantry rotation is extended at the stop angle of an arc beam. - IsImagingTreatmentField (bool): Checks if a beam is an Imaging Treatment Beam, i.e., a beam that is used to take an MV image and whose dose is calculated and taken into account in treatment planning. - IsIMRT (bool): Checks if a beam is IMRT. - IsocenterPosition (VVector): The position of the isocenter. - IsSetupField (bool): Checks if a beam is a setup field. - MetersetPerGy (float): The calculated meterset/Gy value for the beam. - MLC (MLC): Returns a hardware description of the Multileaf Collimator (MLC) used in an MLC plan, or null if no MLC exists. - MLCPlanType (MLCPlanType): The type of the Multileaf Collimator (MLC) plan. - MLCTransmissionFactor (float): The transmission factor of the Multileaf Collimator (MLC) material. - MotionCompensationTechnique (str): DICOM (respiratory) motion compensation technique. Returns an empty string if motion compensation technique is not used. - MotionSignalSource (str): DICOM (respiratory) signal source. Returns an empty string if motion compensation technique is not used. - NormalizationFactor (float): The beam normalization factor. - NormalizationMethod (str): The beam normalization method. - Plan (PlanSetup): Used for navigating to parent Plan - PlannedSSD (float): The Source-to-Skin Distance (SSD) value defined by the user. - ReferenceImage (Image): The reference image of the beam. - SetupNote (str): The setup note of the field. - SetupTechnique (SetupTechnique): The setup technique. - SSD (float): The Source-to-Skin Distance (SSD). For arc beams, the SSD at the start angle. This value is calculated from the geometrical setup of the beam. - SSDAtStopAngle (float): The Source-to-Skin Distance (SSD) at the stop angle of an arc beam. This value is calculated from the geometrical setup of the beam. - Technique (Technique): The technique used in the planning beam. - ToleranceTableLabel (str): User-defined label for the referenced tolerance table, or an empty string if there is no reference to a tolerance table. - Trays (List[Tray]): A collection of installed trays. - TreatmentTime (float): The treatment time set for the beam in seconds. Plan Approval wizard sets this value by default. - TreatmentUnit (ExternalBeamTreatmentUnit): The external beam treatment unit associated with this beam. - Wedges (List[Wedge]): A collection of installed wedges. - WeightFactor (float): The weight factor of the beam. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Beam. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Beam. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] The Beam comment. - Meterset (MetersetValue): The meterset value of the beam. - BeamNumber (int): DICOM RT Beam Number. The value is unique within the plan in which it is created. - Applicator (Applicator): An applicator is a specific add-on used in the beam. - ArcLength (float): The arc length. - AreControlPointJawsMoving (bool): Checks if jaws are moving. - AverageSSD (float): The average Source-to-Skin Distance (SSD) of an arc beam. - BeamTechnique (BeamTechnique): Returns an enumeration that describes the type of the treatment field. - Blocks (List[Block]): A collection of installed blocks. - Boluses (List[Bolus]): A collection of beam boluses. - CalculationLogs (List[BeamCalculationLog]): A collection of beam calculation logs. - CollimatorRotation (float): Collimator rotation - Compensator (Compensator): The compensator. - ControlPoints (ControlPointCollection): An enumerable sequence of machine parameters that describe the planned treatment beam. - CreationDateTime (Optional[datetime]): The date when this object was created. - Dose (BeamDose): The dose for the beam. Returns null if the dose is not calculated. - DoseRate (int): The dose rate of the treatment machine in MU/min. - DosimetricLeafGap (float): The dosimetric leaf gap that has been configured for the Dynamic Multileaf Collimator (DMLC) beams in the system. The dosimetric leaf gap is used for accounting for dose transmission through rounded MLC leaves. - EnergyMode (EnergyMode): Energy mode of the treatment machine. - EnergyModeDisplayName (str): The display name of the energy mode. For example '18E' or '6X-SRS'. - FieldReferencePoints (List[FieldReferencePoint]): A collection of field reference points. - GantryDirection (GantryDirection): The gantry rotation direction: clockwise (CW), counterclockwise (CCW), or none. - HasAllMLCLeavesClosed (bool): Returns true if all MLC leaves are closed. - IsGantryExtended (bool): Checks if the gantry rotation is extended. For arc beams, checks if the gantry rotation is extended at the start angle. - IsGantryExtendedAtStopAngle (bool): Checks if the gantry rotation is extended at the stop angle of an arc beam. - IsImagingTreatmentField (bool): Checks if a beam is an Imaging Treatment Beam, i.e., a beam that is used to take an MV image and whose dose is calculated and taken into account in treatment planning. - IsIMRT (bool): Checks if a beam is IMRT. - IsocenterPosition (VVector): The position of the isocenter. - IsSetupField (bool): Checks if a beam is a setup field. - MetersetPerGy (float): The calculated meterset/Gy value for the beam. - MLC (MLC): Returns a hardware description of the Multileaf Collimator (MLC) used in an MLC plan, or null if no MLC exists. - MLCPlanType (MLCPlanType): The type of the Multileaf Collimator (MLC) plan. - MLCTransmissionFactor (float): The transmission factor of the Multileaf Collimator (MLC) material. - MotionCompensationTechnique (str): DICOM (respiratory) motion compensation technique. Returns an empty string if motion compensation technique is not used. - MotionSignalSource (str): DICOM (respiratory) signal source. Returns an empty string if motion compensation technique is not used. - NormalizationFactor (float): The beam normalization factor. - NormalizationMethod (str): The beam normalization method. - Plan (PlanSetup): Used for navigating to parent Plan - PlannedSSD (float): The Source-to-Skin Distance (SSD) value defined by the user. - ReferenceImage (Image): The reference image of the beam. - SetupNote (str): The setup note of the field. - SetupTechnique (SetupTechnique): The setup technique. - SSD (float): The Source-to-Skin Distance (SSD). For arc beams, the SSD at the start angle. This value is calculated from the geometrical setup of the beam. - SSDAtStopAngle (float): The Source-to-Skin Distance (SSD) at the stop angle of an arc beam. This value is calculated from the geometrical setup of the beam. - Technique (Technique): The technique used in the planning beam. - ToleranceTableLabel (str): User-defined label for the referenced tolerance table, or an empty string if there is no reference to a tolerance table. - Trays (List[Tray]): A collection of installed trays. - TreatmentTime (float): The treatment time set for the beam in seconds. Plan Approval wizard sets this value by default. - TreatmentUnit (ExternalBeamTreatmentUnit): The external beam treatment unit associated with this beam. - Wedges (List[Wedge]): A collection of installed wedges. - WeightFactor (float): The weight factor of the beam. - """ - def __init__(self) -> None: ... - - Id: str - - Name: str - - Comment: str - - Meterset: MetersetValue - - BeamNumber: int - - Applicator: Applicator - - ArcLength: float - - AreControlPointJawsMoving: bool - - AverageSSD: float - - BeamTechnique: BeamTechnique - - Blocks: List[Block] - - Boluses: List[Bolus] - - CalculationLogs: List[BeamCalculationLog] - - CollimatorRotation: float - - Compensator: Compensator - - ControlPoints: ControlPointCollection - - CreationDateTime: Optional[datetime] - - Dose: BeamDose - - DoseRate: int - - DosimetricLeafGap: float - - EnergyMode: EnergyMode - - EnergyModeDisplayName: str - - FieldReferencePoints: List[FieldReferencePoint] - - GantryDirection: GantryDirection - - HasAllMLCLeavesClosed: bool - - IsGantryExtended: bool - - IsGantryExtendedAtStopAngle: bool - - IsImagingTreatmentField: bool - - IsIMRT: bool - - IsocenterPosition: VVector - - IsSetupField: bool - - MetersetPerGy: float - - MLC: MLC - - MLCPlanType: MLCPlanType - - MLCTransmissionFactor: float - - MotionCompensationTechnique: str - - MotionSignalSource: str - - NormalizationFactor: float - - NormalizationMethod: str - - Plan: PlanSetup - - PlannedSSD: float - - ReferenceImage: Image - - SetupNote: str - - SetupTechnique: SetupTechnique - - SSD: float - - SSDAtStopAngle: float - - Technique: Technique - - ToleranceTableLabel: str - - Trays: List[Tray] - - TreatmentTime: float - - TreatmentUnit: ExternalBeamTreatmentUnit - - Wedges: List[Wedge] - - WeightFactor: float - - Id: str - - Name: str - - Comment: str - - Meterset: MetersetValue - - BeamNumber: int - - Applicator: Applicator - - ArcLength: float - - AreControlPointJawsMoving: bool - - AverageSSD: float - - BeamTechnique: BeamTechnique - - Blocks: List[Block] - - Boluses: List[Bolus] - - CalculationLogs: List[BeamCalculationLog] - - CollimatorRotation: float - - Compensator: Compensator - - ControlPoints: ControlPointCollection - - CreationDateTime: Optional[datetime] - - Dose: BeamDose - - DoseRate: int - - DosimetricLeafGap: float - - EnergyMode: EnergyMode - - EnergyModeDisplayName: str - - FieldReferencePoints: List[FieldReferencePoint] - - GantryDirection: GantryDirection - - HasAllMLCLeavesClosed: bool - - IsGantryExtended: bool - - IsGantryExtendedAtStopAngle: bool - - IsImagingTreatmentField: bool - - IsIMRT: bool - - IsocenterPosition: VVector - - IsSetupField: bool - - MetersetPerGy: float - - MLC: MLC - - MLCPlanType: MLCPlanType - - MLCTransmissionFactor: float - - MotionCompensationTechnique: str - - MotionSignalSource: str - - NormalizationFactor: float - - NormalizationMethod: str - - Plan: PlanSetup - - PlannedSSD: float - - ReferenceImage: Image - - SetupNote: str - - SetupTechnique: SetupTechnique - - SSD: float - - SSDAtStopAngle: float - - Technique: Technique - - ToleranceTableLabel: str - - Trays: List[Tray] - - TreatmentTime: float - - TreatmentUnit: ExternalBeamTreatmentUnit - - Wedges: List[Wedge] - - WeightFactor: float - - # [Availability of this property depends on your Eclipse Scripting API license] Adds a link to bolus. - def AddBolus(self, bolus: Bolus) -> None: - """ - Args: - bolus: The bolus to add. - """ - ... - - - # [Availability of this property depends on your Eclipse Scripting API license] Removes the link to bolus. - def RemoveBolus(self, bolus: Bolus) -> bool: - """ - Args: - bolus: The bolus to remove from the beam. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a link to bolus. - def AddBolus(self, bolusId: str) -> None: - """ - Args: - bolusId: The ID of the bolus to add. The bolus structure must exist in the plan's structure set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a flattening sequence to a static Halcyon field. Throws an exception if the field is not a Halcyon field. - def AddFlatteningSequence(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Modifies the beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. - def ApplyParameters(self, beamParams: BeamParameters) -> None: - """ - Args: - beamParams: The parameters to apply to the beam. - """ - ... - - - # Calculate and get Average Leaf Pair Opening values. ALPO values are calculated on the fly (not serialized). Returns a Dictionary. Key element is the index of carriage group in the field and value element is the ALPO value for that carriage group. - def CalculateAverageLeafPairOpenings(self) -> Dict[int, float]: - ... - - - # Checks if optimal fluence can be set for this beam. - def CanSetOptimalFluence(self, fluence: Fluence, message: str) -> bool: - """ - Args: - fluence: The optimal fluence for the beam. - message: If the optimal fluence cannot be set, contains information about the reason. - """ - ... - - - # Converts the given collimator angle value from the internal IEC scale to the user facing scale of the machine. - def CollimatorAngleToUser(self, val: float) -> float: - """ - Args: - val: Collimator angle value - """ - ... - - - # Counts and returns Subfield count. - def CountSubfields(self) -> int: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the DRR. - def CreateOrReplaceDRR(self, parameters: DRRCalculationParameters) -> Image: - """ - Args: - parameters: DRR calculation parameters - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the collimator to the specified structure - def FitCollimatorToStructure(self, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) -> None: - """ - Args: - margins: Margins used to fit to structure - structure: Structure to fit to - useAsymmetricXJaws: Flag of using asymmetric x jaws - useAsymmetricYJaws: Flag of uisng asymmetric y jaws - optimizeCollimatorRotation: Flag of optimizing collimator angles as fitting result - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with default settings, or with settings from previous fit. - def FitMLCToOutline(self, outline: Array[Array[Windows.Point]]) -> None: - """ - Args: - outline: The shape to fit the MLC leaves to, for example, Block.Outline. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with specified options. - def FitMLCToOutline(self, outline: Array[Array[Windows.Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: - """ - Args: - outline: The shape to fit the MLC leaves to, for example, Block.Outline. - optimizeCollimatorRotation: Specifies if the MLC rotation is optimized. - jawFit: Controls whether the collimator jaws are positioned to match the MLC outline and how it is done. - olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). - clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves in the beam to a structure with the default settings, or with settings from the previous fit. The margin is zero. - def FitMLCToStructure(self, structure: Structure) -> None: - """ - Args: - structure: The structure to fit the MLC leaves to. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a structure projection on the isocenter plane with the specified margin. - def FitMLCToStructure(self, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: - """ - Args: - margins: Specifies the margin in all directions. - structure: The structure to fit the MLC leaves to. - optimizeCollimatorRotation: Specify if the MLC rotation is optimized. - jawFit: Controls whether and how the collimator jaws are positioned to match the MLC outline. - olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). - clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). - """ - ... - - - # Converts the given gantry rotation value from the internal IEC scale to the user facing scale of the machine. - def GantryAngleToUser(self, val: float) -> float: - """ - Args: - val: Gantry rotation value - """ - ... - - - # CAX path length in bolus is calculated along the vector spanning from radiation source to first skin contact (as defined by SSD). - def GetCAXPathLengthInBolus(self, bolus: Bolus) -> float: - ... - - - # Returns an editable copy of the beam parameters. The returned BeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another BeamParameters object. - def GetEditableParameters(self) -> BeamParameters: - ... - - - # Gets the optimal fluence for this beam. Returns null if optimal fluence does not exist. - def GetOptimalFluence(self) -> Fluence: - ... - - - # Returns the location of the radiation source at a given gantry angle of the beam. - def GetSourceLocation(self, gantryAngle: float) -> VVector: - """ - Args: - gantryAngle: Gantry angle - """ - ... - - - # Calculates Source To Bolus distance in mm. - def GetSourceToBolusDistance(self, bolus: Bolus) -> float: - ... - - - # If the structure has a segment, gets the outline of the structure on the isocenter plane of the beam. - def GetStructureOutlines(self, structure: Structure, inBEV: bool) -> Array[Array[Windows.Point]]: - """ - Args: - structure: The structure to be projected to the isocenter plane. - inBEV: If true, outlines are returned in the Beams Eye View (BEV) coordinates, where the collimator angle is 0.0 degrees. If false, outlines are returned in beam coordinates. Suitable for use with FitMLCToOutline(...). - """ - ... - - - # Converts the given jaw positions from the internal IEC scale to a string in the user facing scale of the machine. - def JawPositionsToUserString(self, val: VRect[float]) -> str: - """ - Args: - val: Jaw postitions - """ - ... - - - # Converts the given patient support angle value from the internal IEC scale to the user facing scale of the machine. - def PatientSupportAngleToUser(self, val: float) -> float: - """ - Args: - val: Patient support angle value - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the link to bolus. - def RemoveBolus(self, bolusId: str) -> bool: - """ - Args: - bolusId: The ID of the bolus to remove from the beam. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the flattening sequence from a Halcyon field. Throws an exception if the field is not a Halcyon field. - def RemoveFlatteningSequence(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the optimal fluence for this beam. If the fluence is empty (the fluence is null or the dimensions of the fluence matrix are zero) an ArgumentException will be thrown. Setting the optimal fluence for the beam does not clear DVH Estimations of the plan. - def SetOptimalFluence(self, fluence: Fluence) -> None: - """ - Args: - fluence: The optimal fluence to be set. - """ - ... - - - # [Availability of this property depends on your Eclipse Scripting API license] Adds a link to bolus. - def AddBolus(self, bolus: Bolus) -> None: - """ - Args: - bolus: The bolus to add. - """ - ... - - - # [Availability of this property depends on your Eclipse Scripting API license] Removes the link to bolus. - def RemoveBolus(self, bolus: Bolus) -> bool: - """ - Args: - bolus: The bolus to remove from the beam. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a link to bolus. - def AddBolus(self, bolusId: str) -> None: - """ - Args: - bolusId: The ID of the bolus to add. The bolus structure must exist in the plan's structure set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a flattening sequence to a static Halcyon field. Throws an exception if the field is not a Halcyon field. - def AddFlatteningSequence(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Modifies the beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. - def ApplyParameters(self, beamParams: BeamParameters) -> None: - """ - Args: - beamParams: The parameters to apply to the beam. - """ - ... - - - # Calculate and get Average Leaf Pair Opening values. ALPO values are calculated on the fly (not serialized). Returns a Dictionary. Key element is the index of carriage group in the field and value element is the ALPO value for that carriage group. - def CalculateAverageLeafPairOpenings(self) -> Dict[int, float]: - ... - - - # Checks if optimal fluence can be set for this beam. - def CanSetOptimalFluence(self, fluence: Fluence, message: str) -> bool: - """ - Args: - fluence: The optimal fluence for the beam. - message: If the optimal fluence cannot be set, contains information about the reason. - """ - ... - - - # Converts the given collimator angle value from the internal IEC scale to the user facing scale of the machine. - def CollimatorAngleToUser(self, val: float) -> float: - """ - Args: - val: Collimator angle value - """ - ... - - - # Counts and returns Subfield count. - def CountSubfields(self) -> int: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the DRR. - def CreateOrReplaceDRR(self, parameters: DRRCalculationParameters) -> Image: - """ - Args: - parameters: DRR calculation parameters - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the collimator to the specified structure - def FitCollimatorToStructure(self, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) -> None: - """ - Args: - margins: Margins used to fit to structure - structure: Structure to fit to - useAsymmetricXJaws: Flag of using asymmetric x jaws - useAsymmetricYJaws: Flag of uisng asymmetric y jaws - optimizeCollimatorRotation: Flag of optimizing collimator angles as fitting result - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with default settings, or with settings from previous fit. - def FitMLCToOutline(self, outline: Array[Array[Windows.Point]]) -> None: - """ - Args: - outline: The shape to fit the MLC leaves to, for example, Block.Outline. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with specified options. - def FitMLCToOutline(self, outline: Array[Array[Windows.Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: - """ - Args: - outline: The shape to fit the MLC leaves to, for example, Block.Outline. - optimizeCollimatorRotation: Specifies if the MLC rotation is optimized. - jawFit: Controls whether the collimator jaws are positioned to match the MLC outline and how it is done. - olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). - clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves in the beam to a structure with the default settings, or with settings from the previous fit. The margin is zero. - def FitMLCToStructure(self, structure: Structure) -> None: - """ - Args: - structure: The structure to fit the MLC leaves to. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a structure projection on the isocenter plane with the specified margin. - def FitMLCToStructure(self, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: - """ - Args: - margins: Specifies the margin in all directions. - structure: The structure to fit the MLC leaves to. - optimizeCollimatorRotation: Specify if the MLC rotation is optimized. - jawFit: Controls whether and how the collimator jaws are positioned to match the MLC outline. - olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). - clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). - """ - ... - - - # Converts the given gantry rotation value from the internal IEC scale to the user facing scale of the machine. - def GantryAngleToUser(self, val: float) -> float: - """ - Args: - val: Gantry rotation value - """ - ... - - - # CAX path length in bolus is calculated along the vector spanning from radiation source to first skin contact (as defined by SSD). - def GetCAXPathLengthInBolus(self, bolus: Bolus) -> float: - ... - - - # Returns an editable copy of the beam parameters. The returned BeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another BeamParameters object. - def GetEditableParameters(self) -> BeamParameters: - ... - - - # Gets the optimal fluence for this beam. Returns null if optimal fluence does not exist. - def GetOptimalFluence(self) -> Fluence: - ... - - - # Returns the location of the radiation source at a given gantry angle of the beam. - def GetSourceLocation(self, gantryAngle: float) -> VVector: - """ - Args: - gantryAngle: Gantry angle - """ - ... - - - # Calculates Source To Bolus distance in mm. - def GetSourceToBolusDistance(self, bolus: Bolus) -> float: - ... - - - # If the structure has a segment, gets the outline of the structure on the isocenter plane of the beam. - def GetStructureOutlines(self, structure: Structure, inBEV: bool) -> Array[Array[Windows.Point]]: - """ - Args: - structure: The structure to be projected to the isocenter plane. - inBEV: If true, outlines are returned in the Beams Eye View (BEV) coordinates, where the collimator angle is 0.0 degrees. If false, outlines are returned in beam coordinates. Suitable for use with FitMLCToOutline(...). - """ - ... - - - # Converts the given jaw positions from the internal IEC scale to a string in the user facing scale of the machine. - def JawPositionsToUserString(self, val: VRect[float]) -> str: - """ - Args: - val: Jaw postitions - """ - ... - - - # Converts the given patient support angle value from the internal IEC scale to the user facing scale of the machine. - def PatientSupportAngleToUser(self, val: float) -> float: - """ - Args: - val: Patient support angle value - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the link to bolus. - def RemoveBolus(self, bolusId: str) -> bool: - """ - Args: - bolusId: The ID of the bolus to remove from the beam. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the flattening sequence from a Halcyon field. Throws an exception if the field is not a Halcyon field. - def RemoveFlatteningSequence(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the optimal fluence for this beam. If the fluence is empty (the fluence is null or the dimensions of the fluence matrix are zero) an ArgumentException will be thrown. Setting the optimal fluence for the beam does not clear DVH Estimations of the plan. - def SetOptimalFluence(self, fluence: Fluence) -> None: - """ - Args: - fluence: The optimal fluence to be set. - """ - ... - - - -class Course: - """ - A course represents the course of treatment that a patient will be given. Every patient must have a course, and all plans always belong to a course. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Course. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Course. - ExternalPlanSetups (List[ExternalPlanSetup]): A collection of external beam plans for the course. - BrachyPlanSetups (List[BrachyPlanSetup]): A collection of brachytherapy plans for the course. - IonPlanSetups (List[IonPlanSetup]): A collection of proton plans for the course. - ClinicalStatus (CourseClinicalStatus): Clinical Status of Course. - CompletedDateTime (Optional[datetime]): The date and time when the course was completed. - Diagnoses (List[Diagnosis]): The diagnoses that are attached to the course. - Intent (str): The intent of the course. - Patient (Patient): Patient in which the course is defined. - PlanSetups (List[PlanSetup]): A collection of plans for the course. The plans can be of any type (external beam or brachytherapy). - PlanSums (List[PlanSum]): A collection of plan sums for the course. - StartDateTime (Optional[datetime]): The date and time when the course was started. - TreatmentPhases (List[TreatmentPhase]): All treatment phases in the course. - TreatmentSessions (List[TreatmentSession]): Treatment sessions of the course. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Course. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Course. - ExternalPlanSetups (List[ExternalPlanSetup]): A collection of external beam plans for the course. - BrachyPlanSetups (List[BrachyPlanSetup]): A collection of brachytherapy plans for the course. - IonPlanSetups (List[IonPlanSetup]): A collection of proton plans for the course. - ClinicalStatus (CourseClinicalStatus): Clinical Status of Course. - CompletedDateTime (Optional[datetime]): The date and time when the course was completed. - Diagnoses (List[Diagnosis]): The diagnoses that are attached to the course. - Intent (str): The intent of the course. - Patient (Patient): Patient in which the course is defined. - PlanSetups (List[PlanSetup]): A collection of plans for the course. The plans can be of any type (external beam or brachytherapy). - PlanSums (List[PlanSum]): A collection of plan sums for the course. - StartDateTime (Optional[datetime]): The date and time when the course was started. - TreatmentPhases (List[TreatmentPhase]): All treatment phases in the course. - TreatmentSessions (List[TreatmentSession]): Treatment sessions of the course. - """ - def __init__(self) -> None: ... - - Id: str - - Comment: str - - ExternalPlanSetups: List[ExternalPlanSetup] - - BrachyPlanSetups: List[BrachyPlanSetup] - - IonPlanSetups: List[IonPlanSetup] - - ClinicalStatus: CourseClinicalStatus - - CompletedDateTime: Optional[datetime] - - Diagnoses: List[Diagnosis] - - Intent: str - - Patient: Patient - - PlanSetups: List[PlanSetup] - - PlanSums: List[PlanSum] - - StartDateTime: Optional[datetime] - - TreatmentPhases: List[TreatmentPhase] - - TreatmentSessions: List[TreatmentSession] - - Id: str - - Comment: str - - ExternalPlanSetups: List[ExternalPlanSetup] - - BrachyPlanSetups: List[BrachyPlanSetup] - - IonPlanSetups: List[IonPlanSetup] - - ClinicalStatus: CourseClinicalStatus - - CompletedDateTime: Optional[datetime] - - Diagnoses: List[Diagnosis] - - Intent: str - - Patient: Patient - - PlanSetups: List[PlanSetup] - - PlanSums: List[PlanSum] - - StartDateTime: Optional[datetime] - - TreatmentPhases: List[TreatmentPhase] - - TreatmentSessions: List[TreatmentSession] - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan sum from given planning items. - def CreatePlanSum(self, planningItems: List[PlanningItem], image: Image) -> PlanSum: - """ - Args: - planningItems: Items to create sum from. All plans must share the same image, otherwise please use - image: Plan Sum image - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course with target, primary reference point and additional reference points in arguments - def AddExternalPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: List[ReferencePoint]) -> ExternalPlanSetup: - """ - Args: - structureSet: Valid StructureSet to connected with the plan - targetStructure: Target structure, if defined must be from 'structureSet', if left null target will remain unset. - primaryReferencePoint: Valid reference point to be connected as primary. - additionalReferencePoints: Collection of additional valid reference points - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course with the target structure, primary reference point and additional reference points specified in arguments. - def AddBrachyPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: DoseValue, dosePerFraction: BrachyTreatmentTechniqueType, brachyTreatmentTechnique: List[ReferencePoint]) -> BrachyPlanSetup: - """ - Args: - structureSet: Valid StructureSet to be connected to the plan - targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. - primaryReferencePoint: Valid reference point to be connected as primary reference point. - additionalReferencePoints: Collection of additional valid reference points - dosePerFraction: Dose per fraction - brachyTreatmentTechnique: Brachytherapy treatment technique - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. - def AddIonPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, patientSupportDeviceId: ReferencePoint, primaryReferencePoint: str, additionalReferencePoints: List[ReferencePoint]) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. - patientSupportDeviceId: Id of the patient support device. - primaryReferencePoint: Valid reference point to be connected as primary. - additionalReferencePoints: Collection of additional valid reference points - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course. A new primary reference point is always created for the new brachytherapy plan. - def AddBrachyPlanSetup(self, structureSet: StructureSet, dosePerFraction: DoseValue, brachyTreatmentTechnique: BrachyTreatmentTechniqueType) -> BrachyPlanSetup: - """ - Args: - structureSet: A valid StructureSet to be connected to the plan. - dosePerFraction: Dose per fraction - brachyTreatmentTechnique: Brachytherapy treatment technique - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course. A new primary reference point is always created for the new plan. - def AddExternalPlanSetup(self, structureSet: StructureSet) -> ExternalPlanSetup: - """ - Args: - structureSet: A valid structure set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the verified plan and a new plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. - def AddExternalPlanSetupAsVerificationPlan(self, structureSet: StructureSet, verifiedPlan: ExternalPlanSetup) -> ExternalPlanSetup: - """ - Args: - structureSet: A valid structure set. - verifiedPlan: The verified plan. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. - def AddIonPlanSetup(self, structureSet: StructureSet, patientSupportDeviceId: str) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - patientSupportDeviceId: Id of the patient support device. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the proton plan to be verified and the new verification plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. - def AddIonPlanSetupAsVerificationPlan(self, structureSet: StructureSet, patientSupportDeviceId: str, verifiedPlan: IonPlanSetup) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - patientSupportDeviceId: Id of the patient support device. - verifiedPlan: The verified plan. - """ - ... - - - # Checks if a new plan can be added to this course using the given structure set. - def CanAddPlanSetup(self, structureSet: StructureSet) -> bool: - """ - Args: - structureSet: The structure set used by the plan. - """ - ... - - - # Checks if the plan setup can be removed from this course. - def CanRemovePlanSetup(self, planSetup: PlanSetup) -> bool: - """ - Args: - planSetup: The plan setup to check. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan (the planning image will be the same for both plans). - def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: - """ - Args: - sourcePlan: Brachy plan to copy from - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with the primary image of the sourcePlan. First copies image and then changes planning image. - def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: - """ - Args: - sourcePlan: Brachy plan to copy from - structureset: The structure set along with its associated image that will be assigned to the copied plan - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan (the planning image will be the same for both plans). - def CopyPlanSetup(self, sourcePlan: PlanSetup) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. If there are multiple registrations, just copies isocenter locations and shows a message about this. - def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - targetImage: Image to copy plan to - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. - def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, registration: Registration, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - targetImage: Image to copy plan to - registration: Registration to use to map geometry from source to target - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. - def CopyPlanSetup(self, sourcePlan: PlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - structureset: The structure set along with its associated image that will be assigned to the copied plan - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # Checks if the clinical status of the course is completed or restored. - def IsCompleted(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan setup from the database. Use - def RemovePlanSetup(self, planSetup: PlanSetup) -> None: - """ - Args: - planSetup: The plan setup that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan sum from the database. The PlanSum object given as a parameter is not usable anymore after this operation. - def RemovePlanSum(self, planSum: PlanSum) -> None: - """ - Args: - planSum: The plan sum that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan sum from given planning items. - def CreatePlanSum(self, planningItems: List[PlanningItem], image: Image) -> PlanSum: - """ - Args: - planningItems: Items to create sum from. All plans must share the same image, otherwise please use - image: Plan Sum image - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course with target, primary reference point and additional reference points in arguments - def AddExternalPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: List[ReferencePoint]) -> ExternalPlanSetup: - """ - Args: - structureSet: Valid StructureSet to connected with the plan - targetStructure: Target structure, if defined must be from 'structureSet', if left null target will remain unset. - primaryReferencePoint: Valid reference point to be connected as primary. - additionalReferencePoints: Collection of additional valid reference points - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course with the target structure, primary reference point and additional reference points specified in arguments. - def AddBrachyPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: DoseValue, dosePerFraction: BrachyTreatmentTechniqueType, brachyTreatmentTechnique: List[ReferencePoint]) -> BrachyPlanSetup: - """ - Args: - structureSet: Valid StructureSet to be connected to the plan - targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. - primaryReferencePoint: Valid reference point to be connected as primary reference point. - additionalReferencePoints: Collection of additional valid reference points - dosePerFraction: Dose per fraction - brachyTreatmentTechnique: Brachytherapy treatment technique - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. - def AddIonPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, patientSupportDeviceId: ReferencePoint, primaryReferencePoint: str, additionalReferencePoints: List[ReferencePoint]) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. - patientSupportDeviceId: Id of the patient support device. - primaryReferencePoint: Valid reference point to be connected as primary. - additionalReferencePoints: Collection of additional valid reference points - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course. A new primary reference point is always created for the new brachytherapy plan. - def AddBrachyPlanSetup(self, structureSet: StructureSet, dosePerFraction: DoseValue, brachyTreatmentTechnique: BrachyTreatmentTechniqueType) -> BrachyPlanSetup: - """ - Args: - structureSet: A valid StructureSet to be connected to the plan. - dosePerFraction: Dose per fraction - brachyTreatmentTechnique: Brachytherapy treatment technique - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course. A new primary reference point is always created for the new plan. - def AddExternalPlanSetup(self, structureSet: StructureSet) -> ExternalPlanSetup: - """ - Args: - structureSet: A valid structure set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the verified plan and a new plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. - def AddExternalPlanSetupAsVerificationPlan(self, structureSet: StructureSet, verifiedPlan: ExternalPlanSetup) -> ExternalPlanSetup: - """ - Args: - structureSet: A valid structure set. - verifiedPlan: The verified plan. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. - def AddIonPlanSetup(self, structureSet: StructureSet, patientSupportDeviceId: str) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - patientSupportDeviceId: Id of the patient support device. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the proton plan to be verified and the new verification plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. - def AddIonPlanSetupAsVerificationPlan(self, structureSet: StructureSet, patientSupportDeviceId: str, verifiedPlan: IonPlanSetup) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - patientSupportDeviceId: Id of the patient support device. - verifiedPlan: The verified plan. - """ - ... - - - # Checks if a new plan can be added to this course using the given structure set. - def CanAddPlanSetup(self, structureSet: StructureSet) -> bool: - """ - Args: - structureSet: The structure set used by the plan. - """ - ... - - - # Checks if the plan setup can be removed from this course. - def CanRemovePlanSetup(self, planSetup: PlanSetup) -> bool: - """ - Args: - planSetup: The plan setup to check. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan (the planning image will be the same for both plans). - def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: - """ - Args: - sourcePlan: Brachy plan to copy from - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with the primary image of the sourcePlan. First copies image and then changes planning image. - def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: - """ - Args: - sourcePlan: Brachy plan to copy from - structureset: The structure set along with its associated image that will be assigned to the copied plan - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan (the planning image will be the same for both plans). - def CopyPlanSetup(self, sourcePlan: PlanSetup) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. If there are multiple registrations, just copies isocenter locations and shows a message about this. - def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - targetImage: Image to copy plan to - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. - def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, registration: Registration, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - targetImage: Image to copy plan to - registration: Registration to use to map geometry from source to target - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. - def CopyPlanSetup(self, sourcePlan: PlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - structureset: The structure set along with its associated image that will be assigned to the copied plan - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # Checks if the clinical status of the course is completed or restored. - def IsCompleted(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan setup from the database. Use - def RemovePlanSetup(self, planSetup: PlanSetup) -> None: - """ - Args: - planSetup: The plan setup that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan sum from the database. The PlanSum object given as a parameter is not usable anymore after this operation. - def RemovePlanSum(self, planSum: PlanSum) -> None: - """ - Args: - planSum: The plan sum that is removed. - """ - ... - - - -class CustomScriptExecutable: - """ - A factory class for creating an application object for a custom script executable. - """ - def __init__(self) -> None: ... - - # Creates an application object for a custom executable and logs it into the system. Application object created by this method can be used when the executable itself is not a script. For example, an interpreter of a high level programming language, or a native C++ application that integrates into .NET and uses ESAPI. The scripts executed with this application object are always read-only in a clinical environment, and writable in a non-clinical environment. - def CreateApplication(self, scriptName: str) -> Application: - """ - Args: - scriptName: The script name for logging in. Preferably use the full absolute path. - """ - ... - - - # Creates an application object for a custom executable and logs it into the system. Application object created by this method can be used when the executable itself is not a script. For example, an interpreter of a high level programming language, or a native C++ application that integrates into .NET and uses ESAPI. The scripts executed with this application object are always read-only in a clinical environment, and writable in a non-clinical environment. - def CreateApplication(self, scriptName: str) -> Application: - """ - Args: - scriptName: The script name for logging in. Preferably use the full absolute path. - """ - ... - - - -class IonPlanSetup: - """ - Represents a proton treatment plan. - - Attributes: - IsPostProcessingNeeded (bool): Instructs whether to include the post-processing of scanning spots in proton dose calculation. - CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. - DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by - IonBeams (List[IonBeam]): Gets the proton beams of the plan. - IsPostProcessingNeeded (bool): Instructs whether to include the post-processing of scanning spots in proton dose calculation. - CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. - DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by - IonBeams (List[IonBeam]): Gets the proton beams of the plan. - """ - def __init__(self) -> None: ... - - IsPostProcessingNeeded: bool - - CalculatePlanUncertaintyDose: bool - - DoseAsEvaluationDose: EvaluationDose - - IonBeams: List[IonBeam] - - IsPostProcessingNeeded: bool - - CalculatePlanUncertaintyDose: bool - - DoseAsEvaluationDose: EvaluationDose - - IonBeams: List[IonBeam] - - # [Availability of this property depends on your Eclipse Scripting API license] Creates a new proton verification plan that is a copy of this plan and that has dose calculated using the DECT proton stopping power values calculated based on the input images "rhoImage" and "zImage". - def CreateDectVerificationPlan(self, rhoImage: Image, zImage: Image) -> IonPlanSetup: - """ - Args: - rhoImage: A DECT relative electron density image where the value each voxel is interpreted as rho = 0.001 * (value + 1000). - zImage: A DECT effective atomic number image. - """ - ... - - - # This method is used to remove the temporary DECT objects under the DECT-study that was created for intermediate dose calculation. The method should be called only after the dose calculation is done, otherwise the intermediate dose is disposed too early. The temporary objects should be removed because they contain virtual CT images we do not want ending into the database. - def RemoveTemporaryObjects(self) -> Any: - ... - - - # Checks whether the proton volume dose calculation model attached to this plan is Proton Convolution Superposition. - def CheckDectCompatibleDoseCalcModel(self) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam line for the proton plan. - def CalculateBeamLine(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the proton plan. - def CalculateDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the proton plan. - def CalculatePlanUncertaintyDoses(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs IMPT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeIMPT(self, options: OptimizationOptionsIMPT) -> OptimizerResult: - """ - Args: - options: IMPT optimization options. - """ - ... - - - # Post-processes the proton plan by creating a final spot list, and calculates the dose. - def PostProcessAndCalculateDose(self) -> CalculationResult: - ... - - - # Calculates the dose for a proton plan without post-processing. The existing final spot list is used, and no new list is created during the calculation. - def CalculateDoseWithoutPostProcessing(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam delivery dynamics for the final spot list of a proton plan. - def CalculateBeamDeliveryDynamics(self) -> CalculationResult: - ... - - - # Returns a list of calculation models for the given calculation type. - def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new proton modulated scanning beam to the plan. - def AddModulatedScanningBeam(self, machineParameters: ProtonBeamMachineParameters, snoutId: str, snoutPosition: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See ExternalBeamMachineParameters. - snoutId: Snout ID. - snoutPosition: Snout position in centimeters. - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. - def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: - """ - Args: - existing: The dose matrix is copied from this object. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the - def CreateEvaluationDose(self) -> EvaluationDose: - ... - - - # Get information on whether the plan is optimized using multi-field optimization or single-field optimization. - def GetOptimizationMode(self) -> IonPlanOptimizationMode: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Set the plan normalization. See cref="PlanNormalizationMode" for the supported plan normalization methods. - def SetNormalization(self, normalizationParameters: IonPlanNormalizationParameters) -> None: - """ - Args: - normalizationParameters: Normalization parameters - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Set proton optimization to use either multi-field or single-field optimization. - def SetOptimizationMode(self, mode: IonPlanOptimizationMode) -> None: - """ - Args: - mode: Set the parameter to MultiFieldOptimization to use multi-field optimization and set to SingleFieldOptimization to use single-field optimization. - """ - ... - - - # [Availability of this property depends on your Eclipse Scripting API license] Creates a new proton verification plan that is a copy of this plan and that has dose calculated using the DECT proton stopping power values calculated based on the input images "rhoImage" and "zImage". - def CreateDectVerificationPlan(self, rhoImage: Image, zImage: Image) -> IonPlanSetup: - """ - Args: - rhoImage: A DECT relative electron density image where the value each voxel is interpreted as rho = 0.001 * (value + 1000). - zImage: A DECT effective atomic number image. - """ - ... - - - # This method is used to remove the temporary DECT objects under the DECT-study that was created for intermediate dose calculation. The method should be called only after the dose calculation is done, otherwise the intermediate dose is disposed too early. The temporary objects should be removed because they contain virtual CT images we do not want ending into the database. - def RemoveTemporaryObjects(self) -> Any: - ... - - - # Checks whether the proton volume dose calculation model attached to this plan is Proton Convolution Superposition. - def CheckDectCompatibleDoseCalcModel(self) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam line for the proton plan. - def CalculateBeamLine(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the proton plan. - def CalculateDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the proton plan. - def CalculatePlanUncertaintyDoses(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs IMPT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeIMPT(self, options: OptimizationOptionsIMPT) -> OptimizerResult: - """ - Args: - options: IMPT optimization options. - """ - ... - - - # Post-processes the proton plan by creating a final spot list, and calculates the dose. - def PostProcessAndCalculateDose(self) -> CalculationResult: - ... - - - # Calculates the dose for a proton plan without post-processing. The existing final spot list is used, and no new list is created during the calculation. - def CalculateDoseWithoutPostProcessing(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam delivery dynamics for the final spot list of a proton plan. - def CalculateBeamDeliveryDynamics(self) -> CalculationResult: - ... - - - # Returns a list of calculation models for the given calculation type. - def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new proton modulated scanning beam to the plan. - def AddModulatedScanningBeam(self, machineParameters: ProtonBeamMachineParameters, snoutId: str, snoutPosition: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See ExternalBeamMachineParameters. - snoutId: Snout ID. - snoutPosition: Snout position in centimeters. - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. - def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: - """ - Args: - existing: The dose matrix is copied from this object. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the - def CreateEvaluationDose(self) -> EvaluationDose: - ... - - - # Get information on whether the plan is optimized using multi-field optimization or single-field optimization. - def GetOptimizationMode(self) -> IonPlanOptimizationMode: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Set the plan normalization. See cref="PlanNormalizationMode" for the supported plan normalization methods. - def SetNormalization(self, normalizationParameters: IonPlanNormalizationParameters) -> None: - """ - Args: - normalizationParameters: Normalization parameters - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Set proton optimization to use either multi-field or single-field optimization. - def SetOptimizationMode(self, mode: IonPlanOptimizationMode) -> None: - """ - Args: - mode: Set the parameter to MultiFieldOptimization to use multi-field optimization and set to SingleFieldOptimization to use single-field optimization. - """ - ... - - - -class Dose: - """ - Represents a 3D dose grid. - - Attributes: - DoseMax3D (DoseValue): The maximum dose. - DoseMax3DLocation (VVector): The location of the maximum dose. - Isodoses (List[Isodose]): A collection of isodoses. - Origin (VVector): The origin of the dose matrix. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first dose plane. - Series (Series): Returns the series that contains the dose, or null if the dose is not connected to a series. - SeriesUID (str): Returns the DICOM UID of the series that contains the dose, or an empty string if the dose is not connected to a series. - UID (str): The DICOM UID of the dose. - XDirection (VVector): The direction of the x-axis in the dose matrix. - XRes (float): The dose matrix resolution in X-direction in millimeters. - XSize (int): The dose matrix size in X-direction in voxels. - YDirection (VVector): The direction of the y-axis in the dose matrix. - YRes (float): The dose matrix resolution in Y-direction in millimeters. - YSize (int): The dose matrix size in Y-direction in voxels. - ZDirection (VVector): The direction of the z-axis in the dose matrix. - ZRes (float): The dose matrix resolution in Z-direction in millimeters. - ZSize (int): The dose matrix size in Z-direction in voxels. - DoseMax3D (DoseValue): The maximum dose. - DoseMax3DLocation (VVector): The location of the maximum dose. - Isodoses (List[Isodose]): A collection of isodoses. - Origin (VVector): The origin of the dose matrix. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first dose plane. - Series (Series): Returns the series that contains the dose, or null if the dose is not connected to a series. - SeriesUID (str): Returns the DICOM UID of the series that contains the dose, or an empty string if the dose is not connected to a series. - UID (str): The DICOM UID of the dose. - XDirection (VVector): The direction of the x-axis in the dose matrix. - XRes (float): The dose matrix resolution in X-direction in millimeters. - XSize (int): The dose matrix size in X-direction in voxels. - YDirection (VVector): The direction of the y-axis in the dose matrix. - YRes (float): The dose matrix resolution in Y-direction in millimeters. - YSize (int): The dose matrix size in Y-direction in voxels. - ZDirection (VVector): The direction of the z-axis in the dose matrix. - ZRes (float): The dose matrix resolution in Z-direction in millimeters. - ZSize (int): The dose matrix size in Z-direction in voxels. - """ - def __init__(self) -> None: ... - - DoseMax3D: DoseValue - - DoseMax3DLocation: VVector - - Isodoses: List[Isodose] - - Origin: VVector - - Series: Series - - SeriesUID: str - - UID: str - - XDirection: VVector - - XRes: float - - XSize: int - - YDirection: VVector - - YRes: float - - YSize: int - - ZDirection: VVector - - ZRes: float - - ZSize: int - - DoseMax3D: DoseValue - - DoseMax3DLocation: VVector - - Isodoses: List[Isodose] - - Origin: VVector - - Series: Series - - SeriesUID: str - - UID: str - - XDirection: VVector - - XRes: float - - XSize: int - - YDirection: VVector - - YRes: float - - YSize: int - - ZDirection: VVector - - ZRes: float - - ZSize: int - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Gets the dose profile. - def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # Gets the point dose at a specified location. - def GetDoseToPoint(self, at: VVector) -> DoseValue: - """ - Args: - at: Location - """ - ... - - - # Gets the voxels of the given dose plane. - def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: - """ - Args: - planeIndex: Zero based index of the plane. - preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this dose. - """ - ... - - - # Converts the given raw voxel value to the corresponding dose value. - def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: - """ - Args: - voxelValue: Voxel value. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Gets the dose profile. - def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # Gets the point dose at a specified location. - def GetDoseToPoint(self, at: VVector) -> DoseValue: - """ - Args: - at: Location - """ - ... - - - # Gets the voxels of the given dose plane. - def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: - """ - Args: - planeIndex: Zero based index of the plane. - preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this dose. - """ - ... - - - # Converts the given raw voxel value to the corresponding dose value. - def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: - """ - Args: - voxelValue: Voxel value. - """ - ... - - - -class DVHEstimationModelStructure: - """ - Structure of a DVH estimation model in Planning Model Library - - Attributes: - Id (str): Id of the structure - IsValid (bool): Is Valid - ModelStructureGuid (str): Model Id - StructureCodes (List[StructureCode]): List of structure codes associated with the structure - StructureType (DVHEstimationStructureType): Structure type: PTV or OAR - Id (str): Id of the structure - IsValid (bool): Is Valid - ModelStructureGuid (str): Model Id - StructureCodes (List[StructureCode]): List of structure codes associated with the structure - StructureType (DVHEstimationStructureType): Structure type: PTV or OAR - """ - # Public constructor - @overload - def __init__(self, impl: IDVHEstimationModelStructure) -> None: - """ - Args: - impl: IDVHEstimationModelStructure object - """ - ... - - - # Public constructor - @overload - def __init__(self, impl: IDVHEstimationModelStructure) -> None: - """ - Args: - impl: IDVHEstimationModelStructure object - """ - ... - - - Id: str - - IsValid: bool - - ModelStructureGuid: str - - StructureCodes: List[StructureCode] - - StructureType: DVHEstimationStructureType - - Id: str - - IsValid: bool - - ModelStructureGuid: str - - StructureCodes: List[StructureCode] - - StructureType: DVHEstimationStructureType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Equipment: - """ - Provides access to clinical devices and accessories. - """ - # Equipment object constructor. - @overload - def __init__(self, admin: IAdmin) -> None: - """ - Args: - admin: An IAdmin object for accessing equipment data. - """ - ... - - - # Equipment object constructor. - @overload - def __init__(self, admin: IAdmin) -> None: - """ - Args: - admin: An IAdmin object for accessing equipment data. - """ - ... - - - # Returns the available brachy treatment units. Excludes virtual and deleted ones. - def GetBrachyTreatmentUnits(self) -> List[BrachyTreatmentUnit]: - ... - - - # Returns the available External Beam treatment units. Excludes virtual and deleted ones. - def GetExternalBeamTreatmentUnits(self) -> List[ExternalBeamTreatmentUnit]: - ... - - - # Returns the available brachy treatment units. Excludes virtual and deleted ones. - def GetBrachyTreatmentUnits(self) -> List[BrachyTreatmentUnit]: - ... - - - # Returns the available External Beam treatment units. Excludes virtual and deleted ones. - def GetExternalBeamTreatmentUnits(self) -> List[ExternalBeamTreatmentUnit]: - ... - - - -class ESAPIActionPackAttribute: - """ - Specifies the assembly as an Eclipse visual scripting action pack. Action packs are ESAPI scripts that are used by visual scripts. - - Attributes: - IsWriteable (bool): Returns true if the action pack can modify patient data. - IsWriteable (bool): Returns true if the action pack can modify patient data. - """ - def __init__(self) -> None: ... - - IsWriteable: bool - - IsWriteable: bool - - -class ESAPIScriptAttribute: - """ - Specifies the assembly as an Eclipse Scripting API (ESAPI) script. - - Attributes: - IsWriteable (bool): Returns true if the script can modify patient data. - IsWriteable (bool): Returns true if the script can modify patient data. - """ - def __init__(self) -> None: ... - - IsWriteable: bool - - IsWriteable: bool - - -class OptimizerDVH: - """ - Contains a structure-specific Dose Volume Histogram (DVH) curve generated in optimization. - - Attributes: - CurveData (Array[DVHPoint]): An array of DVH points representing the DVH curve data. - Structure (Structure): The corresponding structure for the DVH curve data. - CurveData (Array[DVHPoint]): An array of DVH points representing the DVH curve data. - Structure (Structure): The corresponding structure for the DVH curve data. - """ - def __init__(self) -> None: ... - - CurveData: Array[DVHPoint] - - Structure: Structure - - CurveData: Array[DVHPoint] - - Structure: Structure - - -class OptimizerObjectiveValue: - """ - The optimizer objective function value for the structure. - - Attributes: - Structure (Structure): The corresponding structure for the objective function value. - Value (float): The objective function value. - Structure (Structure): The corresponding structure for the objective function value. - Value (float): The objective function value. - """ - def __init__(self) -> None: ... - - Structure: Structure - - Value: float - - Structure: Structure - - Value: float - - -class ExternalPlanSetup: - """ - Represents an external beam plan. For more information, see the definition of the DICOM RT Plan. - - Attributes: - TradeoffExplorationContext (TradeoffExplorationContext): [Availability of this property depends on your Eclipse Scripting API license] Gets the - CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. - DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by - TradeoffExplorationContext (TradeoffExplorationContext): [Availability of this property depends on your Eclipse Scripting API license] Gets the - CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. - DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by - """ - def __init__(self) -> None: ... - - TradeoffExplorationContext: TradeoffExplorationContext - - CalculatePlanUncertaintyDose: bool - - DoseAsEvaluationDose: EvaluationDose - - TradeoffExplorationContext: TradeoffExplorationContext - - CalculatePlanUncertaintyDose: bool - - DoseAsEvaluationDose: EvaluationDose - - # Calculates the dose for the plan with preset meterset values. This applies only to IMRT beams. - def CalculateDoseWithPresetValues(self, presetValues: List[KeyValuePair[str, MetersetValue]]) -> CalculationResult: - """ - Args: - presetValues: The list of preset meterset values for the beams. An element of the list should contain a pair consisting of the beam identifier (as the key) and the corresponding preset meterset value for the beam. Each beam in the plan must have one entry in the list. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the plan. - def CalculateDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the photon plan. - def CalculatePlanUncertaintyDoses(self) -> CalculationResult: - ... - - - # Calculate leaf motions and dose using the calculation models defined in the plan setup. - def CalculateLeafMotionsAndDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. - def CalculateLeafMotions(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Leaf Motion Calculator (LMCV). - def CalculateLeafMotions(self, options: LMCVOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the Varian Leaf Motion Calculator (LMCV) algorithm. - """ - ... - - - # Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Smart LMC. - def CalculateLeafMotions(self, options: SmartLMCOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the Varian Smart LMC algorithm. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be MSS Leaf Motion Calculator (LMCMSS). - def CalculateLeafMotions(self, options: LMCMSSOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the MSS Leaf Motion Calculator (LMCMSS) algorithm. - """ - ... - - - # Returns a list of calculation models for the given calculation type. - def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Runs IMRT optimization for the plan setup. All existing optimal fluences are removed from the beams. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - """ - ... - - - # Runs IMRT optimization for the plan setup. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - optimizationOption: Optimization options. - """ - ... - - - # Runs IMRT optimization for the plan setup. You can add the Multileaf Collimator (MLC) as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption, mlcId: str) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - optimizationOption: Optimization option specifying the initial state. - mlcId: The identifier for the Multileaf Collimator (MLC). - """ - ... - - - # Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self) -> OptimizerResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs IMRT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, options: OptimizationOptionsIMRT) -> OptimizerResult: - """ - Args: - options: Options specifying initial state, intermediate dose, and termination upon convergence. - """ - ... - - - # This method is used to remove the temporary copy of the original IPlanSetup object that was created for intermediate dose calculation. The method should be called only after the optimization is done, otherwise the intermediate dose is disposed too early. The temporary copy should be removed because it is copy of an existing plan and this might cause problems when saving other plans to database, e.g., in automated validation tests. The plan is removed in the same way as in the optimization client for Eclipse. - def RemoveTemporaryPlan(self) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. You can add the MLC as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self, mlcId: str) -> OptimizerResult: - """ - Args: - mlcId: The identifier for the Multileaf Collimator (MLC). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self) -> OptimizerResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup using intermediate dose calculation. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self, options: OptimizationOptionsVMAT) -> OptimizerResult: - """ - Args: - options: VMAT optimization options. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam to the plan. - def AddArcBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new conformal arc beam to the plan. - def AddConformalArcBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, controlPointCount: int, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - controlPointCount: The number of control points to use. - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new fixed sequence (flattening sequence) beam to the plan. - def AddFixedSequenceBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, gantryAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds new imaging beam or beams to the plan. First removes the existing imaging beams. If MV imaging beams are involved, the plan should be optimized again. - def AddImagingSetup(self, machineParameters: ExternalBeamMachineParameters, setupParameters: ImagingBeamSetupParameters, targetStructure: Structure) -> bool: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - setupParameters: Setup parameters for the imaging beam. See - targetStructure: Target structure for imaging. If not specified, the target structure in the plan is used. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam with an MLC to the plan. - def AddMLCArcBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam with an MLC to the plan. - def AddMLCBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field with an MLC to the plan. - def AddMLCSetupBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Multiple Static Segments as the delivery technique. - def AddMultipleStaticSegmentBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field to the plan. - def AddSetupBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Sliding Window as the delivery technique. - def AddSlidingWindowBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new sliding window IMRT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. - def AddSlidingWindowBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: Gantry angle in the IEC GANTRY coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static beam to the plan. - def AddStaticBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam to the plan. - def AddVMATBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. - def AddVMATBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryStartAngle: float, gantryStopAngle: float, gantryDir: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryStartAngle: Gantry start angle in the IEC GANTRY coordinate system (in degrees). - gantryStopAngle: Gantry stop angle in the IEC GANTRY coordinate system (in degrees). - gantryDir: Gantry direction - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. - def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: - """ - Args: - existing: The dose matrix is copied from this object. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the - def CreateEvaluationDose(self) -> EvaluationDose: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes a beam from the plan. - def RemoveBeam(self, beam: Beam) -> None: - """ - Args: - beam: The beam that will be removed from the plan. - """ - ... - - - # Calculates the dose for the plan with preset meterset values. This applies only to IMRT beams. - def CalculateDoseWithPresetValues(self, presetValues: List[KeyValuePair[str, MetersetValue]]) -> CalculationResult: - """ - Args: - presetValues: The list of preset meterset values for the beams. An element of the list should contain a pair consisting of the beam identifier (as the key) and the corresponding preset meterset value for the beam. Each beam in the plan must have one entry in the list. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the plan. - def CalculateDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the photon plan. - def CalculatePlanUncertaintyDoses(self) -> CalculationResult: - ... - - - # Calculate leaf motions and dose using the calculation models defined in the plan setup. - def CalculateLeafMotionsAndDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. - def CalculateLeafMotions(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Leaf Motion Calculator (LMCV). - def CalculateLeafMotions(self, options: LMCVOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the Varian Leaf Motion Calculator (LMCV) algorithm. - """ - ... - - - # Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Smart LMC. - def CalculateLeafMotions(self, options: SmartLMCOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the Varian Smart LMC algorithm. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be MSS Leaf Motion Calculator (LMCMSS). - def CalculateLeafMotions(self, options: LMCMSSOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the MSS Leaf Motion Calculator (LMCMSS) algorithm. - """ - ... - - - # Returns a list of calculation models for the given calculation type. - def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Runs IMRT optimization for the plan setup. All existing optimal fluences are removed from the beams. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - """ - ... - - - # Runs IMRT optimization for the plan setup. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - optimizationOption: Optimization options. - """ - ... - - - # Runs IMRT optimization for the plan setup. You can add the Multileaf Collimator (MLC) as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption, mlcId: str) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - optimizationOption: Optimization option specifying the initial state. - mlcId: The identifier for the Multileaf Collimator (MLC). - """ - ... - - - # Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self) -> OptimizerResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs IMRT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, options: OptimizationOptionsIMRT) -> OptimizerResult: - """ - Args: - options: Options specifying initial state, intermediate dose, and termination upon convergence. - """ - ... - - - # This method is used to remove the temporary copy of the original IPlanSetup object that was created for intermediate dose calculation. The method should be called only after the optimization is done, otherwise the intermediate dose is disposed too early. The temporary copy should be removed because it is copy of an existing plan and this might cause problems when saving other plans to database, e.g., in automated validation tests. The plan is removed in the same way as in the optimization client for Eclipse. - def RemoveTemporaryPlan(self) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. You can add the MLC as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self, mlcId: str) -> OptimizerResult: - """ - Args: - mlcId: The identifier for the Multileaf Collimator (MLC). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self) -> OptimizerResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup using intermediate dose calculation. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self, options: OptimizationOptionsVMAT) -> OptimizerResult: - """ - Args: - options: VMAT optimization options. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam to the plan. - def AddArcBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new conformal arc beam to the plan. - def AddConformalArcBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, controlPointCount: int, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - controlPointCount: The number of control points to use. - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new fixed sequence (flattening sequence) beam to the plan. - def AddFixedSequenceBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, gantryAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds new imaging beam or beams to the plan. First removes the existing imaging beams. If MV imaging beams are involved, the plan should be optimized again. - def AddImagingSetup(self, machineParameters: ExternalBeamMachineParameters, setupParameters: ImagingBeamSetupParameters, targetStructure: Structure) -> bool: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - setupParameters: Setup parameters for the imaging beam. See - targetStructure: Target structure for imaging. If not specified, the target structure in the plan is used. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam with an MLC to the plan. - def AddMLCArcBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam with an MLC to the plan. - def AddMLCBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field with an MLC to the plan. - def AddMLCSetupBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Multiple Static Segments as the delivery technique. - def AddMultipleStaticSegmentBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field to the plan. - def AddSetupBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Sliding Window as the delivery technique. - def AddSlidingWindowBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new sliding window IMRT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. - def AddSlidingWindowBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: Gantry angle in the IEC GANTRY coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static beam to the plan. - def AddStaticBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam to the plan. - def AddVMATBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. - def AddVMATBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryStartAngle: float, gantryStopAngle: float, gantryDir: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryStartAngle: Gantry start angle in the IEC GANTRY coordinate system (in degrees). - gantryStopAngle: Gantry stop angle in the IEC GANTRY coordinate system (in degrees). - gantryDir: Gantry direction - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. - def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: - """ - Args: - existing: The dose matrix is copied from this object. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the - def CreateEvaluationDose(self) -> EvaluationDose: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes a beam from the plan. - def RemoveBeam(self, beam: Beam) -> None: - """ - Args: - beam: The beam that will be removed from the plan. - """ - ... - - - -class ReferencePoint: - """ - A reference point associated with a patient. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Reference Point. - DailyDoseLimit (DoseValue): Daily dose limit of this reference point. - SessionDoseLimit (DoseValue): Session dose limit of this reference point. - TotalDoseLimit (DoseValue): Total dose limit of this reference point. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Reference Point. - DailyDoseLimit (DoseValue): Daily dose limit of this reference point. - SessionDoseLimit (DoseValue): Session dose limit of this reference point. - TotalDoseLimit (DoseValue): Total dose limit of this reference point. - """ - def __init__(self) -> None: ... - - Id: str - - DailyDoseLimit: DoseValue - - SessionDoseLimit: DoseValue - - TotalDoseLimit: DoseValue - - Id: str - - DailyDoseLimit: DoseValue - - SessionDoseLimit: DoseValue - - TotalDoseLimit: DoseValue - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add location for reference point into image 'Image' - def AddLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image into which location is inserted - x: x coordinate - y: y coordinate - z: z coordinate - errorHint: Holder for error message if addition fails - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Change location for reference point into image 'Image' - def ChangeLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image into which location is inserted - x: x coordinate in mm - y: y coordinate in mm - z: z coordinate in mm - errorHint: Holder for error message if location cannot be changed - """ - ... - - - # 3D location of this reference point in mm - def GetReferencePointLocation(self, Image: Image) -> VVector: - """ - Args: - Image: Image for which the location is requested - """ - ... - - - # The location of the reference point in mm. - def GetReferencePointLocation(self, planSetup: PlanSetup) -> VVector: - """ - Args: - planSetup: Plan setup that this reference point is connected to. - """ - ... - - - # Tests if a valid reference point location exists. - def HasLocation(self, planSetup: PlanSetup) -> bool: - """ - Args: - planSetup: Plan setup that this reference point is connected to - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove reference point location from image 'Image' - def RemoveLocation(self, Image: Image, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image from which the location for the reference point is removed - errorHint: Holder for error message if removal fails - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add location for reference point into image 'Image' - def AddLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image into which location is inserted - x: x coordinate - y: y coordinate - z: z coordinate - errorHint: Holder for error message if addition fails - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Change location for reference point into image 'Image' - def ChangeLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image into which location is inserted - x: x coordinate in mm - y: y coordinate in mm - z: z coordinate in mm - errorHint: Holder for error message if location cannot be changed - """ - ... - - - # 3D location of this reference point in mm - def GetReferencePointLocation(self, Image: Image) -> VVector: - """ - Args: - Image: Image for which the location is requested - """ - ... - - - # The location of the reference point in mm. - def GetReferencePointLocation(self, planSetup: PlanSetup) -> VVector: - """ - Args: - planSetup: Plan setup that this reference point is connected to. - """ - ... - - - # Tests if a valid reference point location exists. - def HasLocation(self, planSetup: PlanSetup) -> bool: - """ - Args: - planSetup: Plan setup that this reference point is connected to - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove reference point location from image 'Image' - def RemoveLocation(self, Image: Image, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image from which the location for the reference point is removed - errorHint: Holder for error message if removal fails - """ - ... - - - -class SeedCollection: - """ - Represents a collection of brachytherapy - - Attributes: - BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): Obsolete. - Color (Windows.Media.Color): The color of the seeds in the seed collection in the views. - SourcePositions (List[SourcePosition]): The source positions in this collection in creation order. - BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): Obsolete. - Color (Windows.Media.Color): The color of the seeds in the seed collection in the views. - SourcePositions (List[SourcePosition]): The source positions in this collection in creation order. - """ - def __init__(self) -> None: ... - - BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] - - Color: Windows.Media.Color - - SourcePositions: List[SourcePosition] - - BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] - - Color: Windows.Media.Color - - SourcePositions: List[SourcePosition] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class SourcePosition: - """ - Represents a brachytherapy source dwell position in a - - Attributes: - DwellTime (float): Dwell time. - DwellTimeLock (Optional[bool]): Identifies if the dwell time is locked. Set dwell time either locked = true, or unlocked = false. Locked when not allowed to change the dwell time. If unlocked, the dwell time can be changed. - NominalDwellTime (float): The nominal dwell time associated with this source position in seconds. - RadioactiveSource (RadioactiveSource): The radioactive source associated with this dwell position. - Transform (Array[float]): The 4x4 transformation matrix represents the orientation and location of the source position in space. The matrix is composed of a 4x3 rotation submatrix and a 4x1 translation vector. Its bottom row indicates scaling and is always [0 0 0 1]. The translation vector indicates the coordinates of the source position center, in millimeters. The third column of the rotation matrix indicates the source axis direction. - Translation (VVector): The translation of this source position. - DwellTime (float): Dwell time. - DwellTimeLock (Optional[bool]): Identifies if the dwell time is locked. Set dwell time either locked = true, or unlocked = false. Locked when not allowed to change the dwell time. If unlocked, the dwell time can be changed. - NominalDwellTime (float): The nominal dwell time associated with this source position in seconds. - RadioactiveSource (RadioactiveSource): The radioactive source associated with this dwell position. - Transform (Array[float]): The 4x4 transformation matrix represents the orientation and location of the source position in space. The matrix is composed of a 4x3 rotation submatrix and a 4x1 translation vector. Its bottom row indicates scaling and is always [0 0 0 1]. The translation vector indicates the coordinates of the source position center, in millimeters. The third column of the rotation matrix indicates the source axis direction. - Translation (VVector): The translation of this source position. - """ - def __init__(self) -> None: ... - - DwellTime: float - - DwellTimeLock: Optional[bool] - - NominalDwellTime: float - - RadioactiveSource: RadioactiveSource - - Transform: Array[float] - - Translation: VVector - - DwellTime: float - - DwellTimeLock: Optional[bool] - - NominalDwellTime: float - - RadioactiveSource: RadioactiveSource - - Transform: Array[float] - - Translation: VVector - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class StructureCode: - """ - Represents a structure code and its coding scheme. - - Attributes: - Code (str): The structure code as defined in the associated coding scheme. - CodeMeaning (str): The meaning of the structure code. - CodingScheme (str): The coding scheme of the structure code. - DisplayName (str): The display name of the code. - IsEncompassStructureCode (bool): Indicates whether the structure code is an encompass structure code. - Code (str): The structure code as defined in the associated coding scheme. - CodeMeaning (str): The meaning of the structure code. - CodingScheme (str): The coding scheme of the structure code. - DisplayName (str): The display name of the code. - IsEncompassStructureCode (bool): Indicates whether the structure code is an encompass structure code. - """ - def __init__(self) -> None: ... - - Code: str - - CodeMeaning: str - - CodingScheme: str - - DisplayName: str - - IsEncompassStructureCode: bool - - Code: str - - CodeMeaning: str - - CodingScheme: str - - DisplayName: str - - IsEncompassStructureCode: bool - - # Returns a StructureCodeInfo object with the same coding scheme and code as in the current structure code object. - def ToStructureCodeInfo(self) -> StructureCodeInfo: - ... - - - # Determines whether this structure code is considered equal to the specified structure code. - def Equals(self, other: StructureCode) -> bool: - ... - - - # Determines whether the current object is considered equal to the specified object. - def Equals(self, obj: StructureCode) -> bool: - ... - - - # The equality operator. - def op_Equality(self, sc1: StructureCode, sc2: StructureCode) -> bool: - ... - - - # The inequality operator. - def op_Inequality(self, sc1: StructureCode, sc2: StructureCode) -> bool: - ... - - - # Returns a string that represents this object. - def ToString(self) -> str: - ... - - - # Returns the hash code for this structure code. - def GetHashCode(self) -> int: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns a StructureCodeInfo object with the same coding scheme and code as in the current structure code object. - def ToStructureCodeInfo(self) -> StructureCodeInfo: - ... - - - # Determines whether this structure code is considered equal to the specified structure code. - def Equals(self, other: StructureCode) -> bool: - ... - - - # Determines whether the current object is considered equal to the specified object. - def Equals(self, obj: StructureCode) -> bool: - ... - - - # The equality operator. - def op_Equality(self, sc1: StructureCode, sc2: StructureCode) -> bool: - ... - - - # The inequality operator. - def op_Inequality(self, sc1: StructureCode, sc2: StructureCode) -> bool: - ... - - - # Returns a string that represents this object. - def ToString(self) -> str: - ... - - - # Returns the hash code for this structure code. - def GetHashCode(self) -> int: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class StructureCodeDictionary: - """ - Represents a set of structure codes as defined by a structure code scheme. The class exposes the structure codes that are available through the implemented - - Attributes: - Name (str): The name of the structure code scheme. - Version (str): The version of the structure code scheme. May be an empty string, if not applicable to the scheme. - Keys (List[str]): Gets a collection containing the structure code identifiers in this structure code dictionary. - Values (List[StructureCode]): Gets a collection containing the structure codes in this structure code dictionary. - Count (int): Gets the number of structure code object key/value pairs in this structure code dictionary. - Name (str): The name of the structure code scheme. - Version (str): The version of the structure code scheme. May be an empty string, if not applicable to the scheme. - Keys (List[str]): Gets a collection containing the structure code identifiers in this structure code dictionary. - Values (List[StructureCode]): Gets a collection containing the structure codes in this structure code dictionary. - Count (int): Gets the number of structure code object key/value pairs in this structure code dictionary. - """ - def __init__(self) -> None: ... - - Name: str - - Version: str - - Keys: List[str] - - Values: List[StructureCode] - - Count: int - - Name: str - - Version: str - - Keys: List[str] - - Values: List[StructureCode] - - Count: int - - # Determines whether the scheme contains the specified key as an active structure code identifier. - def ContainsKey(self, key: str) -> bool: - ... - - - # Gets the structure code object associated with the specified structure code identifier (key). - def TryGetValue(self, key: str, value: StructureCode) -> bool: - """ - Args: - key: The structure code identifier. - value: When the method returns, contains the specified structure code object, if it is found, otherwise null. - """ - ... - - - # Returns an enumerator that iterates through the collection. - def GetEnumerator(self) -> Iterable[KeyValuePair[str, StructureCode]]: - ... - - - # Returns a string that represents this object. - def ToString(self) -> str: - ... - - - # Determines whether the scheme contains the specified key as an active structure code identifier. - def ContainsKey(self, key: str) -> bool: - ... - - - # Gets the structure code object associated with the specified structure code identifier (key). - def TryGetValue(self, key: str, value: StructureCode) -> bool: - """ - Args: - key: The structure code identifier. - value: When the method returns, contains the specified structure code object, if it is found, otherwise null. - """ - ... - - - # Returns an enumerator that iterates through the collection. - def GetEnumerator(self) -> Iterable[KeyValuePair[str, StructureCode]]: - ... - - - # Returns a string that represents this object. - def ToString(self) -> str: - ... - - - -class ActiveStructureCodeDictionaries: - """ - Provides access to the structure code dictionaries with the active structure codes. - - Attributes: - Fma (StructureCodeDictionary): The Foundational Model of Anatomy Ontology structure scheme. - RadLex (StructureCodeDictionary): The RSNA RadLex radiology lexicon structure scheme. - Srt (StructureCodeDictionary): The SNOMED RT structure scheme. - VmsStructCode (StructureCodeDictionary): The Varian 99VMS_STRUCTCODE structure scheme. - Fma (StructureCodeDictionary): The Foundational Model of Anatomy Ontology structure scheme. - RadLex (StructureCodeDictionary): The RSNA RadLex radiology lexicon structure scheme. - Srt (StructureCodeDictionary): The SNOMED RT structure scheme. - VmsStructCode (StructureCodeDictionary): The Varian 99VMS_STRUCTCODE structure scheme. - """ - # Constructs a new ActiveStructureCodeDictionaries instance. - @overload - def __init__(self, providerFunc: Func[str, IReadOnlyDictionary[str, IStructureCode]]) -> None: - ... - - - # Constructs a new ActiveStructureCodeDictionaries instance. - @overload - def __init__(self, providerFunc: Func[str, IReadOnlyDictionary[str, IStructureCode]]) -> None: - ... - - - Fma: StructureCodeDictionary - - RadLex: StructureCodeDictionary - - Srt: StructureCodeDictionary - - VmsStructCode: StructureCodeDictionary - - Fma: StructureCodeDictionary - - RadLex: StructureCodeDictionary - - Srt: StructureCodeDictionary - - VmsStructCode: StructureCodeDictionary - - -class TradeoffPlanGenerationIntermediateDoseMode: - """ - Enumeration that specifies the use of intermediate dose when optimizing a plan collection for trade-off exploring. - """ - def __init__(self) -> None: ... - - -class Image: - """ - Represents a 2D or 3D image, which can be a DRR, a CT, MR, or other volumetric dataset. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the image. - ApprovalHistory (List[ImageApprovalHistoryEntry]): Returns the approval history of the image. - ContrastBolusAgentIngredientName (str): The name of the contrast bolus agent ingredient that is used in the image. If the value has not been specified, returns null. - CreationDateTime (Optional[datetime]): The date when this object was created. - DisplayUnit (str): The name of the display unit in which the voxels of the image are shown in the user interface. - FOR (str): The UID of the frame of reference. - HasUserOrigin (bool): Defines if a user origin has been specified for the image. - ImageType (str): The type of the image as indicated in the properties of the image slices. - ImagingDeviceId (str): Identification of the device that is used to scan the images into the system. - ImagingOrientation (PatientOrientation): The orientation of the patient. - ImagingOrientationAsString (str): The orientation of the patient as a string (localized) - IsProcessed (bool): Returns the value true if an image processing filter is in use for the image. - Level (int): The level setting. The value is given in the internal voxel scale. - Modality (SeriesModality): The modality of the image as indicated in the properties of the image slices. - Origin (VVector): The origin of the image. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first image plane. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - Series (Series): Used for navigating to parent series. - UID (str): Return UID of the first (and the only) slice in case of a 2D Image. Return null in case of a 3D Image. - UserOrigin (VVector): The user origin in DICOM coordinates in millimeter. - UserOriginComments (str): The text typed on the Origin tab in the Image Properties dialog box. - Window (int): The window setting. The value is given in the internal voxel scale. - XDirection (VVector): The direction of the x-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - XRes (float): The image resolution in X-direction in millimeters. - XSize (int): The image size in X-direction in voxels. - YDirection (VVector): The direction of the y-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - YRes (float): The image resolution in Y-direction in millimeters. - YSize (int): The image size in Y-direction in voxels. - ZDirection (VVector): The direction of the z-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - ZRes (float): The image resolution in Z-direction in millimeters. - ZSize (int): The image size in Z-direction in voxels. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the image. - ApprovalHistory (List[ImageApprovalHistoryEntry]): Returns the approval history of the image. - ContrastBolusAgentIngredientName (str): The name of the contrast bolus agent ingredient that is used in the image. If the value has not been specified, returns null. - CreationDateTime (Optional[datetime]): The date when this object was created. - DisplayUnit (str): The name of the display unit in which the voxels of the image are shown in the user interface. - FOR (str): The UID of the frame of reference. - HasUserOrigin (bool): Defines if a user origin has been specified for the image. - ImageType (str): The type of the image as indicated in the properties of the image slices. - ImagingDeviceId (str): Identification of the device that is used to scan the images into the system. - ImagingOrientation (PatientOrientation): The orientation of the patient. - ImagingOrientationAsString (str): The orientation of the patient as a string (localized) - IsProcessed (bool): Returns the value true if an image processing filter is in use for the image. - Level (int): The level setting. The value is given in the internal voxel scale. - Modality (SeriesModality): The modality of the image as indicated in the properties of the image slices. - Origin (VVector): The origin of the image. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first image plane. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - Series (Series): Used for navigating to parent series. - UID (str): Return UID of the first (and the only) slice in case of a 2D Image. Return null in case of a 3D Image. - UserOrigin (VVector): The user origin in DICOM coordinates in millimeter. - UserOriginComments (str): The text typed on the Origin tab in the Image Properties dialog box. - Window (int): The window setting. The value is given in the internal voxel scale. - XDirection (VVector): The direction of the x-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - XRes (float): The image resolution in X-direction in millimeters. - XSize (int): The image size in X-direction in voxels. - YDirection (VVector): The direction of the y-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - YRes (float): The image resolution in Y-direction in millimeters. - YSize (int): The image size in Y-direction in voxels. - ZDirection (VVector): The direction of the z-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - ZRes (float): The image resolution in Z-direction in millimeters. - ZSize (int): The image size in Z-direction in voxels. - """ - def __init__(self) -> None: ... - - Id: str - - ApprovalHistory: List[ImageApprovalHistoryEntry] - - ContrastBolusAgentIngredientName: str - - CreationDateTime: Optional[datetime] - - DisplayUnit: str - - FOR: str - - HasUserOrigin: bool - - ImageType: str - - ImagingDeviceId: str - - ImagingOrientation: PatientOrientation - - ImagingOrientationAsString: str - - IsProcessed: bool - - Level: int - - Modality: SeriesModality - - Origin: VVector - - Series: Series - - UID: str - - UserOrigin: VVector - - UserOriginComments: str - - Window: int - - XDirection: VVector - - XRes: float - - XSize: int - - YDirection: VVector - - YRes: float - - YSize: int - - ZDirection: VVector - - ZRes: float - - ZSize: int - - Id: str - - ApprovalHistory: List[ImageApprovalHistoryEntry] - - ContrastBolusAgentIngredientName: str - - CreationDateTime: Optional[datetime] - - DisplayUnit: str - - FOR: str - - HasUserOrigin: bool - - ImageType: str - - ImagingDeviceId: str - - ImagingOrientation: PatientOrientation - - ImagingOrientationAsString: str - - IsProcessed: bool - - Level: int - - Modality: SeriesModality - - Origin: VVector - - Series: Series - - UID: str - - UserOrigin: VVector - - UserOriginComments: str - - Window: int - - XDirection: VVector - - XRes: float - - XSize: int - - YDirection: VVector - - YRes: float - - YSize: int - - ZDirection: VVector - - ZRes: float - - ZSize: int - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns the voxel-wise DECT proton stopping powers of the given image plane calculated from the current image and the rho and Z images. The image FOR, size, and resolution for the rho and Z images must conform with this image. - def CalculateDectProtonStoppingPowers(self, rhoImage: Image, zImage: Image, planeIndex: int, preallocatedBuffer: Array[float]) -> None: - """ - Args: - rhoImage: A DECT relative electron density image. The electron density is interpreted from the image values as rho = 0.001 * (value + 1000). - zImage: A DECT effective atomic number image. - planeIndex: Zero based index of the plane. - preallocatedBuffer: Pre-allocated buffer where the proton stopping power values are stored. The size of the buffer must conform with the X- and Y-size of this image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new structure set. If the image does not yet have a structure set, the new structure set will be assigned directly to it. If the image already has a structure set, a copy of this image is made, and the new structure set is assigned to the copy. The image must be a 3D image. - def CreateNewStructureSet(self) -> StructureSet: - ... - - - # Converts DICOM coordinates to the planning coordinate system used in the Eclipse user interface. - def DicomToUser(self, dicom: VVector, planSetup: PlanSetup) -> VVector: - """ - Args: - dicom: Coordinate value in DICOM coordinate system. - planSetup: Plan that defines the planning orientation or null. - """ - ... - - - # Gets the image profile. - def GetImageProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> ImageProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # Returns the HU to proton stopping power curve associated with the image. - def GetProtonStoppingPowerCurve(self, protonStoppingPowerCurve: SortedList[float, float]) -> bool: - """ - Args: - protonStoppingPowerCurve: An empty list where the curve values will be stored. - """ - ... - - - # Gets the voxels of the given image plane. - def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: - """ - Args: - planeIndex: Zero based index of the plane. - preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this image. - """ - ... - - - # Converts a coordinate value from the planning coordinate system used in the Eclipse user interface to DICOM coordinates. - def UserToDicom(self, user: VVector, planSetup: PlanSetup) -> VVector: - """ - Args: - user: Coordinate value in the planning coordinate system. - planSetup: Plan that defines the planning orientation or null. - """ - ... - - - # Converts the given raw voxel value to the corresponding value in the user interface display unit, for example, HU, Bq/ml. - def VoxelToDisplayValue(self, voxelValue: int) -> float: - """ - Args: - voxelValue: Voxel value. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns the voxel-wise DECT proton stopping powers of the given image plane calculated from the current image and the rho and Z images. The image FOR, size, and resolution for the rho and Z images must conform with this image. - def CalculateDectProtonStoppingPowers(self, rhoImage: Image, zImage: Image, planeIndex: int, preallocatedBuffer: Array[float]) -> None: - """ - Args: - rhoImage: A DECT relative electron density image. The electron density is interpreted from the image values as rho = 0.001 * (value + 1000). - zImage: A DECT effective atomic number image. - planeIndex: Zero based index of the plane. - preallocatedBuffer: Pre-allocated buffer where the proton stopping power values are stored. The size of the buffer must conform with the X- and Y-size of this image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new structure set. If the image does not yet have a structure set, the new structure set will be assigned directly to it. If the image already has a structure set, a copy of this image is made, and the new structure set is assigned to the copy. The image must be a 3D image. - def CreateNewStructureSet(self) -> StructureSet: - ... - - - # Converts DICOM coordinates to the planning coordinate system used in the Eclipse user interface. - def DicomToUser(self, dicom: VVector, planSetup: PlanSetup) -> VVector: - """ - Args: - dicom: Coordinate value in DICOM coordinate system. - planSetup: Plan that defines the planning orientation or null. - """ - ... - - - # Gets the image profile. - def GetImageProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> ImageProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # Returns the HU to proton stopping power curve associated with the image. - def GetProtonStoppingPowerCurve(self, protonStoppingPowerCurve: SortedList[float, float]) -> bool: - """ - Args: - protonStoppingPowerCurve: An empty list where the curve values will be stored. - """ - ... - - - # Gets the voxels of the given image plane. - def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: - """ - Args: - planeIndex: Zero based index of the plane. - preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this image. - """ - ... - - - # Converts a coordinate value from the planning coordinate system used in the Eclipse user interface to DICOM coordinates. - def UserToDicom(self, user: VVector, planSetup: PlanSetup) -> VVector: - """ - Args: - user: Coordinate value in the planning coordinate system. - planSetup: Plan that defines the planning orientation or null. - """ - ... - - - # Converts the given raw voxel value to the corresponding value in the user interface display unit, for example, HU, Bq/ml. - def VoxelToDisplayValue(self, voxelValue: int) -> float: - """ - Args: - voxelValue: Voxel value. - """ - ... - - - -class IDVHEstimationCalculator: - """ - Interface to the calculation of the DVH Estimates - """ - def __init__(self) -> None: ... - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - -class IonBeamParameters: - """ - An editable copy of the parameters of a proton beam. - - Attributes: - ControlPoints (List[IonControlPointParameters]): Editable control point parameters copied from the treatment beam. - PreSelectedRangeShifter1Id (str): ID of the pre-selected range shifter 1 in the field. - PreSelectedRangeShifter1Setting (str): Setting of the pre-selected range shifter 1 in the field. - PreSelectedRangeShifter2Id (str): ID of the pre-selected range shifter 2 in the field. - PreSelectedRangeShifter2Setting (str): Setting of the pre-selected range shifter 2 in the field. - IonControlPointPairs (IonControlPointPairCollection): A copy of editable control point pairs. - SnoutId (str): The snout identifier. Returns null if undefined. - SnoutPosition (float): Snout position in centimeters. - TargetStructure (Structure): Target structure of the field. - ControlPoints (List[IonControlPointParameters]): Editable control point parameters copied from the treatment beam. - PreSelectedRangeShifter1Id (str): ID of the pre-selected range shifter 1 in the field. - PreSelectedRangeShifter1Setting (str): Setting of the pre-selected range shifter 1 in the field. - PreSelectedRangeShifter2Id (str): ID of the pre-selected range shifter 2 in the field. - PreSelectedRangeShifter2Setting (str): Setting of the pre-selected range shifter 2 in the field. - IonControlPointPairs (IonControlPointPairCollection): A copy of editable control point pairs. - SnoutId (str): The snout identifier. Returns null if undefined. - SnoutPosition (float): Snout position in centimeters. - TargetStructure (Structure): Target structure of the field. - - Note: - To apply the parameters, call the - """ - def __init__(self) -> None: ... - - ControlPoints: List[IonControlPointParameters] - - PreSelectedRangeShifter1Id: str - - PreSelectedRangeShifter1Setting: str - - PreSelectedRangeShifter2Id: str - - PreSelectedRangeShifter2Setting: str - - IonControlPointPairs: IonControlPointPairCollection - - SnoutId: str - - SnoutPosition: float - - TargetStructure: Structure - - ControlPoints: List[IonControlPointParameters] - - PreSelectedRangeShifter1Id: str - - PreSelectedRangeShifter1Setting: str - - PreSelectedRangeShifter2Id: str - - PreSelectedRangeShifter2Setting: str - - IonControlPointPairs: IonControlPointPairCollection - - SnoutId: str - - SnoutPosition: float - - TargetStructure: Structure - - -class OptimizationControllerIMPT: - """ - Controls the IMPT optimization from the Script - """ - def __init__(self) -> None: ... - -class OptimizationControllerIMRT: - """ - Controls the IMRT optimization from the Script - """ - def __init__(self) -> None: ... - -class OptimizationControllerVMAT: - """ - Controls the VMAT optimization from the Script - """ - def __init__(self) -> None: ... - -class OptimizationSetup: - """ - Gives access to the optimization parameters and objectives. - - Attributes: - UseJawTracking (bool): [Availability of this property depends on your Eclipse Scripting API license] Jaw tracking parameter for VMAT optimization. The parameter can only be set for plans to be delivered with a treatment machine that supports jaw tracking. - Objectives (List[OptimizationObjective]): A collection of optimization objectives. - Parameters (List[OptimizationParameter]): A collection of optimization parameters. - UseJawTracking (bool): [Availability of this property depends on your Eclipse Scripting API license] Jaw tracking parameter for VMAT optimization. The parameter can only be set for plans to be delivered with a treatment machine that supports jaw tracking. - Objectives (List[OptimizationObjective]): A collection of optimization objectives. - Parameters (List[OptimizationParameter]): A collection of optimization parameters. - """ - def __init__(self) -> None: ... - - UseJawTracking: bool - - Objectives: List[OptimizationObjective] - - Parameters: List[OptimizationParameter] - - UseJawTracking: bool - - Objectives: List[OptimizationObjective] - - Parameters: List[OptimizationParameter] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. - def AddAutomaticNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic SBRT normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. - def AddAutomaticSbrtNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam-specific parameter for IMRT optimization. - def AddBeamSpecificParameter(self, beam: Beam, smoothX: float, smoothY: float, fixedJaws: bool) -> OptimizationIMRTBeamParameter: - """ - Args: - beam: The beam for which the parameters are added. - smoothX: A fluence-smoothing parameter in X-direction. - smoothY: A fluence-smoothing parameter in Y-direction. - fixedJaws: If true, the collimator jaw positions of the beam remain the same during the optimization. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new gEUD objective. - def AddEUDObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, parameterA: float, priority: float) -> OptimizationEUDObjective: - """ - Args: - structure: The target structure of the objective. - objectiveOperator: The type of the gEUD objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - parameterA: gEUD parameter a. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new mean dose objective. - def AddMeanDoseObjective(self, structure: Structure, dose: DoseValue, priority: float) -> OptimizationMeanDoseObjective: - """ - Args: - structure: The target structure of the objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. - def AddNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float, fallOff: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - fallOff: Determines the steepness of the normal tissue objective fall-off. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new point objective. - def AddPointObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, volume: float, priority: float) -> OptimizationPointObjective: - """ - Args: - structure: The target structure of the objective. - objectiveOperator: The type of the dose-volume objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - volume: The volume of the objective. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) for a proton plan or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. - def AddProtonNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization objective. - def RemoveObjective(self, objective: OptimizationObjective) -> None: - """ - Args: - objective: The objective that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization parameter. - def RemoveParameter(self, parameter: OptimizationParameter) -> None: - """ - Args: - parameter: The parameter that is removed. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. - def AddAutomaticNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic SBRT normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. - def AddAutomaticSbrtNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam-specific parameter for IMRT optimization. - def AddBeamSpecificParameter(self, beam: Beam, smoothX: float, smoothY: float, fixedJaws: bool) -> OptimizationIMRTBeamParameter: - """ - Args: - beam: The beam for which the parameters are added. - smoothX: A fluence-smoothing parameter in X-direction. - smoothY: A fluence-smoothing parameter in Y-direction. - fixedJaws: If true, the collimator jaw positions of the beam remain the same during the optimization. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new gEUD objective. - def AddEUDObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, parameterA: float, priority: float) -> OptimizationEUDObjective: - """ - Args: - structure: The target structure of the objective. - objectiveOperator: The type of the gEUD objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - parameterA: gEUD parameter a. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new mean dose objective. - def AddMeanDoseObjective(self, structure: Structure, dose: DoseValue, priority: float) -> OptimizationMeanDoseObjective: - """ - Args: - structure: The target structure of the objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. - def AddNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float, fallOff: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - fallOff: Determines the steepness of the normal tissue objective fall-off. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new point objective. - def AddPointObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, volume: float, priority: float) -> OptimizationPointObjective: - """ - Args: - structure: The target structure of the objective. - objectiveOperator: The type of the dose-volume objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - volume: The volume of the objective. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) for a proton plan or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. - def AddProtonNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization objective. - def RemoveObjective(self, objective: OptimizationObjective) -> None: - """ - Args: - objective: The objective that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization parameter. - def RemoveParameter(self, parameter: OptimizationParameter) -> None: - """ - Args: - parameter: The parameter that is removed. - """ - ... - - - -class CalculationResult: - """ - Holds the result of the calculation (pass/fail). - - Attributes: - Success (bool): Returns true if calculation did not return any errors. Otherwise returns false. - Success (bool): Returns true if calculation did not return any errors. Otherwise returns false. - """ - def __init__(self) -> None: ... - - Success: bool - - Success: bool - - -class OptimizerResult: - """ - Holds the result of the optimization (pass/fail). - - Attributes: - StructureDVHs (List[OptimizerDVH]): A list of Dose Volume Histogram (DVH) curves for structures. - StructureObjectiveValues (List[OptimizerObjectiveValue]): The list of objective function values per structure. - TotalObjectiveFunctionValue (float): The total objective function value for the optimization. - NumberOfIMRTOptimizerIterations (int): The number of iterations taken by the IMRT optimizer. - StructureDVHs (List[OptimizerDVH]): A list of Dose Volume Histogram (DVH) curves for structures. - StructureObjectiveValues (List[OptimizerObjectiveValue]): The list of objective function values per structure. - TotalObjectiveFunctionValue (float): The total objective function value for the optimization. - NumberOfIMRTOptimizerIterations (int): The number of iterations taken by the IMRT optimizer. - """ - def __init__(self) -> None: ... - - StructureDVHs: List[OptimizerDVH] - - StructureObjectiveValues: List[OptimizerObjectiveValue] - - TotalObjectiveFunctionValue: float - - NumberOfIMRTOptimizerIterations: int - - StructureDVHs: List[OptimizerDVH] - - StructureObjectiveValues: List[OptimizerObjectiveValue] - - TotalObjectiveFunctionValue: float - - NumberOfIMRTOptimizerIterations: int - - -class PlanSetup: - """ - Represents a treatment plan. See the definition of a DICOM RT Plan for more information. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSetup. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Plan. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Plan. - PlanNormalizationValue (float): [Availability of this property depends on your Eclipse Scripting API license] The plan normalization value in percentage. The plan is normalized according to the plan normalization value, for instance, 200%. The value is Double.NaN if it is not defined. - PlanUncertainties (List[PlanUncertainty]): Plan uncertainties defined for the plan. - PlanObjectiveStructures (List[str]): The list of structure IDs that are present in the plan objectives (prescriptions and indices). - ApprovalHistory (List[ApprovalHistoryEntry]): Returns the approval history of the plan setup. - DosePerFractionInPrimaryRefPoint (DoseValue): The calculated fraction dose in the primary reference point. - PrescribedDosePerFraction (DoseValue): The prescribed fraction dose. - PrescribedPercentage (float): The prescribed dose percentage as a decimal number. For example, if the prescribed dose percentage shown in the Eclipse user interface is 80 %, returns 0.8 - TotalPrescribedDose (DoseValue): The total prescribed dose. - ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the plan. - ApprovalStatus (PlanSetupApprovalStatus): The approval status. - ApprovalStatusAsString (str): Returns the approval status as a string (localized). - BaseDosePlanningItem (PlanningItem): BaseDose for the optimization, can be either plan or plan sum. - Beams (List[Beam]): A collection of all the beams in the plan (including setup beams). Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. - BeamsInTreatmentOrder (List[Beam]): A collection of all the beams in the plan (including setup beams) in treatment order. Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. - CreationUserName (str): The name of the user who saved the plan for the first time. - DosePerFraction (DoseValue): The dose per fraction. - DVHEstimates (List[EstimatedDVH]): Returns a list of DVH estimate objects for this plan - ElectronCalculationModel (str): The name of the electron calculation model. Not applicable to brachytherapy plans. - ElectronCalculationOptions (Dict[str, str]): The electron calculation options. Not applicable to brachytherapy plans. - IntegrityHash (str): Returns the plan's integrity hash. Returns null if the plan's integrity hash has not been set. - IsDoseValid (bool): Returns the value true if the plan dose is valid. This implies that the dose object returned from the dose property is not null and can therefore be used to query dose values. - IsTreated (bool): Checks if the treatment plan has been delivered. - NumberOfFractions (Optional[int]): The number of fractions. - OptimizationSetup (OptimizationSetup): Provides access to optimization objectives and parameters. - PatientSupportDevice (PatientSupportDevice): Patient support device. - PhotonCalculationModel (str): The name of the photon calculation model. Not applicable to brachytherapy plans. - PhotonCalculationOptions (Dict[str, str]): The photon calculation options. Not applicable to brachytherapy plans. - PlanIntent (str): The plan intent as in DICOM, or an empty string. The defined terms are "CURATIVE", "PALLIATIVE", "PROPHYLACTIC", "VERIFICATION", "MACHINE_QA", "RESEARCH" and "SERVICE", but the value can be different for imported plans. - PlanIsInTreatment (bool): Checks if plan is loaded into console. - PlannedDosePerFraction (DoseValue): The calculated fraction dose in the primary reference point. - PlanningApprovalDate (str): The date when the plan was approved for planning. - PlanningApprover (str): The identifier of the user who approved the plan for planning. - PlanningApproverDisplayName (str): The display name of the user who approved the plan for planning. - PlanNormalizationMethod (str): The user interface name for the current normalization method. - PlanNormalizationPoint (VVector): The plan normalization point. - PlanType (PlanType): The plan type. - PredecessorPlan (PlanSetup): The prior revision of the plan - PredecessorPlanUID (str): The UID of the predecessor plan. - PrimaryReferencePoint (ReferencePoint): The primary reference point. - ProtocolID (str): The protocol identifier. - ProtocolPhaseID (str): The protocol phase identifier. - ProtonCalculationModel (str): The name of the proton calculation model. Not applicable to brachytherapy plans. - ProtonCalculationOptions (Dict[str, str]): The proton calculation options. Not applicable to brachytherapy plans. - ReferencePoints (List[ReferencePoint]): Collection of reference points in the plan. - RTPrescription (RTPrescription): Used for navigating to the linked prescription. - Series (Series): The series that contains this plan. Null if the plan is not connected to a series. - SeriesUID (str): The DICOM UID of the series that contains this plan. Empty string if the plan is not connected to a series. - TargetVolumeID (str): The target volume identifier. - TotalDose (DoseValue): Planned total dose. - TreatmentApprovalDate (str): The date when the plan was approved for treatment. - TreatmentApprover (str): The identifier of the user who approved the plan for treatment. - TreatmentApproverDisplayName (str): The display name of the user who approved the plan for treatment. - TreatmentOrientation (PatientOrientation): The orientation of the treatment. - TreatmentOrientationAsString (str): The orientation of the treatment as a string (localized). - TreatmentPercentage (float): The treatment percentage as a decimal number. For example, if the treatment percentage shown in the Eclipse user interface is 80%, returns 0.8. - TreatmentSessions (List[PlanTreatmentSession]): Treatment sessions for the plan, either scheduled sessions or treated sessions. - UID (str): The DICOM UID of the plan. - UseGating (bool): Boolean to mark if gating is used in the plan. - VerifiedPlan (PlanSetup): Returns the verified plan if this is a verification plan, otherwise returns null. The verified plan is the clinical plan that was used to create the verification plan. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSetup. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Plan. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Plan. - PlanNormalizationValue (float): [Availability of this property depends on your Eclipse Scripting API license] The plan normalization value in percentage. The plan is normalized according to the plan normalization value, for instance, 200%. The value is Double.NaN if it is not defined. - PlanUncertainties (List[PlanUncertainty]): Plan uncertainties defined for the plan. - PlanObjectiveStructures (List[str]): The list of structure IDs that are present in the plan objectives (prescriptions and indices). - ApprovalHistory (List[ApprovalHistoryEntry]): Returns the approval history of the plan setup. - DosePerFractionInPrimaryRefPoint (DoseValue): The calculated fraction dose in the primary reference point. - PrescribedDosePerFraction (DoseValue): The prescribed fraction dose. - PrescribedPercentage (float): The prescribed dose percentage as a decimal number. For example, if the prescribed dose percentage shown in the Eclipse user interface is 80 %, returns 0.8 - TotalPrescribedDose (DoseValue): The total prescribed dose. - ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the plan. - ApprovalStatus (PlanSetupApprovalStatus): The approval status. - ApprovalStatusAsString (str): Returns the approval status as a string (localized). - BaseDosePlanningItem (PlanningItem): BaseDose for the optimization, can be either plan or plan sum. - Beams (List[Beam]): A collection of all the beams in the plan (including setup beams). Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. - BeamsInTreatmentOrder (List[Beam]): A collection of all the beams in the plan (including setup beams) in treatment order. Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. - CreationUserName (str): The name of the user who saved the plan for the first time. - DosePerFraction (DoseValue): The dose per fraction. - DVHEstimates (List[EstimatedDVH]): Returns a list of DVH estimate objects for this plan - ElectronCalculationModel (str): The name of the electron calculation model. Not applicable to brachytherapy plans. - ElectronCalculationOptions (Dict[str, str]): The electron calculation options. Not applicable to brachytherapy plans. - IntegrityHash (str): Returns the plan's integrity hash. Returns null if the plan's integrity hash has not been set. - IsDoseValid (bool): Returns the value true if the plan dose is valid. This implies that the dose object returned from the dose property is not null and can therefore be used to query dose values. - IsTreated (bool): Checks if the treatment plan has been delivered. - NumberOfFractions (Optional[int]): The number of fractions. - OptimizationSetup (OptimizationSetup): Provides access to optimization objectives and parameters. - PatientSupportDevice (PatientSupportDevice): Patient support device. - PhotonCalculationModel (str): The name of the photon calculation model. Not applicable to brachytherapy plans. - PhotonCalculationOptions (Dict[str, str]): The photon calculation options. Not applicable to brachytherapy plans. - PlanIntent (str): The plan intent as in DICOM, or an empty string. The defined terms are "CURATIVE", "PALLIATIVE", "PROPHYLACTIC", "VERIFICATION", "MACHINE_QA", "RESEARCH" and "SERVICE", but the value can be different for imported plans. - PlanIsInTreatment (bool): Checks if plan is loaded into console. - PlannedDosePerFraction (DoseValue): The calculated fraction dose in the primary reference point. - PlanningApprovalDate (str): The date when the plan was approved for planning. - PlanningApprover (str): The identifier of the user who approved the plan for planning. - PlanningApproverDisplayName (str): The display name of the user who approved the plan for planning. - PlanNormalizationMethod (str): The user interface name for the current normalization method. - PlanNormalizationPoint (VVector): The plan normalization point. - PlanType (PlanType): The plan type. - PredecessorPlan (PlanSetup): The prior revision of the plan - PredecessorPlanUID (str): The UID of the predecessor plan. - PrimaryReferencePoint (ReferencePoint): The primary reference point. - ProtocolID (str): The protocol identifier. - ProtocolPhaseID (str): The protocol phase identifier. - ProtonCalculationModel (str): The name of the proton calculation model. Not applicable to brachytherapy plans. - ProtonCalculationOptions (Dict[str, str]): The proton calculation options. Not applicable to brachytherapy plans. - ReferencePoints (List[ReferencePoint]): Collection of reference points in the plan. - RTPrescription (RTPrescription): Used for navigating to the linked prescription. - Series (Series): The series that contains this plan. Null if the plan is not connected to a series. - SeriesUID (str): The DICOM UID of the series that contains this plan. Empty string if the plan is not connected to a series. - TargetVolumeID (str): The target volume identifier. - TotalDose (DoseValue): Planned total dose. - TreatmentApprovalDate (str): The date when the plan was approved for treatment. - TreatmentApprover (str): The identifier of the user who approved the plan for treatment. - TreatmentApproverDisplayName (str): The display name of the user who approved the plan for treatment. - TreatmentOrientation (PatientOrientation): The orientation of the treatment. - TreatmentOrientationAsString (str): The orientation of the treatment as a string (localized). - TreatmentPercentage (float): The treatment percentage as a decimal number. For example, if the treatment percentage shown in the Eclipse user interface is 80%, returns 0.8. - TreatmentSessions (List[PlanTreatmentSession]): Treatment sessions for the plan, either scheduled sessions or treated sessions. - UID (str): The DICOM UID of the plan. - UseGating (bool): Boolean to mark if gating is used in the plan. - VerifiedPlan (PlanSetup): Returns the verified plan if this is a verification plan, otherwise returns null. The verified plan is the clinical plan that was used to create the verification plan. - """ - def __init__(self) -> None: ... - - Id: str - - Name: str - - Comment: str - - PlanNormalizationValue: float - - PlanUncertainties: List[PlanUncertainty] - - PlanObjectiveStructures: List[str] - - ApprovalHistory: List[ApprovalHistoryEntry] - - DosePerFractionInPrimaryRefPoint: DoseValue - - PrescribedDosePerFraction: DoseValue - - PrescribedPercentage: float - - TotalPrescribedDose: DoseValue - - ApplicationScriptLogs: List[ApplicationScriptLog] - - ApprovalStatus: PlanSetupApprovalStatus - - ApprovalStatusAsString: str - - BaseDosePlanningItem: PlanningItem - - Beams: List[Beam] - - BeamsInTreatmentOrder: List[Beam] - - CreationUserName: str - - DosePerFraction: DoseValue - - DVHEstimates: List[EstimatedDVH] - - ElectronCalculationModel: str - - ElectronCalculationOptions: Dict[str, str] - - IntegrityHash: str - - IsDoseValid: bool - - IsTreated: bool - - NumberOfFractions: Optional[int] - - OptimizationSetup: OptimizationSetup - - PatientSupportDevice: PatientSupportDevice - - PhotonCalculationModel: str - - PhotonCalculationOptions: Dict[str, str] - - PlanIntent: str - - PlanIsInTreatment: bool - - PlannedDosePerFraction: DoseValue - - PlanningApprovalDate: str - - PlanningApprover: str - - PlanningApproverDisplayName: str - - PlanNormalizationMethod: str - - PlanNormalizationPoint: VVector - - PlanType: PlanType - - PredecessorPlan: PlanSetup - - PredecessorPlanUID: str - - PrimaryReferencePoint: ReferencePoint - - ProtocolID: str - - ProtocolPhaseID: str - - ProtonCalculationModel: str - - ProtonCalculationOptions: Dict[str, str] - - ReferencePoints: List[ReferencePoint] - - RTPrescription: RTPrescription - - Series: Series - - SeriesUID: str - - TargetVolumeID: str - - TotalDose: DoseValue - - TreatmentApprovalDate: str - - TreatmentApprover: str - - TreatmentApproverDisplayName: str - - TreatmentOrientation: PatientOrientation - - TreatmentOrientationAsString: str - - TreatmentPercentage: float - - TreatmentSessions: List[PlanTreatmentSession] - - UID: str - - UseGating: bool - - VerifiedPlan: PlanSetup - - Id: str - - Name: str - - Comment: str - - PlanNormalizationValue: float - - PlanUncertainties: List[PlanUncertainty] - - PlanObjectiveStructures: List[str] - - ApprovalHistory: List[ApprovalHistoryEntry] - - DosePerFractionInPrimaryRefPoint: DoseValue - - PrescribedDosePerFraction: DoseValue - - PrescribedPercentage: float - - TotalPrescribedDose: DoseValue - - ApplicationScriptLogs: List[ApplicationScriptLog] - - ApprovalStatus: PlanSetupApprovalStatus - - ApprovalStatusAsString: str - - BaseDosePlanningItem: PlanningItem - - Beams: List[Beam] - - BeamsInTreatmentOrder: List[Beam] - - CreationUserName: str - - DosePerFraction: DoseValue - - DVHEstimates: List[EstimatedDVH] - - ElectronCalculationModel: str - - ElectronCalculationOptions: Dict[str, str] - - IntegrityHash: str - - IsDoseValid: bool - - IsTreated: bool - - NumberOfFractions: Optional[int] - - OptimizationSetup: OptimizationSetup - - PatientSupportDevice: PatientSupportDevice - - PhotonCalculationModel: str - - PhotonCalculationOptions: Dict[str, str] - - PlanIntent: str - - PlanIsInTreatment: bool - - PlannedDosePerFraction: DoseValue - - PlanningApprovalDate: str - - PlanningApprover: str - - PlanningApproverDisplayName: str - - PlanNormalizationMethod: str - - PlanNormalizationPoint: VVector - - PlanType: PlanType - - PredecessorPlan: PlanSetup - - PredecessorPlanUID: str - - PrimaryReferencePoint: ReferencePoint - - ProtocolID: str - - ProtocolPhaseID: str - - ProtonCalculationModel: str - - ProtonCalculationOptions: Dict[str, str] - - ReferencePoints: List[ReferencePoint] - - RTPrescription: RTPrescription - - Series: Series - - SeriesUID: str - - TargetVolumeID: str - - TotalDose: DoseValue - - TreatmentApprovalDate: str - - TreatmentApprover: str - - TreatmentApproverDisplayName: str - - TreatmentOrientation: PatientOrientation - - TreatmentOrientationAsString: str - - TreatmentPercentage: float - - TreatmentSessions: List[PlanTreatmentSession] - - UID: str - - UseGating: bool - - VerifiedPlan: PlanSetup - - # Gets the prescriptions and measures in the protocol that is associated with this plan setup. - def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List[ProtocolPhasePrescription], measures: List[ProtocolPhaseMeasure]) -> None: - """ - Args: - prescriptions: Returned list of prescriptions (plan objectives). - measures: Returned list of plan measures (quality indices). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. - def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: - """ - Args: - target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). - location: Reference point location in mm. - id: Reference point ID. - """ - ... - - - # Attaches event handling. - def AttachToCalcClient(self, doseCalcClient: ICalculationClient) -> Any: - ... - - - # Detaches event handling for the calculation client. - def DetachFromCalcClient(self, doseCalcClient: ICalculationClient) -> Any: - ... - - - # Reporting. - def Report(self, str: str) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimatesImpl(self, dvhCalculator: IPhotonCalculation, client: ICalculationClient, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str], license: LicenseId) -> Any: - """ - Args: - dvhCalculator: Interface for calculating the DVH estimates. - client: Calculation client. - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - license: License required for running the DVH estimation - """ - ... - - - # Check if plan approval status is valid. Note: Configured approval extensions are not executed. - def IsValidForPlanApproval(self, validationResults: List[PlanValidationResultEsapiDetail]) -> bool: - """ - Args: - validationResults: Validation results which contain detailed warning and error messages. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a new plan or field uncertainty with parameters. In case of field specific uncertainty, HUConversionError is overwritten to be always zero. Supported uncertainty types: RangeUncertainty, IsocenterShiftUncertainty, BaselineShiftUncertainty, RobustOptimizationUncertainty (=Perturbation). RangeUncertainty and RobustOptimizationUncertainty are proton specific. IsocenterShiftUncertainty and BaselineShiftUncertainty are photon specific. Field specific plan uncertainty dose can be used only for RobustOptimizationUncertainty. In case of BaselineShiftUncertainty isocenterShift parameter is actually target shift. - def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: - """ - Args: - uncertaintyType: Type of the plan uncertainty dose. - planSpecificUncertainty: The plan uncertainty dose is either plan specific (true) or field specific (false). - HUConversionError: Calibration curve error [%] - isocenterShift: Patient setup error [cm] - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the treatment order of the beams. - def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: - """ - Args: - orderedBeams: The beams in wanted order. All the beams of the plan must be present, otherwise the method fails. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. - def AddReferencePoint(self, refPoint: ReferencePoint) -> ReferencePoint: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Clears the calculation model for the given calculation type. - def ClearCalculationModel(self, calculationType: CalculationType) -> None: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Returns the selected calculation model for the given calculation type. Returns null if no model has been selected. - def GetCalculationModel(self, calculationType: CalculationType) -> str: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Gets the given calculation option value. - def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: - """ - Args: - calculationModel: The name of the calculation model. - optionName: The XPath or name of the option to set. - optionValue: The value of the given option. - """ - ... - - - # Gets all the calculation options and their values for the given calculation model. - def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: - """ - Args: - calculationModel: The name of the calculation model. - """ - ... - - - # Retrieves the name of DVH Estimation Model. - def GetDvhEstimationModelName(self) -> str: - ... - - - # Checks the limits of the current calculation area. - def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Moves the plan setup from its current course to the destination course, maintaining the plan UID. - def MoveToCourse(self, destinationCourse: Course) -> None: - """ - Args: - destinationCourse: The destination course for the plan setup. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove provided reference point from plan - def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to remove. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the calculation model for the given calculation type. - def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: - """ - Args: - calculationType: The type of calculation. - model: The name of the calculation model. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the given calculation option to the given value. Before setting the options for the model, set the calculation model. See - def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: - """ - Args: - calculationModel: The name of the calculation model. - optionName: The XPath or name of the option to set. If this is not an XPath, the method sets the first attribute that matches the name. Example 1: CalculationGridSizeInCM in the Anisotropic Analytical Algorithm (AAA) sets the option /AAACalculationOptions/@CalculationGridSizeInCM. Example 2: MaximalDrillDepthInCM in the Proton Convolution Superposition (PCS) algorithm sets the option /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling1/@MaximalDrillDepthInCM. To set the values, for example, for the Drilling2 settings, you have to specify the entire XPath /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling2/@MaximalDrillDepthInCM. - optionValue: The value to set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets and validates the number of fractions and dose per fraction. - def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: - """ - Args: - numberOfFractions: The number of fractions. - dosePerFraction: The dose per fraction. - treatmentPercentage: The treatment percentage as a decimal number. For example, if the treatment percentage shown in the user interface is 80%, use 0.8. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets or changes target structure if valid dose is not affected by the change. - def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: Text.StringBuilder) -> bool: - """ - Args: - newTargetStructure: New target structure. - errorHint: Holder for error message. - """ - ... - - - # Gets the prescriptions and measures in the protocol that is associated with this plan setup. - def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List[ProtocolPhasePrescription], measures: List[ProtocolPhaseMeasure]) -> None: - """ - Args: - prescriptions: Returned list of prescriptions (plan objectives). - measures: Returned list of plan measures (quality indices). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. - def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: - """ - Args: - target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). - location: Reference point location in mm. - id: Reference point ID. - """ - ... - - - # Attaches event handling. - def AttachToCalcClient(self, doseCalcClient: ICalculationClient) -> Any: - ... - - - # Detaches event handling for the calculation client. - def DetachFromCalcClient(self, doseCalcClient: ICalculationClient) -> Any: - ... - - - # Reporting. - def Report(self, str: str) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimatesImpl(self, dvhCalculator: IPhotonCalculation, client: ICalculationClient, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str], license: LicenseId) -> Any: - """ - Args: - dvhCalculator: Interface for calculating the DVH estimates. - client: Calculation client. - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - license: License required for running the DVH estimation - """ - ... - - - # Check if plan approval status is valid. Note: Configured approval extensions are not executed. - def IsValidForPlanApproval(self, validationResults: List[PlanValidationResultEsapiDetail]) -> bool: - """ - Args: - validationResults: Validation results which contain detailed warning and error messages. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a new plan or field uncertainty with parameters. In case of field specific uncertainty, HUConversionError is overwritten to be always zero. Supported uncertainty types: RangeUncertainty, IsocenterShiftUncertainty, BaselineShiftUncertainty, RobustOptimizationUncertainty (=Perturbation). RangeUncertainty and RobustOptimizationUncertainty are proton specific. IsocenterShiftUncertainty and BaselineShiftUncertainty are photon specific. Field specific plan uncertainty dose can be used only for RobustOptimizationUncertainty. In case of BaselineShiftUncertainty isocenterShift parameter is actually target shift. - def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: - """ - Args: - uncertaintyType: Type of the plan uncertainty dose. - planSpecificUncertainty: The plan uncertainty dose is either plan specific (true) or field specific (false). - HUConversionError: Calibration curve error [%] - isocenterShift: Patient setup error [cm] - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the treatment order of the beams. - def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: - """ - Args: - orderedBeams: The beams in wanted order. All the beams of the plan must be present, otherwise the method fails. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. - def AddReferencePoint(self, refPoint: ReferencePoint) -> ReferencePoint: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Clears the calculation model for the given calculation type. - def ClearCalculationModel(self, calculationType: CalculationType) -> None: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Returns the selected calculation model for the given calculation type. Returns null if no model has been selected. - def GetCalculationModel(self, calculationType: CalculationType) -> str: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Gets the given calculation option value. - def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: - """ - Args: - calculationModel: The name of the calculation model. - optionName: The XPath or name of the option to set. - optionValue: The value of the given option. - """ - ... - - - # Gets all the calculation options and their values for the given calculation model. - def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: - """ - Args: - calculationModel: The name of the calculation model. - """ - ... - - - # Retrieves the name of DVH Estimation Model. - def GetDvhEstimationModelName(self) -> str: - ... - - - # Checks the limits of the current calculation area. - def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Moves the plan setup from its current course to the destination course, maintaining the plan UID. - def MoveToCourse(self, destinationCourse: Course) -> None: - """ - Args: - destinationCourse: The destination course for the plan setup. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove provided reference point from plan - def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to remove. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the calculation model for the given calculation type. - def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: - """ - Args: - calculationType: The type of calculation. - model: The name of the calculation model. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the given calculation option to the given value. Before setting the options for the model, set the calculation model. See - def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: - """ - Args: - calculationModel: The name of the calculation model. - optionName: The XPath or name of the option to set. If this is not an XPath, the method sets the first attribute that matches the name. Example 1: CalculationGridSizeInCM in the Anisotropic Analytical Algorithm (AAA) sets the option /AAACalculationOptions/@CalculationGridSizeInCM. Example 2: MaximalDrillDepthInCM in the Proton Convolution Superposition (PCS) algorithm sets the option /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling1/@MaximalDrillDepthInCM. To set the values, for example, for the Drilling2 settings, you have to specify the entire XPath /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling2/@MaximalDrillDepthInCM. - optionValue: The value to set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets and validates the number of fractions and dose per fraction. - def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: - """ - Args: - numberOfFractions: The number of fractions. - dosePerFraction: The dose per fraction. - treatmentPercentage: The treatment percentage as a decimal number. For example, if the treatment percentage shown in the user interface is 80%, use 0.8. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets or changes target structure if valid dose is not affected by the change. - def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: Text.StringBuilder) -> bool: - """ - Args: - newTargetStructure: New target structure. - errorHint: Holder for error message. - """ - ... - - - -class ProtocolPhaseMeasure: - """ - Represents the plan measures (quality indices) of the clinical protocol. - - Attributes: - TargetValue (float): The target value of this plan measure. - ActualValue (float): The calculated actual value of this plan measure. - TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. - Modifier (MeasureModifier): Measure Modifier. - StructureId (str): ID of the structure to which this measure is applied. - Type (MeasureType): Measure Type. - TypeText (str): Measure type as text, for instance, 'Conformity Index' in 'Conformity Index is more than 10.0'. - TargetValue (float): The target value of this plan measure. - ActualValue (float): The calculated actual value of this plan measure. - TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. - Modifier (MeasureModifier): Measure Modifier. - StructureId (str): ID of the structure to which this measure is applied. - Type (MeasureType): Measure Type. - TypeText (str): Measure type as text, for instance, 'Conformity Index' in 'Conformity Index is more than 10.0'. - """ - def __init__(self) -> None: ... - - TargetValue: float - - ActualValue: float - - TargetIsMet: Optional[bool] - - Modifier: MeasureModifier - - StructureId: str - - Type: MeasureType - - TypeText: str - - TargetValue: float - - ActualValue: float - - TargetIsMet: Optional[bool] - - Modifier: MeasureModifier - - StructureId: str - - Type: MeasureType - - TypeText: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ProtocolPhasePrescription: - """ - Represents the prescriptions (plan objectives) of the clinical protocol. - - Attributes: - TargetTotalDose (DoseValue): Total dose in absolute units specified for this prescription. - TargetFractionDose (DoseValue): Fraction dose in absolute units specified for this prescription. - ActualTotalDose (DoseValue): Actual total dose for this prescription - TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. - PrescModifier (PrescriptionModifier): Prescription Modifier. - PrescParameter (float): Value of the prescription parameter, for instance, '80' in 'At least 80% receives more than 2 Gy'. - PrescType (PrescriptionType): Prescription Type. - StructureId (str): ID of structure to which this prescription is applied. - TargetTotalDose (DoseValue): Total dose in absolute units specified for this prescription. - TargetFractionDose (DoseValue): Fraction dose in absolute units specified for this prescription. - ActualTotalDose (DoseValue): Actual total dose for this prescription - TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. - PrescModifier (PrescriptionModifier): Prescription Modifier. - PrescParameter (float): Value of the prescription parameter, for instance, '80' in 'At least 80% receives more than 2 Gy'. - PrescType (PrescriptionType): Prescription Type. - StructureId (str): ID of structure to which this prescription is applied. - """ - def __init__(self) -> None: ... - - TargetTotalDose: DoseValue - - TargetFractionDose: DoseValue - - ActualTotalDose: DoseValue - - TargetIsMet: Optional[bool] - - PrescModifier: PrescriptionModifier - - PrescParameter: float - - PrescType: PrescriptionType - - StructureId: str - - TargetTotalDose: DoseValue - - TargetFractionDose: DoseValue - - ActualTotalDose: DoseValue - - TargetIsMet: Optional[bool] - - PrescModifier: PrescriptionModifier - - PrescParameter: float - - PrescType: PrescriptionType - - StructureId: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ScriptEnvironment: - """ - Contains the runtime information of the application environment for the script. - - Attributes: - ApplicationName (str): The name of the active application. - VersionInfo (str): The version number of Eclipse. - ApiVersionInfo (str): The version number of Eclipse Scripting API. - Scripts (List[ApplicationScript]): Retrieves a list of all scripts known by the application. - Packages (List[ApplicationPackage]): Retrieves a list of all packages known by the application. - ApplicationName (str): The name of the active application. - VersionInfo (str): The version number of Eclipse. - ApiVersionInfo (str): The version number of Eclipse Scripting API. - Scripts (List[ApplicationScript]): Retrieves a list of all scripts known by the application. - Packages (List[ApplicationPackage]): Retrieves a list of all packages known by the application. - """ - # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. - @overload - def __init__(self, appName: str, scripts: List[IApplicationScript], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: - """ - Args: - appName: The application name. - scripts: A list of all scripts known by the application. - scriptExecutionEngine: The execution engine for executing a script from another script. - """ - ... - - - # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. - @overload - def __init__(self, appName: str, scripts: List[IApplicationScript], packages: List[IApplicationPackage], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: - """ - Args: - appName: The application name. - scripts: A list of all scripts known by the application. - packages: A list of all packages known by the application. - scriptExecutionEngine: The execution engine for executing a script from another script. - """ - ... - - - # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. - @overload - def __init__(self, appName: str, scripts: List[IApplicationScript], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: - """ - Args: - appName: The application name. - scripts: A list of all scripts known by the application. - scriptExecutionEngine: The execution engine for executing a script from another script. - """ - ... - - - # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. - @overload - def __init__(self, appName: str, scripts: List[IApplicationScript], packages: List[IApplicationPackage], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: - """ - Args: - appName: The application name. - scripts: A list of all scripts known by the application. - packages: A list of all packages known by the application. - scriptExecutionEngine: The execution engine for executing a script from another script. - """ - ... - - - ApplicationName: str - - VersionInfo: str - - ApiVersionInfo: str - - Scripts: List[ApplicationScript] - - Packages: List[ApplicationPackage] - - ApplicationName: str - - VersionInfo: str - - ApiVersionInfo: str - - Scripts: List[ApplicationScript] - - Packages: List[ApplicationPackage] - - # Executes an other script from script. This allows a script to be used for launching other scripts. Without using this special method, the system would be unaware of the other script, and thus could not save the correct script logs. - def ExecuteScript(self, scriptAssembly: Reflection.Assembly, scriptContext: ScriptContext, window: Windows.Window) -> None: - """ - Args: - scriptAssembly: The other script assembly. The assembly must have a location. - scriptContext: The script context that was passed to the executing script. - window: The script window. This is an optional parameter, can be null. - """ - ... - - - # Executes an other script from script. This allows a script to be used for launching other scripts. Without using this special method, the system would be unaware of the other script, and thus could not save the correct script logs. - def ExecuteScript(self, scriptAssembly: Reflection.Assembly, scriptContext: ScriptContext, window: Windows.Window) -> None: - """ - Args: - scriptAssembly: The other script assembly. The assembly must have a location. - scriptContext: The script context that was passed to the executing script. - window: The script window. This is an optional parameter, can be null. - """ - ... - - - -class Structure: - """ - A structure is a geometrical representation of an anatomical organ, a treatment volume, a marker, or a support structure. See the definition of a DICOM Structure for more information. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Structure. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Structure. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Structure. - ApprovalHistory (List[StructureApprovalHistoryEntry]): Returns the approval history of the structure. - CenterPoint (VVector): The center point of the structure. - Color (Windows.Media.Color): The color of the structure. - DicomType (str): The DICOM type of the structure, for example, PTV, MARKER, or ORGAN. - HasCalculatedPlans (bool): Checks if a calculated plan exists for the structure - HasSegment (bool): Checks if the structure has a segment. - IsApproved (bool): Checks if the structure is approved - IsEmpty (bool): Checks if the structure is empty. - IsHighResolution (bool): true if this structure is a high-resolution structure. Otherwise false. - IsTarget (bool): Checks if the structure is PTV, CTV or GTV - MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The mesh geometry. - ROINumber (int): The DICOM ROI Number of the structure. - SegmentVolume (SegmentVolume): Provides access to the segment volume of the structure. - StructureCode (StructureCode): The structure code that identifies this structure. - StructureCodeInfos (List[StructureCodeInfo]): Property value. - Volume (float): The calculated volume. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Structure. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Structure. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Structure. - ApprovalHistory (List[StructureApprovalHistoryEntry]): Returns the approval history of the structure. - CenterPoint (VVector): The center point of the structure. - Color (Windows.Media.Color): The color of the structure. - DicomType (str): The DICOM type of the structure, for example, PTV, MARKER, or ORGAN. - HasCalculatedPlans (bool): Checks if a calculated plan exists for the structure - HasSegment (bool): Checks if the structure has a segment. - IsApproved (bool): Checks if the structure is approved - IsEmpty (bool): Checks if the structure is empty. - IsHighResolution (bool): true if this structure is a high-resolution structure. Otherwise false. - IsTarget (bool): Checks if the structure is PTV, CTV or GTV - MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The mesh geometry. - ROINumber (int): The DICOM ROI Number of the structure. - SegmentVolume (SegmentVolume): Provides access to the segment volume of the structure. - StructureCode (StructureCode): The structure code that identifies this structure. - StructureCodeInfos (List[StructureCodeInfo]): Property value. - Volume (float): The calculated volume. - """ - def __init__(self) -> None: ... - - Id: str - - Name: str - - Comment: str - - ApprovalHistory: List[StructureApprovalHistoryEntry] - - CenterPoint: VVector - - Color: Windows.Media.Color - - DicomType: str - - HasCalculatedPlans: bool - - HasSegment: bool - - IsApproved: bool - - IsEmpty: bool - - IsHighResolution: bool - - IsTarget: bool - - MeshGeometry: Windows.Media.Media3D.MeshGeometry3D - - ROINumber: int - - SegmentVolume: SegmentVolume - - StructureCode: StructureCode - - StructureCodeInfos: List[StructureCodeInfo] - - Volume: float - - Id: str - - Name: str - - Comment: str - - ApprovalHistory: List[StructureApprovalHistoryEntry] - - CenterPoint: VVector - - Color: Windows.Media.Color - - DicomType: str - - HasCalculatedPlans: bool - - HasSegment: bool - - IsApproved: bool - - IsEmpty: bool - - IsHighResolution: bool - - IsTarget: bool - - MeshGeometry: Windows.Media.Media3D.MeshGeometry3D - - ROINumber: int - - SegmentVolume: SegmentVolume - - StructureCode: StructureCode - - StructureCodeInfos: List[StructureCodeInfo] - - Volume: float - - # An implicit conversion from Structure to SegmentVolume makes it easier to use the SegmentVolume functionality, such as the boolean operators and margin. - def op_Implicit(self, structure: SegmentVolume) -> SegmentVolume: - """ - Args: - structure: The converted structure. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds the given contour to the given image plane. - def AddContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: - """ - Args: - contour: The contour points, z coordinates are ignored. - z: A zero-based image plane index. - """ - ... - - - # Boolean And operation for structures that have a segment model. Provided here for convenience. - def And(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this segment volume. - """ - ... - - - # Asymmetric margin operation for structures that have a segment model. Provided here for convenience. - def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: - """ - Args: - margins: The margins aligned to the axes of the image coordinate system, in millimeters. The maximum is 50. - """ - ... - - - # Returns true if this structure can be converted to a high-resolution structure. - def CanConvertToHighResolution(self) -> bool: - ... - - - # Checks if the segment volume of the structure can be edited. - def CanEditSegmentVolume(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If the segment volume cannot be edited, contains the error message. - """ - ... - - - # Checks if the HU value of the structure can be modified. - def CanSetAssignedHU(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If the HU value cannot be set, contains the error message. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Clears the contours on the given image plane. - def ClearAllContoursOnImagePlane(self, z: int) -> None: - """ - Args: - z: A zero-based image plane index. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a structure out of an isodose level. - def ConvertDoseLevelToStructure(self, dose: Dose, doseLevel: DoseValue) -> None: - """ - Args: - dose: The dose from which the dose level is extracted. - doseLevel: The dose level. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Converts this structure to a high-resolution structure. Increases the resolution of the segment volume in cases where the image size is larger than 256x256 voxels. - def ConvertToHighResolution(self) -> None: - ... - - - # Returns the HU value of the material. - def GetAssignedHU(self, huValue: float) -> bool: - """ - Args: - huValue: Double value that will contain the HU value upon return from this method - """ - ... - - - # If the structure has a segment, gets the contours of the structure on the given image plane. - def GetContoursOnImagePlane(self, z: int) -> Array[Array[VVector]]: - """ - Args: - z: Zero based image plane index. - """ - ... - - - # If the structure has a segment, returns the number of separate parts. - def GetNumberOfSeparateParts(self) -> int: - ... - - - # If the structure is a reference line, gets its points. - def GetReferenceLinePoints(self) -> Array[VVector]: - ... - - - # If the structure has a segment, gets the segment profile. - def GetSegmentProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Collections.BitArray) -> SegmentProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # If the structure has a segment, checks if the given point lies within the structure. - def IsPointInsideSegment(self, point: VVector) -> bool: - """ - Args: - point: Location of the point. - """ - ... - - - # Margin operation for structures that have a segment model. Provided here for convenience. - def Margin(self, marginInMM: float) -> SegmentVolume: - """ - Args: - marginInMM: The used margin in millimeters. The maximum is 50. - """ - ... - - - # Boolean Not operation for structures that have a segment model. Provided here for convenience. - def Not(self) -> SegmentVolume: - ... - - - # Boolean Or operation for structures that have a segment model. Provided here for convenience. - def Or(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Resets the HU value of the material to "undefined". - def ResetAssignedHU(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the HU value of the material. - def SetAssignedHU(self, huValue: float) -> None: - """ - Args: - huValue: A double value that contains the HU value to be set. - """ - ... - - - # Boolean Sub operation for structures that have a segment model. Provided here for convenience. - def Sub(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is subtracted from this segment volume. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Subtracts the given contour from the given image plane. - def SubtractContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: - """ - Args: - contour: The contour points, z coordinates are ignored. - z: A zero-based image plane index. - """ - ... - - - # Boolean Xor operation for structures that have a segment model. Provided here for convenience. - def Xor(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # An implicit conversion from Structure to SegmentVolume makes it easier to use the SegmentVolume functionality, such as the boolean operators and margin. - def op_Implicit(self, structure: SegmentVolume) -> SegmentVolume: - """ - Args: - structure: The converted structure. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds the given contour to the given image plane. - def AddContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: - """ - Args: - contour: The contour points, z coordinates are ignored. - z: A zero-based image plane index. - """ - ... - - - # Boolean And operation for structures that have a segment model. Provided here for convenience. - def And(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this segment volume. - """ - ... - - - # Asymmetric margin operation for structures that have a segment model. Provided here for convenience. - def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: - """ - Args: - margins: The margins aligned to the axes of the image coordinate system, in millimeters. The maximum is 50. - """ - ... - - - # Returns true if this structure can be converted to a high-resolution structure. - def CanConvertToHighResolution(self) -> bool: - ... - - - # Checks if the segment volume of the structure can be edited. - def CanEditSegmentVolume(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If the segment volume cannot be edited, contains the error message. - """ - ... - - - # Checks if the HU value of the structure can be modified. - def CanSetAssignedHU(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If the HU value cannot be set, contains the error message. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Clears the contours on the given image plane. - def ClearAllContoursOnImagePlane(self, z: int) -> None: - """ - Args: - z: A zero-based image plane index. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a structure out of an isodose level. - def ConvertDoseLevelToStructure(self, dose: Dose, doseLevel: DoseValue) -> None: - """ - Args: - dose: The dose from which the dose level is extracted. - doseLevel: The dose level. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Converts this structure to a high-resolution structure. Increases the resolution of the segment volume in cases where the image size is larger than 256x256 voxels. - def ConvertToHighResolution(self) -> None: - ... - - - # Returns the HU value of the material. - def GetAssignedHU(self, huValue: float) -> bool: - """ - Args: - huValue: Double value that will contain the HU value upon return from this method - """ - ... - - - # If the structure has a segment, gets the contours of the structure on the given image plane. - def GetContoursOnImagePlane(self, z: int) -> Array[Array[VVector]]: - """ - Args: - z: Zero based image plane index. - """ - ... - - - # If the structure has a segment, returns the number of separate parts. - def GetNumberOfSeparateParts(self) -> int: - ... - - - # If the structure is a reference line, gets its points. - def GetReferenceLinePoints(self) -> Array[VVector]: - ... - - - # If the structure has a segment, gets the segment profile. - def GetSegmentProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Collections.BitArray) -> SegmentProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # If the structure has a segment, checks if the given point lies within the structure. - def IsPointInsideSegment(self, point: VVector) -> bool: - """ - Args: - point: Location of the point. - """ - ... - - - # Margin operation for structures that have a segment model. Provided here for convenience. - def Margin(self, marginInMM: float) -> SegmentVolume: - """ - Args: - marginInMM: The used margin in millimeters. The maximum is 50. - """ - ... - - - # Boolean Not operation for structures that have a segment model. Provided here for convenience. - def Not(self) -> SegmentVolume: - ... - - - # Boolean Or operation for structures that have a segment model. Provided here for convenience. - def Or(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Resets the HU value of the material to "undefined". - def ResetAssignedHU(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the HU value of the material. - def SetAssignedHU(self, huValue: float) -> None: - """ - Args: - huValue: A double value that contains the HU value to be set. - """ - ... - - - # Boolean Sub operation for structures that have a segment model. Provided here for convenience. - def Sub(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is subtracted from this segment volume. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Subtracts the given contour from the given image plane. - def SubtractContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: - """ - Args: - contour: The contour points, z coordinates are ignored. - z: A zero-based image plane index. - """ - ... - - - # Boolean Xor operation for structures that have a segment model. Provided here for convenience. - def Xor(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - -class StructureSet: - """ - A structure set is a container for structures of a patient, including anatomical organs, treatment volumes and markers, and support structures. - - Attributes: - Structures (List[Structure]): Used for navigating to the child structures. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the structure set. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the structure set. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the structure set. - ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the structure set. - Image (Image): Used for navigating to the image. - Patient (Patient): Used for navigating to the patient. - Series (Series): The series that contains this plan. Null if the plan is not connected to a series. - SeriesUID (str): The DICOM UID of the series that contains this structure set. Empty string if the structure set is not connected to a series. - UID (str): DICOM UID. - Structures (List[Structure]): Used for navigating to the child structures. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the structure set. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the structure set. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the structure set. - ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the structure set. - Image (Image): Used for navigating to the image. - Patient (Patient): Used for navigating to the patient. - Series (Series): The series that contains this plan. Null if the plan is not connected to a series. - SeriesUID (str): The DICOM UID of the series that contains this structure set. Empty string if the structure set is not connected to a series. - UID (str): DICOM UID. - """ - def __init__(self) -> None: ... - - Structures: List[Structure] - - Id: str - - Name: str - - Comment: str - - ApplicationScriptLogs: List[ApplicationScriptLog] - - Image: Image - - Patient: Patient - - Series: Series - - SeriesUID: str - - UID: str - - Structures: List[Structure] - - Id: str - - Name: str - - Comment: str - - ApplicationScriptLogs: List[ApplicationScriptLog] - - Image: Image - - Patient: Patient - - Series: Series - - SeriesUID: str - - UID: str - - # [Availability of this method depends on your Eclipse Scripting API license] Adds couch structures to the StructureSet. Eclipse can model certain couches for photon treatment planning. A couch is modeled as a set of couch structures.The couch panel surface and interior, movable structural rails and grid(for Unipanel only) are each modeled as separate couch structures. The structure code of a couch structure is Support by default. You can change it to another structure code if necessary. The volume type of a couch structure is always Support. Couch structures are modeled inside a 3D image. If the 3D image is too small, this method will always enlarge the image to fit the couch structures. - def AddCouchStructures(self, couchModel: str, orientation: PatientOrientation, railA: RailPosition, railB: RailPosition, surfaceHU: Optional[float], interiorHU: Optional[float], railHU: Optional[float], addedStructures: IReadOnlyList[Structure], imageResized: bool, error: str) -> bool: - """ - Args: - couchModel: The id of the couch profile configured in Eclipse to use when creating the couch structures. - orientation: Patient orientation specifying where the couch structures are added. Pass NoOrientation to take the orientation from the image. - railA: Position of moveable rail A. - railB: Position of moveable rail B. - surfaceHU: HU value of the modeled couch surface. Pass null to use the setting from the specified couch profile or override by passing another value. - interiorHU: HU value of the modeled couch interior. Pass null to use the setting from the specified couch profile or override by passing another value. - railHU: HU value of the modeled couch rails. Pass null to use the setting from the specified couch profile or override by passing another value. - addedStructures: Returned list of added couch structures if successful. - imageResized: True if image was resized. - error: Returned error message if call failed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes couch structures from the StructureSet. - def RemoveCouchStructures(self, removedStructureIds: IReadOnlyList[str], error: str) -> bool: - """ - Args: - removedStructureIds: Returned list of removed couch structure IDs if successful. - error: Returned error message if call failed. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new reference line. - def AddReferenceLine(self, name: str, id: str, referenceLinePoints: Array[VVector]) -> Structure: - """ - Args: - name: Reference line name. - id: Reference line Id. - referenceLinePoints: Reference line points. Number of points: 1 .. 500. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure according to the DICOM structure type. - def AddStructure(self, dicomType: str, id: str) -> Structure: - """ - Args: - dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". - id: The identifier for the new structure. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure based on structure code. The DICOM structure type and structure ID are automatically assigned. - def AddStructure(self, code: StructureCodeInfo) -> Structure: - """ - Args: - code: The structure code. - """ - ... - - - # This method is used to verify whether it is possible to add couch structures to the StructureSet. - def CanAddCouchStructures(self, error: str) -> bool: - """ - Args: - error: Returned reason why couch structures cannot be added if method returns false. - """ - ... - - - # Returns true if it is possible to add the given type of structure to the structure set. - def CanAddStructure(self, dicomType: str, id: str) -> bool: - """ - Args: - dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". - id: The identifier for the new structure. - """ - ... - - - # This method is used to verify whether it is possible to remove couch structures from the StructureSet. - def CanRemoveCouchStructures(self, error: str) -> bool: - """ - Args: - error: Returned reason why couch structures cannot be removed if method returns false. - """ - ... - - - # Returns true if it is possible to remove the given structure from the structure set. - def CanRemoveStructure(self, structure: Structure) -> bool: - """ - Args: - structure: The structure to check. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a copy of this structure set. - def Copy(self) -> StructureSet: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new Body structure and searches Body with the specified parameters. The existing Body structure is returned, if there is one. - def CreateAndSearchBody(self, parameters: SearchBodyParameters) -> Structure: - """ - Args: - parameters: Parameters for the Search Body feature. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Deletes this structure set. - def Delete(self) -> None: - ... - - - # Gets a default set of Search Body parameters. - def GetDefaultSearchBodyParameters(self) -> SearchBodyParameters: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the structure from this structure set if removal is allowed. - def RemoveStructure(self, structure: Structure) -> None: - """ - Args: - structure: The structure to remove. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds couch structures to the StructureSet. Eclipse can model certain couches for photon treatment planning. A couch is modeled as a set of couch structures.The couch panel surface and interior, movable structural rails and grid(for Unipanel only) are each modeled as separate couch structures. The structure code of a couch structure is Support by default. You can change it to another structure code if necessary. The volume type of a couch structure is always Support. Couch structures are modeled inside a 3D image. If the 3D image is too small, this method will always enlarge the image to fit the couch structures. - def AddCouchStructures(self, couchModel: str, orientation: PatientOrientation, railA: RailPosition, railB: RailPosition, surfaceHU: Optional[float], interiorHU: Optional[float], railHU: Optional[float], addedStructures: IReadOnlyList[Structure], imageResized: bool, error: str) -> bool: - """ - Args: - couchModel: The id of the couch profile configured in Eclipse to use when creating the couch structures. - orientation: Patient orientation specifying where the couch structures are added. Pass NoOrientation to take the orientation from the image. - railA: Position of moveable rail A. - railB: Position of moveable rail B. - surfaceHU: HU value of the modeled couch surface. Pass null to use the setting from the specified couch profile or override by passing another value. - interiorHU: HU value of the modeled couch interior. Pass null to use the setting from the specified couch profile or override by passing another value. - railHU: HU value of the modeled couch rails. Pass null to use the setting from the specified couch profile or override by passing another value. - addedStructures: Returned list of added couch structures if successful. - imageResized: True if image was resized. - error: Returned error message if call failed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes couch structures from the StructureSet. - def RemoveCouchStructures(self, removedStructureIds: IReadOnlyList[str], error: str) -> bool: - """ - Args: - removedStructureIds: Returned list of removed couch structure IDs if successful. - error: Returned error message if call failed. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new reference line. - def AddReferenceLine(self, name: str, id: str, referenceLinePoints: Array[VVector]) -> Structure: - """ - Args: - name: Reference line name. - id: Reference line Id. - referenceLinePoints: Reference line points. Number of points: 1 .. 500. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure according to the DICOM structure type. - def AddStructure(self, dicomType: str, id: str) -> Structure: - """ - Args: - dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". - id: The identifier for the new structure. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure based on structure code. The DICOM structure type and structure ID are automatically assigned. - def AddStructure(self, code: StructureCodeInfo) -> Structure: - """ - Args: - code: The structure code. - """ - ... - - - # This method is used to verify whether it is possible to add couch structures to the StructureSet. - def CanAddCouchStructures(self, error: str) -> bool: - """ - Args: - error: Returned reason why couch structures cannot be added if method returns false. - """ - ... - - - # Returns true if it is possible to add the given type of structure to the structure set. - def CanAddStructure(self, dicomType: str, id: str) -> bool: - """ - Args: - dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". - id: The identifier for the new structure. - """ - ... - - - # This method is used to verify whether it is possible to remove couch structures from the StructureSet. - def CanRemoveCouchStructures(self, error: str) -> bool: - """ - Args: - error: Returned reason why couch structures cannot be removed if method returns false. - """ - ... - - - # Returns true if it is possible to remove the given structure from the structure set. - def CanRemoveStructure(self, structure: Structure) -> bool: - """ - Args: - structure: The structure to check. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a copy of this structure set. - def Copy(self) -> StructureSet: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new Body structure and searches Body with the specified parameters. The existing Body structure is returned, if there is one. - def CreateAndSearchBody(self, parameters: SearchBodyParameters) -> Structure: - """ - Args: - parameters: Parameters for the Search Body feature. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Deletes this structure set. - def Delete(self) -> None: - ... - - - # Gets a default set of Search Body parameters. - def GetDefaultSearchBodyParameters(self) -> SearchBodyParameters: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the structure from this structure set if removal is allowed. - def RemoveStructure(self, structure: Structure) -> None: - """ - Args: - structure: The structure to remove. - """ - ... - - - -class TradeoffExplorationContext: - """ - - Attributes: - HasPlanCollection (bool): True if the trade-off exploration context has a plan collection, so that the trade-offs can be explored using the - CanLoadSavedPlanCollection (bool): True if a previously saved plan collection can be loaded. - CanCreatePlanCollection (bool): True if a plan collection can be created. - CanUsePlanDoseAsIntermediateDose (bool): True if plan dose can be used as intermediate dose in - CanUseHybridOptimizationInPlanGeneration (bool): True if VMAT-IMRT hybrid optimization can be used in - TradeoffObjectiveCandidates (List[OptimizationObjective]): Available optimization objectives that can be selected for trade-off exploration in multi-criteria optimization. - TradeoffObjectives (Collections.Generic.IReadOnlyCollection[TradeoffObjective]): Trade-off objectives. If - TradeoffStructureCandidates (List[Structure]): Available structures that can be selected for trade-off exploration in multi-criteria optimization. Only organs at risk can be used for trade-off exploration at the structure level. - TargetStructures (List[Structure]): Target structures in trade-off exploration. These structures cannot be selected for trade-off exploration at the structure level. Homogeneity indices only apply to the target structures. - CurrentDose (Dose): Dose at the current location on the Pareto surface (the current trade-offs). Returns null if no valid dose exists. - HasPlanCollection (bool): True if the trade-off exploration context has a plan collection, so that the trade-offs can be explored using the - CanLoadSavedPlanCollection (bool): True if a previously saved plan collection can be loaded. - CanCreatePlanCollection (bool): True if a plan collection can be created. - CanUsePlanDoseAsIntermediateDose (bool): True if plan dose can be used as intermediate dose in - CanUseHybridOptimizationInPlanGeneration (bool): True if VMAT-IMRT hybrid optimization can be used in - TradeoffObjectiveCandidates (List[OptimizationObjective]): Available optimization objectives that can be selected for trade-off exploration in multi-criteria optimization. - TradeoffObjectives (Collections.Generic.IReadOnlyCollection[TradeoffObjective]): Trade-off objectives. If - TradeoffStructureCandidates (List[Structure]): Available structures that can be selected for trade-off exploration in multi-criteria optimization. Only organs at risk can be used for trade-off exploration at the structure level. - TargetStructures (List[Structure]): Target structures in trade-off exploration. These structures cannot be selected for trade-off exploration at the structure level. Homogeneity indices only apply to the target structures. - CurrentDose (Dose): Dose at the current location on the Pareto surface (the current trade-offs). Returns null if no valid dose exists. - - Note: - To be able to get the - """ - # Creates a trade-off exploration context for a given plan. Acquires an MCO license for the lifetime of the application. - @overload - def __init__(self, param1: ExternalPlanSetup, param2: ILicenseManager, param3: IMcoControllerWithLocalDoseCorrection, param4: IMcoRuleValidator) -> None: - ... - - - # Creates a trade-off exploration context for a given plan. Acquires an MCO license for the lifetime of the application. - @overload - def __init__(self, param1: ExternalPlanSetup, param2: ILicenseManager, param3: IMcoControllerWithLocalDoseCorrection, param4: IMcoRuleValidator) -> None: - ... - - - HasPlanCollection: bool - - CanLoadSavedPlanCollection: bool - - CanCreatePlanCollection: bool - - CanUsePlanDoseAsIntermediateDose: bool - - CanUseHybridOptimizationInPlanGeneration: bool - - TradeoffObjectiveCandidates: List[OptimizationObjective] - - TradeoffObjectives: Collections.Generic.IReadOnlyCollection[TradeoffObjective] - - TradeoffStructureCandidates: List[Structure] - - TargetStructures: List[Structure] - - CurrentDose: Dose - - HasPlanCollection: bool - - CanLoadSavedPlanCollection: bool - - CanCreatePlanCollection: bool - - CanUsePlanDoseAsIntermediateDose: bool - - CanUseHybridOptimizationInPlanGeneration: bool - - TradeoffObjectiveCandidates: List[OptimizationObjective] - - TradeoffObjectives: Collections.Generic.IReadOnlyCollection[TradeoffObjective] - - TradeoffStructureCandidates: List[Structure] - - TargetStructures: List[Structure] - - CurrentDose: Dose - - # Loads a previously saved plan collection and sets - def LoadSavedPlanCollection(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan collection for trade-off exploration and sets - def CreatePlanCollection(self, continueOptimization: bool, intermediateDoseMode: TradeoffPlanGenerationIntermediateDoseMode, useHybridOptimizationForVmat: bool) -> bool: - """ - Args: - continueOptimization: True if the starting point for the trade-off exploration should be created by continuing optimization for the existing plan. Otherwise, the starting point is created by starting optimization from the beginning. - intermediateDoseMode: Specifies which intermediate dose mode is used for plan generation. - useHybridOptimizationForVmat: True if VMAT-IMRT hybrid optimization should be used in VMAT plan generation. Otherwise native VMAT optimization is used. - """ - ... - - - # Gets the current relative cost of a trade-off objective. The costs are normalized to the range [0,1]. If - def GetObjectiveCost(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the cost. - """ - ... - - - # Gets the lower limit value for a trade-off objective. It is not possible to set the cost value of the objective below this value. The range of the objective may be limited because one or more objective has a restrictor ( - def GetObjectiveLowerLimit(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the lower limit. - """ - ... - - - # Gets the upper limit value for a trade-off objective. It is not possible to set the cost value of the objective above this value. The range of the objective may be limited because one or more objective has a restrictor ( - def GetObjectiveUpperLimit(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the upper limit. - """ - ... - - - # Gets the current upper limit of a trade-off objective. The limits are normalized to the range [0,1]. If - def GetObjectiveUpperRestrictor(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective to get the upper limit. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] A single trade-off objective specifies a one dimensional subspace of the Pareto surface. By adjusting the relative cost of the objective, it is possible to move in this one dimensional subspace. The difference between the current relative cost and the new relative cost specifies the direction of the movement. If the difference is negative, the movement is towards the extreme case where the given trade-off objective is emphasized at the cost of all other objectives. If the difference is positive, the movement is away from the extreme case. If - def SetObjectiveCost(self, tradeoffObjective: TradeoffObjective, cost: float) -> None: - """ - Args: - tradeoffObjective: Trade-off objective that specifies the one dimensional subspace. - cost: The relative cost is defined as an interval [0,1]. A smaller value gives more emphasis to the given trade-off objective. - """ - ... - - - # Sets an upper limit for a trade-off objective. The limits are normalized to the range [0,1]. If - def SetObjectiveUpperRestrictor(self, tradeoffObjective: TradeoffObjective, restrictorValue: float) -> None: - """ - Args: - tradeoffObjective: Optimization objective selected for trade-off exploration. This trade-off objective specifies the one dimensional subspace of the Pareto surface. - restrictorValue: New upper limit [0,1] of the given trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Resets the costs of a trade-off objective to correspond to the balanced plan. If - def ResetToBalancedPlan(self) -> None: - ... - - - # Calculates a DVH for a given structure based on the dose at the current location on the Pareto surface (current trade-offs). If - def GetStructureDvh(self, structure: Structure) -> DVHData: - """ - Args: - structure: Structure for which the DVH is calculated. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a homogeneity objective for a given target structure to be used as a trade-off objective. Only target structures with an upper dose objective with larger than zero priority may have a homogeneity objective. Adding a new trade-off objective sets - def AddTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: - """ - Args: - targetStructure: Structure for which the homogeneity objective is created. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from all objectives associated with the given structure. Targets cannot be used in trade-off exploration at the structure level. Structures that do not have objectives or are not included in the plan cannot be added as trade-off objectives. Adding a new trade-off objective sets - def AddTradeoffObjective(self, structure: Structure) -> bool: - """ - Args: - structure: Structure to be added as a trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from an individual optimization objective. Adding a new trade-off objective sets - def AddTradeoffObjective(self, objective: OptimizationObjective) -> bool: - """ - Args: - objective: Objective to be added as a trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the given trade-off objective. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTradeoffObjective(self, tradeoffObjective: TradeoffObjective) -> bool: - """ - Args: - tradeoffObjective: Trade-off objective to be removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the homogeneity trade-off objective of the given target structure. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: - """ - Args: - targetStructure: Target structure for which the homogeneity objective is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the trade-off objective of the given structure. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTradeoffObjective(self, structure: Structure) -> bool: - """ - Args: - structure: Structure for which the trade-off objective is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan collection from the plan setup and database. Removing the plan collection sets - def RemovePlanCollection(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes all the trade-off objectives of the current plan collection. Removing all trade-off objectives invalidates the current plan collection and sets - def RemoveAllTradeoffObjectives(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Saves the trade-off exploration result. Also applies the trade-off exploration result to the plan setup for IMRT plans. For VMAT plans, to apply the results to the plan setup, an additional call to the - def ApplyTradeoffExplorationResult(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Applies the trade-off exploration result to the plan setup for VMAT plans. - def CreateDeliverableVmatPlan(self, useIntermediateDose: bool) -> bool: - """ - Args: - useIntermediateDose: True if intermediate dose is used when creating the VMAT plan. - """ - ... - - - # Loads a previously saved plan collection and sets - def LoadSavedPlanCollection(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan collection for trade-off exploration and sets - def CreatePlanCollection(self, continueOptimization: bool, intermediateDoseMode: TradeoffPlanGenerationIntermediateDoseMode, useHybridOptimizationForVmat: bool) -> bool: - """ - Args: - continueOptimization: True if the starting point for the trade-off exploration should be created by continuing optimization for the existing plan. Otherwise, the starting point is created by starting optimization from the beginning. - intermediateDoseMode: Specifies which intermediate dose mode is used for plan generation. - useHybridOptimizationForVmat: True if VMAT-IMRT hybrid optimization should be used in VMAT plan generation. Otherwise native VMAT optimization is used. - """ - ... - - - # Gets the current relative cost of a trade-off objective. The costs are normalized to the range [0,1]. If - def GetObjectiveCost(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the cost. - """ - ... - - - # Gets the lower limit value for a trade-off objective. It is not possible to set the cost value of the objective below this value. The range of the objective may be limited because one or more objective has a restrictor ( - def GetObjectiveLowerLimit(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the lower limit. - """ - ... - - - # Gets the upper limit value for a trade-off objective. It is not possible to set the cost value of the objective above this value. The range of the objective may be limited because one or more objective has a restrictor ( - def GetObjectiveUpperLimit(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the upper limit. - """ - ... - - - # Gets the current upper limit of a trade-off objective. The limits are normalized to the range [0,1]. If - def GetObjectiveUpperRestrictor(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective to get the upper limit. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] A single trade-off objective specifies a one dimensional subspace of the Pareto surface. By adjusting the relative cost of the objective, it is possible to move in this one dimensional subspace. The difference between the current relative cost and the new relative cost specifies the direction of the movement. If the difference is negative, the movement is towards the extreme case where the given trade-off objective is emphasized at the cost of all other objectives. If the difference is positive, the movement is away from the extreme case. If - def SetObjectiveCost(self, tradeoffObjective: TradeoffObjective, cost: float) -> None: - """ - Args: - tradeoffObjective: Trade-off objective that specifies the one dimensional subspace. - cost: The relative cost is defined as an interval [0,1]. A smaller value gives more emphasis to the given trade-off objective. - """ - ... - - - # Sets an upper limit for a trade-off objective. The limits are normalized to the range [0,1]. If - def SetObjectiveUpperRestrictor(self, tradeoffObjective: TradeoffObjective, restrictorValue: float) -> None: - """ - Args: - tradeoffObjective: Optimization objective selected for trade-off exploration. This trade-off objective specifies the one dimensional subspace of the Pareto surface. - restrictorValue: New upper limit [0,1] of the given trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Resets the costs of a trade-off objective to correspond to the balanced plan. If - def ResetToBalancedPlan(self) -> None: - ... - - - # Calculates a DVH for a given structure based on the dose at the current location on the Pareto surface (current trade-offs). If - def GetStructureDvh(self, structure: Structure) -> DVHData: - """ - Args: - structure: Structure for which the DVH is calculated. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a homogeneity objective for a given target structure to be used as a trade-off objective. Only target structures with an upper dose objective with larger than zero priority may have a homogeneity objective. Adding a new trade-off objective sets - def AddTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: - """ - Args: - targetStructure: Structure for which the homogeneity objective is created. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from all objectives associated with the given structure. Targets cannot be used in trade-off exploration at the structure level. Structures that do not have objectives or are not included in the plan cannot be added as trade-off objectives. Adding a new trade-off objective sets - def AddTradeoffObjective(self, structure: Structure) -> bool: - """ - Args: - structure: Structure to be added as a trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from an individual optimization objective. Adding a new trade-off objective sets - def AddTradeoffObjective(self, objective: OptimizationObjective) -> bool: - """ - Args: - objective: Objective to be added as a trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the given trade-off objective. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTradeoffObjective(self, tradeoffObjective: TradeoffObjective) -> bool: - """ - Args: - tradeoffObjective: Trade-off objective to be removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the homogeneity trade-off objective of the given target structure. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: - """ - Args: - targetStructure: Target structure for which the homogeneity objective is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the trade-off objective of the given structure. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTradeoffObjective(self, structure: Structure) -> bool: - """ - Args: - structure: Structure for which the trade-off objective is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan collection from the plan setup and database. Removing the plan collection sets - def RemovePlanCollection(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes all the trade-off objectives of the current plan collection. Removing all trade-off objectives invalidates the current plan collection and sets - def RemoveAllTradeoffObjectives(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Saves the trade-off exploration result. Also applies the trade-off exploration result to the plan setup for IMRT plans. For VMAT plans, to apply the results to the plan setup, an additional call to the - def ApplyTradeoffExplorationResult(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Applies the trade-off exploration result to the plan setup for VMAT plans. - def CreateDeliverableVmatPlan(self, useIntermediateDose: bool) -> bool: - """ - Args: - useIntermediateDose: True if intermediate dose is used when creating the VMAT plan. - """ - ... - - - -class TypeBasedIdValidator: - """ - A utility class for validating the data object identifier. - """ - def __init__(self) -> None: ... - - # Returns true if the given identifier is valid for the given data object. - def IsValidId(self, id: str, dataObject: ApiDataObject, errorHint: Text.StringBuilder) -> bool: - """ - Args: - id: The new identifier to check. - dataObject: The data object for whom the new identifier is checked. - errorHint: The error string that is set if the validation failed. - """ - ... - - - # Throws System.ArgumentException if the given identifier is not valid for the given data object. - def ThrowIfNotValidId(self, id: str, dataObject: ApiDataObject) -> None: - """ - Args: - id: The new identifier to check. - dataObject: The data object for whom the new identifier is checked. - """ - ... - - - # Returns true if the given identifier is valid for the given data object. - def IsValidId(self, id: str, dataObject: ApiDataObject, errorHint: Text.StringBuilder) -> bool: - """ - Args: - id: The new identifier to check. - dataObject: The data object for whom the new identifier is checked. - errorHint: The error string that is set if the validation failed. - """ - ... - - - # Throws System.ArgumentException if the given identifier is not valid for the given data object. - def ThrowIfNotValidId(self, id: str, dataObject: ApiDataObject) -> None: - """ - Args: - id: The new identifier to check. - dataObject: The data object for whom the new identifier is checked. - """ - ... - - - -class User: - """ - Represents a user. - - Attributes: - Id (str): The identifier of the user. - Language (str): The language of the user. - Name (str): The display name of the user. - Id (str): The identifier of the user. - Language (str): The language of the user. - Name (str): The display name of the user. - """ - def __init__(self) -> None: ... - - Id: str - - Language: str - - Name: str - - Id: str - - Language: str - - Name: str - - # Returns a string that represents the current object. - def ToString(self) -> str: - ... - - - # Determines whether the specified Object is equal to the current Object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: Object to compare with the current object - """ - ... - - - # Serves as a hash function for this type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: User, b: User) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: User, b: User) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns a string that represents the current object. - def ToString(self) -> str: - ... - - - # Determines whether the specified Object is equal to the current Object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: Object to compare with the current object - """ - ... - - - # Serves as a hash function for this type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: User, b: User) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: User, b: User) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Diagnosis: - """ - Represents a diagnosis of the patient. - - Attributes: - ClinicalDescription (str): User-defined clinical description of the diagnosis. - Code (str): The disease code from the specified code table. - CodeTable (str): Identifies the coding system table, for example, ICD-9-CM. - ClinicalDescription (str): User-defined clinical description of the diagnosis. - Code (str): The disease code from the specified code table. - CodeTable (str): Identifies the coding system table, for example, ICD-9-CM. - """ - def __init__(self) -> None: ... - - ClinicalDescription: str - - Code: str - - CodeTable: str - - ClinicalDescription: str - - Code: str - - CodeTable: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class DVHEstimationModelSummary: - """ - A summary of an DVH Estimation Model. Contains the needed information for selecting a model. - - Attributes: - Description (str): Model Description - IsPublished (bool): True if set to published state. Only published models are available for optimizing. - IsTrained (bool): True if the model contains data. - ModelDataVersion (str): Version - ModelParticleType (ParticleType): Returns particle type for the model. Either ParticleType.Proton or ParticleType.Photon. - ModelUID (str): Model UID. To be used for the Load command. - Name (str): Display Name - Revision (int): Publish revision of the model - TreatmentSite (str): Indicating the treatment site the model was created for - Description (str): Model Description - IsPublished (bool): True if set to published state. Only published models are available for optimizing. - IsTrained (bool): True if the model contains data. - ModelDataVersion (str): Version - ModelParticleType (ParticleType): Returns particle type for the model. Either ParticleType.Proton or ParticleType.Photon. - ModelUID (str): Model UID. To be used for the Load command. - Name (str): Display Name - Revision (int): Publish revision of the model - TreatmentSite (str): Indicating the treatment site the model was created for - """ - def __init__(self) -> None: ... - - Description: str - - IsPublished: bool - - IsTrained: bool - - ModelDataVersion: str - - ModelParticleType: ParticleType - - ModelUID: str - - Name: str - - Revision: int - - TreatmentSite: str - - Description: str - - IsPublished: bool - - IsTrained: bool - - ModelDataVersion: str - - ModelParticleType: ParticleType - - ModelUID: str - - Name: str - - Revision: int - - TreatmentSite: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class EnergyMode: - """ - Represents an energy mode. - - Attributes: - IsElectron (bool): Checks if the mode is electron. - IsPhoton (bool): Checks if the mode is photon. - IsProton (bool): Checks if the mode is proton. - IsElectron (bool): Checks if the mode is electron. - IsPhoton (bool): Checks if the mode is photon. - IsProton (bool): Checks if the mode is proton. - """ - def __init__(self) -> None: ... - - IsElectron: bool - - IsPhoton: bool - - IsProton: bool - - IsElectron: bool - - IsPhoton: bool - - IsProton: bool - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class EstimatedDVH: - """ - Represents an estimated Dose Volume Histogram (DVH) curve. - - Attributes: - CurveData (Array[DVHPoint]): The points of the estimated DVH curve. - PlanSetup (PlanSetup): Parent plan. - PlanSetupId (str): ID of the parent plan. - Structure (Structure): Parent structure. - StructureId (str): ID of the parent structure. - TargetDoseLevel (DoseValue): Dose level of the associated target structure. - Type (DVHEstimateType): Type of DVH estimate curve. - CurveData (Array[DVHPoint]): The points of the estimated DVH curve. - PlanSetup (PlanSetup): Parent plan. - PlanSetupId (str): ID of the parent plan. - Structure (Structure): Parent structure. - StructureId (str): ID of the parent structure. - TargetDoseLevel (DoseValue): Dose level of the associated target structure. - Type (DVHEstimateType): Type of DVH estimate curve. - """ - def __init__(self) -> None: ... - - CurveData: Array[DVHPoint] - - PlanSetup: PlanSetup - - PlanSetupId: str - - Structure: Structure - - StructureId: str - - TargetDoseLevel: DoseValue - - Type: DVHEstimateType - - CurveData: Array[DVHPoint] - - PlanSetup: PlanSetup - - PlanSetupId: str - - Structure: Structure - - StructureId: str - - TargetDoseLevel: DoseValue - - Type: DVHEstimateType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class EvaluationDose: - """ - Represents an evaluation dose that is connected to a plan that has no beams. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts the given dose value to the corresponding raw voxel value. - def DoseValueToVoxel(self, doseValue: DoseValue) -> int: - """ - Args: - doseValue: Dose value. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] For an evaluation dose (the dose of a plan that has no beams), sets the voxels of the given dose plane. Create the evaluation dose first using - def SetVoxels(self, planeIndex: int, values: Array[int]) -> None: - """ - Args: - planeIndex: Zero-based index of the plane. - values: The plane of voxel values. The size of the array must conform to the X-size and Y-size of the dose. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts the given dose value to the corresponding raw voxel value. - def DoseValueToVoxel(self, doseValue: DoseValue) -> int: - """ - Args: - doseValue: Dose value. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] For an evaluation dose (the dose of a plan that has no beams), sets the voxels of the given dose plane. Create the evaluation dose first using - def SetVoxels(self, planeIndex: int, values: Array[int]) -> None: - """ - Args: - planeIndex: Zero-based index of the plane. - values: The plane of voxel values. The size of the array must conform to the X-size and Y-size of the dose. - """ - ... - - - -class ExternalBeamTreatmentUnit: - """ - Represents a treatment machine used for delivering external beam radiotherapy. - - Attributes: - MachineDepartmentName (str): Default department associated with the machine. - MachineModel (str): The model of the treatment unit. - MachineModelName (str): The displayed name of the treatment unit model. - MachineScaleDisplayName (str): The name of the scale used in the treatment unit. - OperatingLimits (TreatmentUnitOperatingLimits): Information about operating limits for a set of treatment unit parameters. - SourceAxisDistance (float): The Source to Axis Distance (SAD). - MachineDepartmentName (str): Default department associated with the machine. - MachineModel (str): The model of the treatment unit. - MachineModelName (str): The displayed name of the treatment unit model. - MachineScaleDisplayName (str): The name of the scale used in the treatment unit. - OperatingLimits (TreatmentUnitOperatingLimits): Information about operating limits for a set of treatment unit parameters. - SourceAxisDistance (float): The Source to Axis Distance (SAD). - """ - def __init__(self) -> None: ... - - MachineDepartmentName: str - - MachineModel: str - - MachineModelName: str - - MachineScaleDisplayName: str - - OperatingLimits: TreatmentUnitOperatingLimits - - SourceAxisDistance: float - - MachineDepartmentName: str - - MachineModel: str - - MachineModelName: str - - MachineScaleDisplayName: str - - OperatingLimits: TreatmentUnitOperatingLimits - - SourceAxisDistance: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonBeam: - """ - Proton beam interface. - - Attributes: - AirGap (float): The user-defined air gap in mm. - BeamLineStatus (ProtonBeamLineStatus): Determine beamline's status - DistalTargetMargin (float): Distal end margin, in mm. - LateralMargins (VRect[float]): The lateral margins of this field, in mm. - LateralSpreadingDevices (List[LateralSpreadingDevice]): The lateral spreading devices in this beam. - NominalRange (float): The nominal range of the beam line, in mm. - NominalSOBPWidth (float): The nominal width of the Spread Out Bragg Peak, in mm. - OptionId (str): The identifier of the selected beam-line setting for proton beams. For a typical double scattering system, for example, an option is a combination of range modulator, second scatterer, and nominal energy that correspond to a broad proton beam with a certain range in patient and field size. Returns null if the option is undefined. - PatientSupportId (str): Patient support identifier. Returns null if undefined. - PatientSupportType (PatientSupportType): Patient support type. - IonControlPoints (IonControlPointCollection): Gets the proton control points. - ProximalTargetMargin (float): Proximal end margin, in mm. - RangeModulators (List[RangeModulator]): The range modulator devices in this beam. - RangeShifters (List[RangeShifter]): The range shifter devices in this beam. - ScanMode (IonBeamScanMode): The method of beam scanning to be used during treatment. - SnoutId (str): The Snout identifier. Returns null if undefined. - SnoutPosition (float): The snout position in cm. Returns System::Double::NaN if undefined. - TargetStructure (Structure): Returns the field target structure. Null if the field target is not defined (and axial margins are defined around the isocenter level). - VirtualSADX (float): Virtual Source-to-Axis Distance X, in mm. - VirtualSADY (float): Virtual Source-to-Axis Distance Y, in mm. - AirGap (float): The user-defined air gap in mm. - BeamLineStatus (ProtonBeamLineStatus): Determine beamline's status - DistalTargetMargin (float): Distal end margin, in mm. - LateralMargins (VRect[float]): The lateral margins of this field, in mm. - LateralSpreadingDevices (List[LateralSpreadingDevice]): The lateral spreading devices in this beam. - NominalRange (float): The nominal range of the beam line, in mm. - NominalSOBPWidth (float): The nominal width of the Spread Out Bragg Peak, in mm. - OptionId (str): The identifier of the selected beam-line setting for proton beams. For a typical double scattering system, for example, an option is a combination of range modulator, second scatterer, and nominal energy that correspond to a broad proton beam with a certain range in patient and field size. Returns null if the option is undefined. - PatientSupportId (str): Patient support identifier. Returns null if undefined. - PatientSupportType (PatientSupportType): Patient support type. - IonControlPoints (IonControlPointCollection): Gets the proton control points. - ProximalTargetMargin (float): Proximal end margin, in mm. - RangeModulators (List[RangeModulator]): The range modulator devices in this beam. - RangeShifters (List[RangeShifter]): The range shifter devices in this beam. - ScanMode (IonBeamScanMode): The method of beam scanning to be used during treatment. - SnoutId (str): The Snout identifier. Returns null if undefined. - SnoutPosition (float): The snout position in cm. Returns System::Double::NaN if undefined. - TargetStructure (Structure): Returns the field target structure. Null if the field target is not defined (and axial margins are defined around the isocenter level). - VirtualSADX (float): Virtual Source-to-Axis Distance X, in mm. - VirtualSADY (float): Virtual Source-to-Axis Distance Y, in mm. - """ - def __init__(self) -> None: ... - - AirGap: float - - BeamLineStatus: ProtonBeamLineStatus - - DistalTargetMargin: float - - LateralMargins: VRect[float] - - LateralSpreadingDevices: List[LateralSpreadingDevice] - - NominalRange: float - - NominalSOBPWidth: float - - OptionId: str - - PatientSupportId: str - - PatientSupportType: PatientSupportType - - IonControlPoints: IonControlPointCollection - - ProximalTargetMargin: float - - RangeModulators: List[RangeModulator] - - RangeShifters: List[RangeShifter] - - ScanMode: IonBeamScanMode - - SnoutId: str - - SnoutPosition: float - - TargetStructure: Structure - - VirtualSADX: float - - VirtualSADY: float - - AirGap: float - - BeamLineStatus: ProtonBeamLineStatus - - DistalTargetMargin: float - - LateralMargins: VRect[float] - - LateralSpreadingDevices: List[LateralSpreadingDevice] - - NominalRange: float - - NominalSOBPWidth: float - - OptionId: str - - PatientSupportId: str - - PatientSupportType: PatientSupportType - - IonControlPoints: IonControlPointCollection - - ProximalTargetMargin: float - - RangeModulators: List[RangeModulator] - - RangeShifters: List[RangeShifter] - - ScanMode: IonBeamScanMode - - SnoutId: str - - SnoutPosition: float - - TargetStructure: Structure - - VirtualSADX: float - - VirtualSADY: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Modifies the proton beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. DVH Estimations of the plan, if any, are cleared. - def ApplyParameters(self, beamParams: BeamParameters) -> None: - """ - Args: - beamParams: The parameters to apply to the beam. - """ - ... - - - # Returns a proton field deliverability status by room ID. Proton field deliverability status can be Deliverable, Undeliverable or NotCalculated. - def GetDeliveryTimeStatusByRoomId(self, roomId: str) -> ProtonDeliveryTimeStatus: - """ - Args: - roomId: Treatment room ID. - """ - ... - - - # Returns a new editable copy of the ion beam parameters. The returned IonBeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another IonBeamParameters object. - def GetEditableParameters(self) -> IonBeamParameters: - ... - - - # Returns a proton delivery time by room ID in seconds. Returns System::Double::NaN if delivery time status is Undeliverable or NotCalculated. - def GetProtonDeliveryTimeByRoomIdAsNumber(self, roomId: str) -> float: - """ - Args: - roomId: Treatment room ID. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Modifies the proton beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. DVH Estimations of the plan, if any, are cleared. - def ApplyParameters(self, beamParams: BeamParameters) -> None: - """ - Args: - beamParams: The parameters to apply to the beam. - """ - ... - - - # Returns a proton field deliverability status by room ID. Proton field deliverability status can be Deliverable, Undeliverable or NotCalculated. - def GetDeliveryTimeStatusByRoomId(self, roomId: str) -> ProtonDeliveryTimeStatus: - """ - Args: - roomId: Treatment room ID. - """ - ... - - - # Returns a new editable copy of the ion beam parameters. The returned IonBeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another IonBeamParameters object. - def GetEditableParameters(self) -> IonBeamParameters: - ... - - - # Returns a proton delivery time by room ID in seconds. Returns System::Double::NaN if delivery time status is Undeliverable or NotCalculated. - def GetProtonDeliveryTimeByRoomIdAsNumber(self, roomId: str) -> float: - """ - Args: - roomId: Treatment room ID. - """ - ... - - - -class IonControlPoint: - """ - Proton control point interface. - - Attributes: - FinalSpotList (IonSpotCollection): Gets a cached copy of the post-processed final spot list. - LateralSpreadingDeviceSettings (List[LateralSpreadingDeviceSettings]): The lateral spreading device settings. - NominalBeamEnergy (float): Nominal beam energy, in megavolts. - NumberOfPaintings (int): The number of times the scan pattern shall be applied at the current control point. - RangeModulatorSettings (List[RangeModulatorSettings]): The range modulator settings. - RangeShifterSettings (List[RangeShifterSettings]): The range shifter settings. - RawSpotList (IonSpotCollection): Gets a cached copy of the raw spot list. - ScanningSpotSizeX (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY X direction (mm). - ScanningSpotSizeY (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY Y direction (mm). - ScanSpotTuneId (str): User-supplied or machine code identifier for machine configuration to produce beam spot. This may be the nominal spot size or some other machine-specific value. Returns null if undefined. - SnoutPosition (float): The snout position, in mm. - FinalSpotList (IonSpotCollection): Gets a cached copy of the post-processed final spot list. - LateralSpreadingDeviceSettings (List[LateralSpreadingDeviceSettings]): The lateral spreading device settings. - NominalBeamEnergy (float): Nominal beam energy, in megavolts. - NumberOfPaintings (int): The number of times the scan pattern shall be applied at the current control point. - RangeModulatorSettings (List[RangeModulatorSettings]): The range modulator settings. - RangeShifterSettings (List[RangeShifterSettings]): The range shifter settings. - RawSpotList (IonSpotCollection): Gets a cached copy of the raw spot list. - ScanningSpotSizeX (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY X direction (mm). - ScanningSpotSizeY (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY Y direction (mm). - ScanSpotTuneId (str): User-supplied or machine code identifier for machine configuration to produce beam spot. This may be the nominal spot size or some other machine-specific value. Returns null if undefined. - SnoutPosition (float): The snout position, in mm. - """ - def __init__(self) -> None: ... - - FinalSpotList: IonSpotCollection - - LateralSpreadingDeviceSettings: List[LateralSpreadingDeviceSettings] - - NominalBeamEnergy: float - - NumberOfPaintings: int - - RangeModulatorSettings: List[RangeModulatorSettings] - - RangeShifterSettings: List[RangeShifterSettings] - - RawSpotList: IonSpotCollection - - ScanningSpotSizeX: float - - ScanningSpotSizeY: float - - ScanSpotTuneId: str - - SnoutPosition: float - - FinalSpotList: IonSpotCollection - - LateralSpreadingDeviceSettings: List[LateralSpreadingDeviceSettings] - - NominalBeamEnergy: float - - NumberOfPaintings: int - - RangeModulatorSettings: List[RangeModulatorSettings] - - RangeShifterSettings: List[RangeShifterSettings] - - RawSpotList: IonSpotCollection - - ScanningSpotSizeX: float - - ScanningSpotSizeY: float - - ScanSpotTuneId: str - - SnoutPosition: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonControlPointCollection: - """ - Represents a collection of machine parameters that describe the planned proton beam. - - Attributes: - Count (int): The number of control points in the collection. - Count (int): The number of control points in the collection. - """ - def __init__(self) -> None: ... - - Count: int - - Count: int - - # Retrieves enumerator for IonControlPoints in the collection. - def GetEnumerator(self) -> Iterable[IonControlPoint]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Retrieves enumerator for IonControlPoints in the collection. - def GetEnumerator(self) -> Iterable[IonControlPoint]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonControlPointPair: - """ - An editable copy of a control point pair (the pair of the start control point with an even index, and the end control point with an odd index). - - Attributes: - EndControlPoint (IonControlPointParameters): The end control point in the pair, with an odd index. - FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the editable post-processed final spot list. - NominalBeamEnergy (float): Nominal beam energy in megavolts. - RawSpotList (IonSpotParametersCollection): Gets a cached copy of the editable raw spot list - StartControlPoint (IonControlPointParameters): Start control point in the pair, with an even index from zero. - StartIndex (int): The index of the start control point in the pair. The index should be an even number starting from zero. - EndControlPoint (IonControlPointParameters): The end control point in the pair, with an odd index. - FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the editable post-processed final spot list. - NominalBeamEnergy (float): Nominal beam energy in megavolts. - RawSpotList (IonSpotParametersCollection): Gets a cached copy of the editable raw spot list - StartControlPoint (IonControlPointParameters): Start control point in the pair, with an even index from zero. - StartIndex (int): The index of the start control point in the pair. The index should be an even number starting from zero. - - Note: - To apply the parameters, call the - """ - def __init__(self) -> None: ... - - EndControlPoint: IonControlPointParameters - - FinalSpotList: IonSpotParametersCollection - - NominalBeamEnergy: float - - RawSpotList: IonSpotParametersCollection - - StartControlPoint: IonControlPointParameters - - StartIndex: int - - EndControlPoint: IonControlPointParameters - - FinalSpotList: IonSpotParametersCollection - - NominalBeamEnergy: float - - RawSpotList: IonSpotParametersCollection - - StartControlPoint: IonControlPointParameters - - StartIndex: int - - # Resizes the list of final spots. - def ResizeFinalSpotList(self, count: int) -> None: - """ - Args: - count: New length of the list. - """ - ... - - - # Resizes the list of raw spots. - def ResizeRawSpotList(self, count: int) -> None: - """ - Args: - count: New length of the list. - """ - ... - - - # Resizes the list of final spots. - def ResizeFinalSpotList(self, count: int) -> None: - """ - Args: - count: New length of the list. - """ - ... - - - # Resizes the list of raw spots. - def ResizeRawSpotList(self, count: int) -> None: - """ - Args: - count: New length of the list. - """ - ... - - - -class IonControlPointPairCollection: - """ - A collection of editable copies of control point pairs that describe the planned proton beam. - - Attributes: - Count (int): The number of control point pairs in the collection. - Count (int): The number of control point pairs in the collection. - - Note: - To apply the parameters, call the - """ - def __init__(self) -> None: ... - - Count: int - - Count: int - - # Retrieves enumerator for IonControlPointPairs in the collection. - def GetEnumerator(self) -> Iterable[IonControlPointPair]: - ... - - - # Retrieves enumerator for IonControlPointPairs in the collection. - def GetEnumerator(self) -> Iterable[IonControlPointPair]: - ... - - - -class IonControlPointParameters: - """ - An editable copy of the parameters of a proton control point. - - Attributes: - FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the post-processed final spot list. - RawSpotList (IonSpotParametersCollection): Gets a cached copy of the raw spot list. - SnoutPosition (float): Snout position in centimeters. - FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the post-processed final spot list. - RawSpotList (IonSpotParametersCollection): Gets a cached copy of the raw spot list. - SnoutPosition (float): Snout position in centimeters. - - Note: - To apply the parameters, call the ApplyParameters method of the Beam class. Because the parameters are simple copies, they do not reflect the current state of the data model. - """ - def __init__(self) -> None: ... - - FinalSpotList: IonSpotParametersCollection - - RawSpotList: IonSpotParametersCollection - - SnoutPosition: float - - FinalSpotList: IonSpotParametersCollection - - RawSpotList: IonSpotParametersCollection - - SnoutPosition: float - - -class IonSpot: - """ - The proton scanning spot interface that contains the 3D spot position and spot weight. - - Attributes: - Position (VVector): Read-only spot position in X, Y, and Z directions. - Weight (float): Read-only spot weight. - Position (VVector): Read-only spot position in X, Y, and Z directions. - Weight (float): Read-only spot weight. - """ - def __init__(self) -> None: ... - - Position: VVector - - Weight: float - - Position: VVector - - Weight: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonSpotCollection: - """ - Interface for the proton scanning spot list. - - Attributes: - Count (int): The number of scanning spots in this collection (spot list). - Count (int): The number of scanning spots in this collection (spot list). - """ - def __init__(self) -> None: ... - - Count: int - - Count: int - - # Retrieves enumerator for IonSpots in the collection. - def GetEnumerator(self) -> Iterable[IonSpot]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Retrieves enumerator for IonSpots in the collection. - def GetEnumerator(self) -> Iterable[IonSpot]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonSpotParameters: - """ - Interface for the proton scanning spot that contains the 3D spot position and spot weight. - - Attributes: - Weight (float): Editable spot weight. - X (float): Editable X position. - Y (float): Editable Y position. - Weight (float): Editable spot weight. - X (float): Editable X position. - Y (float): Editable Y position. - """ - def __init__(self) -> None: ... - - Weight: float - - X: float - - Y: float - - Weight: float - - X: float - - Y: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonSpotParametersCollection: - """ - Interface for the editable proton scanning spot list. - - Attributes: - Count (int): The number of editable scanning spots in this collection (spot list). - Count (int): The number of editable scanning spots in this collection (spot list). - """ - def __init__(self) -> None: ... - - Count: int - - Count: int - - # Retrieves enumerator for IonSpotParameterss in the collection. - def GetEnumerator(self) -> Iterable[IonSpotParameters]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Retrieves enumerator for IonSpotParameterss in the collection. - def GetEnumerator(self) -> Iterable[IonSpotParameters]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class LateralSpreadingDevice: - """ - The lateral spreading device. - - Attributes: - Type (LateralSpreadingDeviceType): The type of the device. - Type (LateralSpreadingDeviceType): The type of the device. - """ - def __init__(self) -> None: ... - - Type: LateralSpreadingDeviceType - - Type: LateralSpreadingDeviceType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class LateralSpreadingDeviceSettings: - """ - Settings for the lateral spreading device. - - Attributes: - IsocenterToLateralSpreadingDeviceDistance (float): Distance from the isocenter to the downstream edge of the lateral spreading device (mm) at the current control point. - LateralSpreadingDeviceSetting (str): Machine-specific setting. - LateralSpreadingDeviceWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the lateral spreading device at the central axis for the beam energy incident upon the device. - ReferencedLateralSpreadingDevice (LateralSpreadingDevice): The referenced lateral spreading device. - IsocenterToLateralSpreadingDeviceDistance (float): Distance from the isocenter to the downstream edge of the lateral spreading device (mm) at the current control point. - LateralSpreadingDeviceSetting (str): Machine-specific setting. - LateralSpreadingDeviceWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the lateral spreading device at the central axis for the beam energy incident upon the device. - ReferencedLateralSpreadingDevice (LateralSpreadingDevice): The referenced lateral spreading device. - """ - def __init__(self) -> None: ... - - IsocenterToLateralSpreadingDeviceDistance: float - - LateralSpreadingDeviceSetting: str - - LateralSpreadingDeviceWaterEquivalentThickness: float - - ReferencedLateralSpreadingDevice: LateralSpreadingDevice - - IsocenterToLateralSpreadingDeviceDistance: float - - LateralSpreadingDeviceSetting: str - - LateralSpreadingDeviceWaterEquivalentThickness: float - - ReferencedLateralSpreadingDevice: LateralSpreadingDevice - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationEUDObjective: - """ - A gEUD objective is an exact, upper or lower objective. An exact gEUD objective defines an exact dose value that a target structure should receive. An upper gEUD objective defines the maximum dose value that a structure should receive. A lower gEUD objective defines the minimum dose value that a target structure should receive. Generalized Equivalent Uniform Dose (gEUD) is a uniform dose that, if delivered over the same number of fractions, yields the same radiobiological effect as the non-uniform dose distribution of interest. - - Attributes: - Dose (DoseValue): The dose value for the objective. - ParameterA (float): A tissue-specific parameter that illustrates the effect of the volume on the dose. - Dose (DoseValue): The dose value for the objective. - ParameterA (float): A tissue-specific parameter that illustrates the effect of the volume on the dose. - """ - def __init__(self) -> None: ... - - Dose: DoseValue - - ParameterA: float - - Dose: DoseValue - - ParameterA: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationExcludeStructureParameter: - """ - Structures that have this parameter are excluded from the optimization. - - Attributes: - Structure (Structure): The structure to be excluded. - Structure (Structure): The structure to be excluded. - """ - def __init__(self) -> None: ... - - Structure: Structure - - Structure: Structure - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationIMRTBeamParameter: - """ - Beam-specific optimization parameter for IMRT optimization. - - Attributes: - Beam (Beam): The beam to which this parameter belongs. - BeamId (str): The identifier of the beam. - Excluded (bool): True if the beam is excluded from the optimization. - FixedJaws (bool): If true, the collimator jaw positions of the beam remain the same during the optimization. - SmoothX (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. - SmoothY (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. - Beam (Beam): The beam to which this parameter belongs. - BeamId (str): The identifier of the beam. - Excluded (bool): True if the beam is excluded from the optimization. - FixedJaws (bool): If true, the collimator jaw positions of the beam remain the same during the optimization. - SmoothX (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. - SmoothY (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. - """ - def __init__(self) -> None: ... - - Beam: Beam - - BeamId: str - - Excluded: bool - - FixedJaws: bool - - SmoothX: float - - SmoothY: float - - Beam: Beam - - BeamId: str - - Excluded: bool - - FixedJaws: bool - - SmoothX: float - - SmoothY: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationJawTrackingUsedParameter: - """ - An optimization parameter for using jaw tracking in VMAT optimization. The parameter exists if OptimizationSetup.UseJawTracking has been set to true. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationLineObjective: - """ - A line objective is a collection of point objectives that have the same priority. It is used to limit the dose in a given structure. - - Attributes: - CurveData (Array[DVHPoint]): The points in the line objective. - CurveData (Array[DVHPoint]): The points in the line objective. - """ - def __init__(self) -> None: ... - - CurveData: Array[DVHPoint] - - CurveData: Array[DVHPoint] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationMeanDoseObjective: - """ - A mean objective defines the mean dose that should not be exceeded. The mean objective is used to decrease the dose that a structure receives. - - Attributes: - Dose (DoseValue): The dose value for the objective. - Dose (DoseValue): The dose value for the objective. - """ - def __init__(self) -> None: ... - - Dose: DoseValue - - Dose: DoseValue - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationNormalTissueParameter: - """ - An optimization parameter for the normal tissue objective. - - Attributes: - DistanceFromTargetBorderInMM (float): Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - EndDosePercentage (float): Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - FallOff (float): Determines the steepness of the normal tissue objective fall-off. The value is positive. - IsAutomatic (bool): Returns True if an automatic normal tissue objective (NTO) is used. The automatic NTO adapts to the patient anatomy and the optimization objectives, and automatically determines the dose fall-off criteria. When an automatic NTO is used, the other properties of this object, except Priority, are not used. - IsAutomaticSbrt (bool): Returns True if an automatic SBRT normal tissue objective (NTO) is used. When an automatic SBRT NTO is used, the other properties of this object, except Priority, are not used. - IsAutomaticSrs (bool): Returns True if an automatic SRS normal tissue objective (NTO) is used. When an automatic SRS NTO is used, the other properties of this object, except Priority, are not used. - Priority (float): Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - StartDosePercentage (float): Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - DistanceFromTargetBorderInMM (float): Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - EndDosePercentage (float): Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - FallOff (float): Determines the steepness of the normal tissue objective fall-off. The value is positive. - IsAutomatic (bool): Returns True if an automatic normal tissue objective (NTO) is used. The automatic NTO adapts to the patient anatomy and the optimization objectives, and automatically determines the dose fall-off criteria. When an automatic NTO is used, the other properties of this object, except Priority, are not used. - IsAutomaticSbrt (bool): Returns True if an automatic SBRT normal tissue objective (NTO) is used. When an automatic SBRT NTO is used, the other properties of this object, except Priority, are not used. - IsAutomaticSrs (bool): Returns True if an automatic SRS normal tissue objective (NTO) is used. When an automatic SRS NTO is used, the other properties of this object, except Priority, are not used. - Priority (float): Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - StartDosePercentage (float): Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - """ - def __init__(self) -> None: ... - - DistanceFromTargetBorderInMM: float - - EndDosePercentage: float - - FallOff: float - - IsAutomatic: bool - - IsAutomaticSbrt: bool - - IsAutomaticSrs: bool - - Priority: float - - StartDosePercentage: float - - DistanceFromTargetBorderInMM: float - - EndDosePercentage: float - - FallOff: float - - IsAutomatic: bool - - IsAutomaticSbrt: bool - - IsAutomaticSrs: bool - - Priority: float - - StartDosePercentage: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationObjective: - """ - Provides a common base type for all structure-specific optimization objectives. - - Attributes: - Operator (OptimizationObjectiveOperator): Specifies the type of the objective (upper, lower, exact). - Priority (float): The priority of the objective as a positive double. - Structure (Structure): The structure to which this optimization objective belongs. - StructureId (str): The identifier of the structure. - Operator (OptimizationObjectiveOperator): Specifies the type of the objective (upper, lower, exact). - Priority (float): The priority of the objective as a positive double. - Structure (Structure): The structure to which this optimization objective belongs. - StructureId (str): The identifier of the structure. - """ - def __init__(self) -> None: ... - - Operator: OptimizationObjectiveOperator - - Priority: float - - Structure: Structure - - StructureId: str - - Operator: OptimizationObjectiveOperator - - Priority: float - - Structure: Structure - - StructureId: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Determines whether the specified object is equal to the current object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: The object to compare with the current object. - """ - ... - - - # Serves as a hash function for a particular type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Determines whether the specified object is equal to the current object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: The object to compare with the current object. - """ - ... - - - # Serves as a hash function for a particular type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - -class OptimizationParameter: - """ - Provides a common base type for all optimization parameters. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Determines whether the specified object is equal to the current object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: The object to compare with the current object. - """ - ... - - - # Serves as a hash function for a particular type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Determines whether the specified object is equal to the current object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: The object to compare with the current object. - """ - ... - - - # Serves as a hash function for a particular type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - -class OptimizationPointCloudParameter: - """ - Structure-specific parameter for point cloud optimization. Relevant if the optimization algorithm uses a point cloud. The point cloud parameters are automatically created with default values when you add other structure-specific parameters or objectives in the optimization setup. - - Attributes: - PointResolutionInMM (float): The point cloud resolution. - Structure (Structure): The structure whose parameters these are. - PointResolutionInMM (float): The point cloud resolution. - Structure (Structure): The structure whose parameters these are. - """ - def __init__(self) -> None: ... - - PointResolutionInMM: float - - Structure: Structure - - PointResolutionInMM: float - - Structure: Structure - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationPointObjective: - """ - A point objective is either an upper or lower objective. An upper objective is used to limit the dose in a given structure. A lower objective is used to define the desired dose levels in target structures. - - Attributes: - Dose (DoseValue): The dose value for the objective. - Volume (float): Percentage of the structure volume (0-100 %) to receive the dose. - Dose (DoseValue): The dose value for the objective. - Volume (float): Percentage of the structure volume (0-100 %) to receive the dose. - """ - def __init__(self) -> None: ... - - Dose: DoseValue - - Volume: float - - Dose: DoseValue - - Volume: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationVMATAvoidanceSectors: - """ - Beam-specific optimization parameter for VMAT Avoidance sectors. - - Attributes: - AvoidanceSector1 (OptimizationAvoidanceSector): Avoidance Sector 1. - AvoidanceSector2 (OptimizationAvoidanceSector): Avoidance Sector 2. - Beam (Beam): The beam to which this parameter belongs. - IsValid (bool): Is Avoidance Sectors valid. - ValidationError (str): Validation error if any. - AvoidanceSector1 (OptimizationAvoidanceSector): Avoidance Sector 1. - AvoidanceSector2 (OptimizationAvoidanceSector): Avoidance Sector 2. - Beam (Beam): The beam to which this parameter belongs. - IsValid (bool): Is Avoidance Sectors valid. - ValidationError (str): Validation error if any. - """ - def __init__(self) -> None: ... - - AvoidanceSector1: OptimizationAvoidanceSector - - AvoidanceSector2: OptimizationAvoidanceSector - - Beam: Beam - - IsValid: bool - - ValidationError: str - - AvoidanceSector1: OptimizationAvoidanceSector - - AvoidanceSector2: OptimizationAvoidanceSector - - Beam: Beam - - IsValid: bool - - ValidationError: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PatientSupportDevice: - """ - Represents a proton patient support device. - - Attributes: - PatientSupportAccessoryCode (str): Patient support device accessory code. - PatientSupportDeviceType (str): Type of the patient support device. - PatientSupportAccessoryCode (str): Patient support device accessory code. - PatientSupportDeviceType (str): Type of the patient support device. - """ - def __init__(self) -> None: ... - - PatientSupportAccessoryCode: str - - PatientSupportDeviceType: str - - PatientSupportAccessoryCode: str - - PatientSupportDeviceType: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PlanningItemDose: - """ - Represents a dose that is connected to a plan setup or a plan sum. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PlanSumComponent: - """ - Represents a component plan of a plan sum. - - Attributes: - PlanSetupId (str): The unique identification of the plan within the course. - PlanSumOperation (PlanSumOperation): The summing operation (+ or -) that defines how the dose of a component plan contributes to the plan sum. - PlanWeight (float): The weight of a component plan included in the plan sum. - PlanSetupId (str): The unique identification of the plan within the course. - PlanSumOperation (PlanSumOperation): The summing operation (+ or -) that defines how the dose of a component plan contributes to the plan sum. - PlanWeight (float): The weight of a component plan included in the plan sum. - """ - def __init__(self) -> None: ... - - PlanSetupId: str - - PlanSumOperation: PlanSumOperation - - PlanWeight: float - - PlanSetupId: str - - PlanSumOperation: PlanSumOperation - - PlanWeight: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PlanTreatmentSession: - """ - Plan in the treatment session. - - Attributes: - PlanSetup (PlanSetup): Scheduled or treated plan. - Status (TreatmentSessionStatus): Plan status in the treatment session. - TreatmentSession (TreatmentSession): Treatment session. - PlanSetup (PlanSetup): Scheduled or treated plan. - Status (TreatmentSessionStatus): Plan status in the treatment session. - TreatmentSession (TreatmentSession): Treatment session. - """ - def __init__(self) -> None: ... - - PlanSetup: PlanSetup - - Status: TreatmentSessionStatus - - TreatmentSession: TreatmentSession - - PlanSetup: PlanSetup - - Status: TreatmentSessionStatus - - TreatmentSession: TreatmentSession - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PlanUncertainty: - """ - Provides access to Plan Uncertainty parameters. For more information, see Eclipse Photon and Electron Instructions for Use. - - Attributes: - BeamUncertainties (List[BeamUncertainty]): Collection of beam uncertainty doses. - CalibrationCurveError (float): The calibration curve error of the plan uncertainty in percentage. Returns 100 for 100%. NaN if not defined. - DisplayName (str): The display name of the plan variation, including the parameter values. - Dose (Dose): The dose of this plan variation. - IsocenterShift (VVector): The isocenter shift of the plan uncertainty. - UncertaintyType (PlanUncertaintyType): Type of uncertainty, which determines how and in what context the defined parameters are to be used. - BeamUncertainties (List[BeamUncertainty]): Collection of beam uncertainty doses. - CalibrationCurveError (float): The calibration curve error of the plan uncertainty in percentage. Returns 100 for 100%. NaN if not defined. - DisplayName (str): The display name of the plan variation, including the parameter values. - Dose (Dose): The dose of this plan variation. - IsocenterShift (VVector): The isocenter shift of the plan uncertainty. - UncertaintyType (PlanUncertaintyType): Type of uncertainty, which determines how and in what context the defined parameters are to be used. - """ - def __init__(self) -> None: ... - - BeamUncertainties: List[BeamUncertainty] - - CalibrationCurveError: float - - DisplayName: str - - Dose: Dose - - IsocenterShift: VVector - - UncertaintyType: PlanUncertaintyType - - BeamUncertainties: List[BeamUncertainty] - - CalibrationCurveError: float - - DisplayName: str - - Dose: Dose - - IsocenterShift: VVector - - UncertaintyType: PlanUncertaintyType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns cumulative Dose Volume Histogram (DVH) data for this uncertainty plan. - def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: - """ - Args: - structure: Structure, for which the DVH data is requested. - dosePresentation: Requested dose presentation mode (absolute or relative). Note that only absolute dose is supported for PlanSums. - volumePresentation: Requested volume presentation mode. - binWidth: Requested width of the bin. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns cumulative Dose Volume Histogram (DVH) data for this uncertainty plan. - def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: - """ - Args: - structure: Structure, for which the DVH data is requested. - dosePresentation: Requested dose presentation mode (absolute or relative). Note that only absolute dose is supported for PlanSums. - volumePresentation: Requested volume presentation mode. - binWidth: Requested width of the bin. - """ - ... - - - -class RadioactiveSource: - """ - Represents a radioactive source installed into a - - Attributes: - CalibrationDate (Optional[datetime]): The calibration date for the strength of this radioactive source. - NominalActivity (bool): Defines whether source decay is accounted for in treatment planning. If the value is true, the dose calculation uses the source at its calibration activity (nominal activity). If the value is false, the source strength is decayed to the treatment activity based on the treatment date of the plan where the source is used. - RadioactiveSourceModel (RadioactiveSourceModel): The brachytherapy radioactive source model associated with this radioactive source. - SerialNumber (str): The serial number of this radioactive source. - Strength (float): The source strength for the radioactive source on the calibration date in cGy cm^2/h. - CalibrationDate (Optional[datetime]): The calibration date for the strength of this radioactive source. - NominalActivity (bool): Defines whether source decay is accounted for in treatment planning. If the value is true, the dose calculation uses the source at its calibration activity (nominal activity). If the value is false, the source strength is decayed to the treatment activity based on the treatment date of the plan where the source is used. - RadioactiveSourceModel (RadioactiveSourceModel): The brachytherapy radioactive source model associated with this radioactive source. - SerialNumber (str): The serial number of this radioactive source. - Strength (float): The source strength for the radioactive source on the calibration date in cGy cm^2/h. - """ - def __init__(self) -> None: ... - - CalibrationDate: Optional[datetime] - - NominalActivity: bool - - RadioactiveSourceModel: RadioactiveSourceModel - - SerialNumber: str - - Strength: float - - CalibrationDate: Optional[datetime] - - NominalActivity: bool - - RadioactiveSourceModel: RadioactiveSourceModel - - SerialNumber: str - - Strength: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RadioactiveSourceModel: - """ - The radioactive source model represents the details of the radioactive source used in brachytherapy. It encapsulates the source isotope, dimensions, and dose calculation parameters. - - Attributes: - ActiveSize (VVector): The active size of the modeled radioactive source in x, y, and z dimensions in millimeters. x represents the source width, y represents the source height, and z the source length. - ActivityConversionFactor (float): The activity-kerma conversion factor is used for converting activity (in mCi) to air-kerma strength (in U = cGy cm^2 / h). The unit of the factor is [U / mCi]. - CalculationModel (str): The dose calculation type used with this source model. Possible values are "Point source" and "Linear source". - DoseRateConstant (float): A conversion factor from the air-kerma strength to the dose rate in tissue. The unit of the dose rate constant is cGy / (h U). - HalfLife (float): The half life of the isotope in seconds. - LiteratureReference (str): The reference to the scientific publications on which the source model is based. - Manufacturer (str): The manufacturer of the modeled radioactive source. - SourceType (str): The DICOM source type. Possible values are "Point", "Line", "Cylinder", and "Sphere". - Status (str): The status of this source model. The status can be either "Unapproved", "Commissioning", "Approved", or "Retired". - StatusDate (Optional[datetime]): The time when the status of the source model was set. - StatusUserName (str): The name of the user who last set the status of the source model. - ActiveSize (VVector): The active size of the modeled radioactive source in x, y, and z dimensions in millimeters. x represents the source width, y represents the source height, and z the source length. - ActivityConversionFactor (float): The activity-kerma conversion factor is used for converting activity (in mCi) to air-kerma strength (in U = cGy cm^2 / h). The unit of the factor is [U / mCi]. - CalculationModel (str): The dose calculation type used with this source model. Possible values are "Point source" and "Linear source". - DoseRateConstant (float): A conversion factor from the air-kerma strength to the dose rate in tissue. The unit of the dose rate constant is cGy / (h U). - HalfLife (float): The half life of the isotope in seconds. - LiteratureReference (str): The reference to the scientific publications on which the source model is based. - Manufacturer (str): The manufacturer of the modeled radioactive source. - SourceType (str): The DICOM source type. Possible values are "Point", "Line", "Cylinder", and "Sphere". - Status (str): The status of this source model. The status can be either "Unapproved", "Commissioning", "Approved", or "Retired". - StatusDate (Optional[datetime]): The time when the status of the source model was set. - StatusUserName (str): The name of the user who last set the status of the source model. - """ - def __init__(self) -> None: ... - - ActiveSize: VVector - - ActivityConversionFactor: float - - CalculationModel: str - - DoseRateConstant: float - - HalfLife: float - - LiteratureReference: str - - Manufacturer: str - - SourceType: str - - Status: str - - StatusDate: Optional[datetime] - - StatusUserName: str - - ActiveSize: VVector - - ActivityConversionFactor: float - - CalculationModel: str - - DoseRateConstant: float - - HalfLife: float - - LiteratureReference: str - - Manufacturer: str - - SourceType: str - - Status: str - - StatusDate: Optional[datetime] - - StatusUserName: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RangeModulator: - """ - The range modulator device. - - Attributes: - Type (RangeModulatorType): The type of the device. - Type (RangeModulatorType): The type of the device. - """ - def __init__(self) -> None: ... - - Type: RangeModulatorType - - Type: RangeModulatorType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RangeModulatorSettings: - """ - Range modulator settings. - - Attributes: - IsocenterToRangeModulatorDistance (float): Distance from the isocenter to the downstream edge of the range modulator (mm) at the current control point. - RangeModulatorGatingStartValue (float): Start position defines the range modulator position at which the beam is switched on. - RangeModulatorGatingStarWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Start Value. - RangeModulatorGatingStopValue (float): Stop position defines the range modulator position at which the beam is switched off. - RangeModulatorGatingStopWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Stop Value. - ReferencedRangeModulator (RangeModulator): The referenced range modulator. - IsocenterToRangeModulatorDistance (float): Distance from the isocenter to the downstream edge of the range modulator (mm) at the current control point. - RangeModulatorGatingStartValue (float): Start position defines the range modulator position at which the beam is switched on. - RangeModulatorGatingStarWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Start Value. - RangeModulatorGatingStopValue (float): Stop position defines the range modulator position at which the beam is switched off. - RangeModulatorGatingStopWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Stop Value. - ReferencedRangeModulator (RangeModulator): The referenced range modulator. - """ - def __init__(self) -> None: ... - - IsocenterToRangeModulatorDistance: float - - RangeModulatorGatingStartValue: float - - RangeModulatorGatingStarWaterEquivalentThickness: float - - RangeModulatorGatingStopValue: float - - RangeModulatorGatingStopWaterEquivalentThickness: float - - ReferencedRangeModulator: RangeModulator - - IsocenterToRangeModulatorDistance: float - - RangeModulatorGatingStartValue: float - - RangeModulatorGatingStarWaterEquivalentThickness: float - - RangeModulatorGatingStopValue: float - - RangeModulatorGatingStopWaterEquivalentThickness: float - - ReferencedRangeModulator: RangeModulator - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RangeShifter: - """ - The range shifter device. - - Attributes: - Type (RangeShifterType): The type of the device. - Type (RangeShifterType): The type of the device. - """ - def __init__(self) -> None: ... - - Type: RangeShifterType - - Type: RangeShifterType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RangeShifterSettings: - """ - Range shifter settings. - - Attributes: - IsocenterToRangeShifterDistance (float): Distance from the isocenter to the downstream edge of the range shifter (mm) at the current control point. - RangeShifterSetting (str): Machine-specific setting. - RangeShifterWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range shifter at the central axis for the beam energy incident upon the device. - ReferencedRangeShifter (RangeShifter): The referenced range shifter. - IsocenterToRangeShifterDistance (float): Distance from the isocenter to the downstream edge of the range shifter (mm) at the current control point. - RangeShifterSetting (str): Machine-specific setting. - RangeShifterWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range shifter at the central axis for the beam energy incident upon the device. - ReferencedRangeShifter (RangeShifter): The referenced range shifter. - """ - def __init__(self) -> None: ... - - IsocenterToRangeShifterDistance: float - - RangeShifterSetting: str - - RangeShifterWaterEquivalentThickness: float - - ReferencedRangeShifter: RangeShifter - - IsocenterToRangeShifterDistance: float - - RangeShifterSetting: str - - RangeShifterWaterEquivalentThickness: float - - ReferencedRangeShifter: RangeShifter - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RTPrescription: - """ - Represents a prescription. - - Attributes: - BolusFrequency (str): Bolus frequency (how often the bolus is present in the field). For example, daily. - BolusThickness (str): Thickness of the bolus to be used. - Energies (List[str]): The energies in the prescription. - EnergyModes (List[str]): The energy modes in the prescription. - Gating (str): Gating information. - LatestRevision (RTPrescription): Gets the latest revision of the current RT prescription. - Notes (str): Additional notes. - NumberOfFractions (Optional[int]): Number of fractions, optional. - OrgansAtRisk (List[RTPrescriptionOrganAtRisk]): Gets the organs at risk of the current RT prescription. - PhaseType (str): Type of the phase (primary/boost). - PredecessorPrescription (RTPrescription): Gets the previous version of the RT prescription if it exists. - RevisionNumber (int): Revision number of the prescription. - SimulationNeeded (Optional[bool]): Indicates if simulations need to be done before treatment planning. - Site (str): The treatment site in the prescription. - Status (str): Prescription status. - TargetConstraintsWithoutTargetLevel (List[RTPrescriptionTargetConstraints]): Coverage constraints for targets with no prescribed dose. - Targets (List[RTPrescriptionTarget]): Gets the targets of the current prescription. - Technique (str): Treatment technique to be used. - BolusFrequency (str): Bolus frequency (how often the bolus is present in the field). For example, daily. - BolusThickness (str): Thickness of the bolus to be used. - Energies (List[str]): The energies in the prescription. - EnergyModes (List[str]): The energy modes in the prescription. - Gating (str): Gating information. - LatestRevision (RTPrescription): Gets the latest revision of the current RT prescription. - Notes (str): Additional notes. - NumberOfFractions (Optional[int]): Number of fractions, optional. - OrgansAtRisk (List[RTPrescriptionOrganAtRisk]): Gets the organs at risk of the current RT prescription. - PhaseType (str): Type of the phase (primary/boost). - PredecessorPrescription (RTPrescription): Gets the previous version of the RT prescription if it exists. - RevisionNumber (int): Revision number of the prescription. - SimulationNeeded (Optional[bool]): Indicates if simulations need to be done before treatment planning. - Site (str): The treatment site in the prescription. - Status (str): Prescription status. - TargetConstraintsWithoutTargetLevel (List[RTPrescriptionTargetConstraints]): Coverage constraints for targets with no prescribed dose. - Targets (List[RTPrescriptionTarget]): Gets the targets of the current prescription. - Technique (str): Treatment technique to be used. - """ - def __init__(self) -> None: ... - - BolusFrequency: str - - BolusThickness: str - - Energies: List[str] - - EnergyModes: List[str] - - Gating: str - - LatestRevision: RTPrescription - - Notes: str - - NumberOfFractions: Optional[int] - - OrgansAtRisk: List[RTPrescriptionOrganAtRisk] - - PhaseType: str - - PredecessorPrescription: RTPrescription - - RevisionNumber: int - - SimulationNeeded: Optional[bool] - - Site: str - - Status: str - - TargetConstraintsWithoutTargetLevel: List[RTPrescriptionTargetConstraints] - - Targets: List[RTPrescriptionTarget] - - Technique: str - - BolusFrequency: str - - BolusThickness: str - - Energies: List[str] - - EnergyModes: List[str] - - Gating: str - - LatestRevision: RTPrescription - - Notes: str - - NumberOfFractions: Optional[int] - - OrgansAtRisk: List[RTPrescriptionOrganAtRisk] - - PhaseType: str - - PredecessorPrescription: RTPrescription - - RevisionNumber: int - - SimulationNeeded: Optional[bool] - - Site: str - - Status: str - - TargetConstraintsWithoutTargetLevel: List[RTPrescriptionTargetConstraints] - - Targets: List[RTPrescriptionTarget] - - Technique: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RTPrescriptionConstraint: - """ - Represents a coverage constraint for an RT prescription. - - Attributes: - ConstraintType (RTPrescriptionConstraintType): Type of the constraint. - Unit1 (str): Gy, %, or null - Unit2 (str): Gy, %, or null - Value1 (str): First numerical (or free text) part of the constraint. - Value2 (str): Second numerical (or free text) part of the constraint. - ConstraintType (RTPrescriptionConstraintType): Type of the constraint. - Unit1 (str): Gy, %, or null - Unit2 (str): Gy, %, or null - Value1 (str): First numerical (or free text) part of the constraint. - Value2 (str): Second numerical (or free text) part of the constraint. - """ - def __init__(self) -> None: ... - - ConstraintType: RTPrescriptionConstraintType - - Unit1: str - - Unit2: str - - Value1: str - - Value2: str - - ConstraintType: RTPrescriptionConstraintType - - Unit1: str - - Unit2: str - - Value1: str - - Value2: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RTPrescriptionOrganAtRisk: - """ - Represents an organ at risk structure. - - Attributes: - Constraints (List[RTPrescriptionConstraint]): Constraints. - OrganAtRiskId (str): Structure identifier of the organ at risk. - Constraints (List[RTPrescriptionConstraint]): Constraints. - OrganAtRiskId (str): Structure identifier of the organ at risk. - """ - def __init__(self) -> None: ... - - Constraints: List[RTPrescriptionConstraint] - - OrganAtRiskId: str - - Constraints: List[RTPrescriptionConstraint] - - OrganAtRiskId: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RTPrescriptionTarget: - """ - Represents a prescription target. - - Attributes: - Constraints (List[RTPrescriptionConstraint]): Coverage constraints. - DosePerFraction (DoseValue): Dose per fraction for this target. - NumberOfFractions (int): The number of fractions in the prescription. - TargetId (str): The ID of the target volume. - Type (RTPrescriptionTargetType): Type of the prescription target. It can be Isocenter, IsodoseLine, Volume or Depth. - Value (float): Defined when the target type is IsodoseLine or Depth. Unit is % for IsodoseLine or mm for Depth. Not defined for other prescription types. - Constraints (List[RTPrescriptionConstraint]): Coverage constraints. - DosePerFraction (DoseValue): Dose per fraction for this target. - NumberOfFractions (int): The number of fractions in the prescription. - TargetId (str): The ID of the target volume. - Type (RTPrescriptionTargetType): Type of the prescription target. It can be Isocenter, IsodoseLine, Volume or Depth. - Value (float): Defined when the target type is IsodoseLine or Depth. Unit is % for IsodoseLine or mm for Depth. Not defined for other prescription types. - """ - def __init__(self) -> None: ... - - Constraints: List[RTPrescriptionConstraint] - - DosePerFraction: DoseValue - - NumberOfFractions: int - - TargetId: str - - Type: RTPrescriptionTargetType - - Value: float - - Constraints: List[RTPrescriptionConstraint] - - DosePerFraction: DoseValue - - NumberOfFractions: int - - TargetId: str - - Type: RTPrescriptionTargetType - - Value: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RTPrescriptionTargetConstraints: - """ - Represents target structure constraints. - - Attributes: - Constraints (List[RTPrescriptionConstraint]): Constraints. - TargetId (str): Identifier of the target structure. - Constraints (List[RTPrescriptionConstraint]): Constraints. - TargetId (str): Identifier of the target structure. - """ - def __init__(self) -> None: ... - - Constraints: List[RTPrescriptionConstraint] - - TargetId: str - - Constraints: List[RTPrescriptionConstraint] - - TargetId: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class SearchBodyParameters: - """ - Parameters for the Search Body feature. - - Attributes: - FillAllCavities (bool): Defines whether all cavities are filled. - KeepLargestParts (bool): Defines whether the largest part(s) of the Body structure are kept. - LowerHUThreshold (int): The lower threshold of the Hounsfield Unit value in the CT for the Search Body feature. - MREdgeThresholdHigh (int): Higher edge threshold for MR images. - MREdgeThresholdLow (int): Lower edge threshold for MR images. - NumberOfLargestPartsToKeep (int): The number of the largest parts in the Body structure that are kept. - PreCloseOpenings (bool): Defines whether to connect structure parts before extraction. - PreCloseOpeningsRadius (float): Radius setting for PreCloseOpenings. - PreDisconnect (bool): Defines whether to disconnect structure parts before extraction. - PreDisconnectRadius (float): Radius setting for PreDisconnect. - Smoothing (bool): Whether to do smoothing. - SmoothingLevel (int): Smoothing levels. - FillAllCavities (bool): Defines whether all cavities are filled. - KeepLargestParts (bool): Defines whether the largest part(s) of the Body structure are kept. - LowerHUThreshold (int): The lower threshold of the Hounsfield Unit value in the CT for the Search Body feature. - MREdgeThresholdHigh (int): Higher edge threshold for MR images. - MREdgeThresholdLow (int): Lower edge threshold for MR images. - NumberOfLargestPartsToKeep (int): The number of the largest parts in the Body structure that are kept. - PreCloseOpenings (bool): Defines whether to connect structure parts before extraction. - PreCloseOpeningsRadius (float): Radius setting for PreCloseOpenings. - PreDisconnect (bool): Defines whether to disconnect structure parts before extraction. - PreDisconnectRadius (float): Radius setting for PreDisconnect. - Smoothing (bool): Whether to do smoothing. - SmoothingLevel (int): Smoothing levels. - """ - def __init__(self) -> None: ... - - FillAllCavities: bool - - KeepLargestParts: bool - - LowerHUThreshold: int - - MREdgeThresholdHigh: int - - MREdgeThresholdLow: int - - NumberOfLargestPartsToKeep: int - - PreCloseOpenings: bool - - PreCloseOpeningsRadius: float - - PreDisconnect: bool - - PreDisconnectRadius: float - - Smoothing: bool - - SmoothingLevel: int - - FillAllCavities: bool - - KeepLargestParts: bool - - LowerHUThreshold: int - - MREdgeThresholdHigh: int - - MREdgeThresholdLow: int - - NumberOfLargestPartsToKeep: int - - PreCloseOpenings: bool - - PreCloseOpeningsRadius: float - - PreDisconnect: bool - - PreDisconnectRadius: float - - Smoothing: bool - - SmoothingLevel: int - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Loads the default values of the Search Body parameters. - def LoadDefaults(self) -> None: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Loads the default values of the Search Body parameters. - def LoadDefaults(self) -> None: - ... - - - -class SegmentVolume: - """ - The volumetric representation of a structure. This object is used when defining margins for structures, or when performing Boolean operations on structures. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to both this segment volume and another segment volume, that is, the intersection of this and the other segment volume. - def And(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this segment volume. - """ - ... - - - # Expands or shrinks this segment volume with the specified margins, aligned to the axes of the image coordinate system. - def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: - """ - Args: - margins: The margins in millimeters. The maximum is 50. - """ - ... - - - # Creates a new segment volume by expanding or shrinking this segment volume with the specified margin (in millimeters). A positive value creates an outer margin. A negative value creates an inner margin. - def Margin(self, marginInMM: float) -> SegmentVolume: - """ - Args: - marginInMM: The used margin in millimeters. The maximum is 50. - """ - ... - - - # Creates a combination of segment volumes. Does not modify this segment volume. The combination includes the area that covers everything else but this segment volume. - def Not(self) -> SegmentVolume: - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to this segment volume, to another segment volume, or both, that is, the union of this and the other segment volume. - def Or(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the area that belongs to this segment volume, but not to the other segment volume. - def Sub(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is subtracted from this segment volume. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong either to this segment volume or to another segment volume, but not to both of them. - def Xor(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to both this segment volume and another segment volume, that is, the intersection of this and the other segment volume. - def And(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this segment volume. - """ - ... - - - # Expands or shrinks this segment volume with the specified margins, aligned to the axes of the image coordinate system. - def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: - """ - Args: - margins: The margins in millimeters. The maximum is 50. - """ - ... - - - # Creates a new segment volume by expanding or shrinking this segment volume with the specified margin (in millimeters). A positive value creates an outer margin. A negative value creates an inner margin. - def Margin(self, marginInMM: float) -> SegmentVolume: - """ - Args: - marginInMM: The used margin in millimeters. The maximum is 50. - """ - ... - - - # Creates a combination of segment volumes. Does not modify this segment volume. The combination includes the area that covers everything else but this segment volume. - def Not(self) -> SegmentVolume: - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to this segment volume, to another segment volume, or both, that is, the union of this and the other segment volume. - def Or(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the area that belongs to this segment volume, but not to the other segment volume. - def Sub(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is subtracted from this segment volume. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong either to this segment volume or to another segment volume, but not to both of them. - def Xor(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - -class StandardWedge: - """ - A standard wedge is a physical piece of material with an angle that is static during treatment. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class BeamCalculationLog: - """ - Represents a beam calculation log. - - Attributes: - Beam (Beam): Used for navigating to parent Beam - Category (str): The log category, for example, "Dose", or "Optimization". - MessageLines (List[str]): The log as an array of lines. - Beam (Beam): Used for navigating to parent Beam - Category (str): The log category, for example, "Dose", or "Optimization". - MessageLines (List[str]): The log as an array of lines. - """ - def __init__(self) -> None: ... - - Beam: Beam - - Category: str - - MessageLines: List[str] - - Beam: Beam - - Category: str - - MessageLines: List[str] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Block: - """ - Represents a block add-on, a custom-made beam collimating material fixed to a tray, used to shape the beam. - - Attributes: - AddOnMaterial (AddOnMaterial): The dosimetric material of the block. - IsDiverging (bool): Checks if the block cut is diverging. - Outline (Array[Array[Windows.Point]]): The block outline points in field coordinates. - TransmissionFactor (float): The transmission factor of the selected material. - Tray (Tray): The tray on which the block is installed. - TrayTransmissionFactor (float): The transmission factor of the selected tray. - Type (BlockType): The type of the block: shielding or aperture. - AddOnMaterial (AddOnMaterial): The dosimetric material of the block. - IsDiverging (bool): Checks if the block cut is diverging. - Outline (Array[Array[Windows.Point]]): The block outline points in field coordinates. - TransmissionFactor (float): The transmission factor of the selected material. - Tray (Tray): The tray on which the block is installed. - TrayTransmissionFactor (float): The transmission factor of the selected tray. - Type (BlockType): The type of the block: shielding or aperture. - """ - def __init__(self) -> None: ... - - AddOnMaterial: AddOnMaterial - - IsDiverging: bool - - Outline: Array[Array[Windows.Point]] - - TransmissionFactor: float - - Tray: Tray - - TrayTransmissionFactor: float - - Type: BlockType - - AddOnMaterial: AddOnMaterial - - IsDiverging: bool - - Outline: Array[Array[Windows.Point]] - - TransmissionFactor: float - - Tray: Tray - - TrayTransmissionFactor: float - - Type: BlockType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Bolus: - """ - Represents a bolus, which is custom-made material that is usually fixed to the patient's skin for treatment. The bolus is used to modulate the depth dose profile of a beam. - - Attributes: - Id (str): The identifier of the bolus. - MaterialCTValue (float): The CT value of the bolus material (HU). - Name (str): The name of the bolus. - Id (str): The identifier of the bolus. - MaterialCTValue (float): The CT value of the bolus material (HU). - Name (str): The name of the bolus. - """ - def __init__(self) -> None: ... - - Id: str - - MaterialCTValue: float - - Name: str - - Id: str - - MaterialCTValue: float - - Name: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Compensator: - """ - Represents a beam compensator add-on, a custom-made beam modulating material fixed to a tray, used to modulate the beam's intensity. - - Attributes: - Material (AddOnMaterial): The dosimetric material used in the compensator. - Slot (Slot): The slot into which the tray is inserted. - Tray (Tray): The tray to which the compensator is connected. - Material (AddOnMaterial): The dosimetric material used in the compensator. - Slot (Slot): The slot into which the tray is inserted. - Tray (Tray): The tray to which the compensator is connected. - """ - def __init__(self) -> None: ... - - Material: AddOnMaterial - - Slot: Slot - - Tray: Tray - - Material: AddOnMaterial - - Slot: Slot - - Tray: Tray - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ControlPoint: - """ - Represents a point in a planned sequence of treatment beam parameters. See the definition of control points in a DICOM RT Beam. - - Attributes: - Beam (Beam): Used for navigating to parent beam - CollimatorAngle (float): The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - GantryAngle (float): The gantry angle of the radiation source. In other words, the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. - JawPositions (VRect[float]): The positions of the beam collimator jaws (in mm) in the IEC BEAM LIMITING DEVICE coordinates. - LeafPositions (Array[float]): The positions of the beam collimator leaf pairs (in mm) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If there is no MLC, a (0,0)-length array is returned. - MetersetWeight (float): The cumulative meterset weight to this control point. The cumulative meterset weight for the first item in a control point sequence is zero. - PatientSupportAngle (float): The patient support angle. In other words, the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. - Beam (Beam): Used for navigating to parent beam - CollimatorAngle (float): The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - GantryAngle (float): The gantry angle of the radiation source. In other words, the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. - JawPositions (VRect[float]): The positions of the beam collimator jaws (in mm) in the IEC BEAM LIMITING DEVICE coordinates. - LeafPositions (Array[float]): The positions of the beam collimator leaf pairs (in mm) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If there is no MLC, a (0,0)-length array is returned. - MetersetWeight (float): The cumulative meterset weight to this control point. The cumulative meterset weight for the first item in a control point sequence is zero. - PatientSupportAngle (float): The patient support angle. In other words, the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. - - Note: - Control points are discussed in DICOM PS 3.3 C.8.8.14. All beams have at least two control points. Note that some values may be NaN if they are not applicable to the treatment plan in question. - """ - def __init__(self) -> None: ... - - Beam: Beam - - CollimatorAngle: float - - GantryAngle: float - - Index: int - - JawPositions: VRect[float] - - LeafPositions: Array[float] - - MetersetWeight: float - - PatientSupportAngle: float - - TableTopLateralPosition: float - - TableTopLongitudinalPosition: float - - TableTopVerticalPosition: float - - Beam: Beam - - CollimatorAngle: float - - GantryAngle: float - - Index: int - - JawPositions: VRect[float] - - LeafPositions: Array[float] - - MetersetWeight: float - - PatientSupportAngle: float - - TableTopLateralPosition: float - - TableTopLongitudinalPosition: float - - TableTopVerticalPosition: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ControlPointCollection: - """ - Represents a collection of machine parameters that describe the planned treatment beam. - - Attributes: - Count (int): The number of control points in the collection. - Count (int): The number of control points in the collection. - """ - def __init__(self) -> None: ... - - Count: int - - Count: int - - # Retrieves enumerator for ControlPoints in the collection. - def GetEnumerator(self) -> Iterable[ControlPoint]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Retrieves enumerator for ControlPoints in the collection. - def GetEnumerator(self) -> Iterable[ControlPoint]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ApiDataObject: - """ - The base class of objects in the Eclipse Scripting API. - - Attributes: - Id (str): The identifier of the object. - Name (str): The name of the object. - Comment (str): A comment about the object. - HistoryUserName (str): The identifier of the last user who modified this object. - HistoryUserDisplayName (str): The name of the last user who modified this object. - HistoryDateTime (datetime): The date when this object was last modified. - Id (str): The identifier of the object. - Name (str): The name of the object. - Comment (str): A comment about the object. - HistoryUserName (str): The identifier of the last user who modified this object. - HistoryUserDisplayName (str): The name of the last user who modified this object. - HistoryDateTime (datetime): The date when this object was last modified. - """ - def __init__(self) -> None: ... - - Id: str - - Name: str - - Comment: str - - HistoryUserName: str - - HistoryUserDisplayName: str - - HistoryDateTime: datetime - - Id: str - - Name: str - - Comment: str - - HistoryUserName: str - - HistoryUserDisplayName: str - - HistoryDateTime: datetime - - # Returns a string that represents the current object. - def ToString(self) -> str: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream to which the object is serialized. - """ - ... - - - # Determines whether the specified Object is equal to the current Object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: Object to compare with the current object - """ - ... - - - # Serves as a hash function for this type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: ApiDataObject, b: ApiDataObject) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: ApiDataObject, b: ApiDataObject) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPIClinicalModifyingMethodGuard(self, param1: str) -> Any: - ... - - - # Throws an exception if the caller tries to add more scripting objects of certain types than a preset maximum limit allows. - def EnforceObjectLimits(self, callerMemberName: str) -> Any: - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPINonClinicalModifyingMethodGuard(self, param1: str) -> Any: - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPIClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: - """ - Args: - dataObj: The data object that is modified. - explicitCallerName: The API member that calls. - callerMemberName: The member that calls. - """ - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPINonClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: - """ - Args: - dataObj: The data object that is modified. - explicitCallerName: The API member that calls. - callerMemberName: The member that calls. - """ - ... - - - # Returns a string that represents the current object. - def ToString(self) -> str: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream to which the object is serialized. - """ - ... - - - # Determines whether the specified Object is equal to the current Object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: Object to compare with the current object - """ - ... - - - # Serves as a hash function for this type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: ApiDataObject, b: ApiDataObject) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: ApiDataObject, b: ApiDataObject) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPIClinicalModifyingMethodGuard(self, param1: str) -> Any: - ... - - - # Throws an exception if the caller tries to add more scripting objects of certain types than a preset maximum limit allows. - def EnforceObjectLimits(self, callerMemberName: str) -> Any: - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPINonClinicalModifyingMethodGuard(self, param1: str) -> Any: - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPIClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: - """ - Args: - dataObj: The data object that is modified. - explicitCallerName: The API member that calls. - callerMemberName: The member that calls. - """ - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPINonClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: - """ - Args: - dataObj: The data object that is modified. - explicitCallerName: The API member that calls. - callerMemberName: The member that calls. - """ - ... - - - -class Application: - """ - The main application interface. - - Attributes: - CurrentUser (User): The user who is currently logged on. - PatientSummaries (List[PatientSummary]): Fetches patient summaries from the database. - Calculation (Calculation): Calculation related functions - StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. - Equipment (Equipment): Provides access to clinical devices and accessories. - ScriptEnvironment (ScriptEnvironment): Gets the script environment. - CurrentUser (User): The user who is currently logged on. - PatientSummaries (List[PatientSummary]): Fetches patient summaries from the database. - Calculation (Calculation): Calculation related functions - StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. - Equipment (Equipment): Provides access to clinical devices and accessories. - ScriptEnvironment (ScriptEnvironment): Gets the script environment. - """ - def __init__(self) -> None: ... - - CurrentUser: User - - PatientSummaries: List[PatientSummary] - - Calculation: Calculation - - StructureCodes: ActiveStructureCodeDictionaries - - Equipment: Equipment - - ScriptEnvironment: ScriptEnvironment - - CurrentUser: User - - PatientSummaries: List[PatientSummary] - - Calculation: Calculation - - StructureCodes: ActiveStructureCodeDictionaries - - Equipment: Equipment - - ScriptEnvironment: ScriptEnvironment - - # Releases all unmanaged resources of this object. - def Dispose(self) -> None: - ... - - - # Called only if user forgot to call Dispose() - def Finalize(self) -> Any: - ... - - - # Creates an application instance and logs into the system. - def CreateApplication(self, username: str, password: str) -> Application: - """ - Args: - username: Username for logging in or null value to invoke an interactive login dialog. - password: Password for logging in or null value to invoke an interactive login dialog. - """ - ... - - - # Creates an application instance for a standalone script and logs into the system. - def CreateApplication(self) -> Application: - ... - - - # Opens a patient. - def OpenPatient(self, patientSummary: PatientSummary) -> Patient: - """ - Args: - patientSummary: Patient summary. - """ - ... - - - # Opens a patient by using a patient identifier. - def OpenPatientById(self, id: str) -> Patient: - """ - Args: - id: Patient ID - """ - ... - - - # Closes the current patient. If the script tries to access the data of a closed patient, an access violation exception occurs. - def ClosePatient(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Saves data modifications to the database if saving is allowed. Note: Calling this method can cause a multi-user warning dialog box to appear if the same patient is modified by other parties. - def SaveModifications(self) -> None: - ... - - - # Add HIPAA log record if HIPAA is enabled - def LogExportToHipaa(self, patientId: str) -> Any: - ... - - - # CTRL+BREAK handler, stops script execution - def ConsoleEventHandler(self, eventCode: ConsoleHandlerEventCode) -> Any: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Releases all unmanaged resources of this object. - def Dispose(self) -> None: - ... - - - # Called only if user forgot to call Dispose() - def Finalize(self) -> Any: - ... - - - # Creates an application instance and logs into the system. - def CreateApplication(self, username: str, password: str) -> Application: - """ - Args: - username: Username for logging in or null value to invoke an interactive login dialog. - password: Password for logging in or null value to invoke an interactive login dialog. - """ - ... - - - # Creates an application instance for a standalone script and logs into the system. - def CreateApplication(self) -> Application: - ... - - - # Opens a patient. - def OpenPatient(self, patientSummary: PatientSummary) -> Patient: - """ - Args: - patientSummary: Patient summary. - """ - ... - - - # Opens a patient by using a patient identifier. - def OpenPatientById(self, id: str) -> Patient: - """ - Args: - id: Patient ID - """ - ... - - - # Closes the current patient. If the script tries to access the data of a closed patient, an access violation exception occurs. - def ClosePatient(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Saves data modifications to the database if saving is allowed. Note: Calling this method can cause a multi-user warning dialog box to appear if the same patient is modified by other parties. - def SaveModifications(self) -> None: - ... - - - # Add HIPAA log record if HIPAA is enabled - def LogExportToHipaa(self, patientId: str) -> Any: - ... - - - # CTRL+BREAK handler, stops script execution - def ConsoleEventHandler(self, eventCode: ConsoleHandlerEventCode) -> Any: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Globals: - """ - This class is internal to the Eclipse Scripting API. - - Attributes: - AbortNow (bool): The flag that aborts script execution the next time any property or method of the Eclipse Scripting API is accessed. - DefaultMaximumNumberOfLoggedApiCalls (int): The default maximum number of API calls that are saved in the script execution log. - AbortNow (bool): The flag that aborts script execution the next time any property or method of the Eclipse Scripting API is accessed. - DefaultMaximumNumberOfLoggedApiCalls (int): The default maximum number of API calls that are saved in the script execution log. - """ - # Constructor - @overload - def __init__(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: - ... - - - # Constructor - @overload - def __init__(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: - ... - - - AbortNow: bool - - DefaultMaximumNumberOfLoggedApiCalls: int - - AbortNow: bool - - DefaultMaximumNumberOfLoggedApiCalls: int - - # Initialize custom log - def Initialize(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: - ... - - - # Checks if abort is needed and stops execution. - def CheckAbort(self) -> Any: - ... - - - # Uses System.Diagnostics.Trace with re-entrancy check for the Scripting API. - def Trace(self, message: str) -> Any: - ... - - - # Sets the maximum number of the API calls that are saved in the script execution log. This will clear the existing log entries. - def SetMaximumNumberOfLoggedApiCalls(self, apiLogCacheSize: int) -> None: - """ - Args: - apiLogCacheSize: The cache size for API call logs. Setting the value to zero disables logging. - """ - ... - - - # Returns the last called properties and methods. The oldest cached call is the first. The maximum number of logged calls is set by calling SetMaximumNumberOfLoggedApiCalls. - def GetLoggedApiCalls(self) -> List[str]: - ... - - - # Enables the getting of access information for API members through .NET trace listener. - def EnableApiAccessTrace(self) -> None: - ... - - - # Disables the getting of access information for API members through .NET trace listener. - def DisableApiAccessTrace(self) -> None: - ... - - - # Adds a log entry to custom script log file. - def AddCustomLogEntry(self, message: str, logSeverity: LogSeverity) -> None: - ... - - - # Initialize custom log - def Initialize(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: - ... - - - # Checks if abort is needed and stops execution. - def CheckAbort(self) -> Any: - ... - - - # Uses System.Diagnostics.Trace with re-entrancy check for the Scripting API. - def Trace(self, message: str) -> Any: - ... - - - # Sets the maximum number of the API calls that are saved in the script execution log. This will clear the existing log entries. - def SetMaximumNumberOfLoggedApiCalls(self, apiLogCacheSize: int) -> None: - """ - Args: - apiLogCacheSize: The cache size for API call logs. Setting the value to zero disables logging. - """ - ... - - - # Returns the last called properties and methods. The oldest cached call is the first. The maximum number of logged calls is set by calling SetMaximumNumberOfLoggedApiCalls. - def GetLoggedApiCalls(self) -> List[str]: - ... - - - # Enables the getting of access information for API members through .NET trace listener. - def EnableApiAccessTrace(self) -> None: - ... - - - # Disables the getting of access information for API members through .NET trace listener. - def DisableApiAccessTrace(self) -> None: - ... - - - # Adds a log entry to custom script log file. - def AddCustomLogEntry(self, message: str, logSeverity: LogSeverity) -> None: - ... - - - -class DVHData: - """ - Represents Dose Volume Histogram (DVH) data. - - Attributes: - Coverage (float): The dose coverage of the target, normalized to 0.0 .. 1.0. - CurveData (Array[DVHPoint]): The points of the Dose Volume Histogram (DVH) curve. - MaxDose (DoseValue): The maximum dose. - MaxDosePosition (VVector): The position of the maximum dose. - MeanDose (DoseValue): The mean dose. - MedianDose (DoseValue): The median dose. - MinDose (DoseValue): The minimum dose. - MinDosePosition (VVector): The position of the minimum dose. - SamplingCoverage (float): The sampling coverage. - StdDev (float): The standard deviation. - Volume (float): The volume of the structure in cubic centimeters. - Coverage (float): The dose coverage of the target, normalized to 0.0 .. 1.0. - CurveData (Array[DVHPoint]): The points of the Dose Volume Histogram (DVH) curve. - MaxDose (DoseValue): The maximum dose. - MaxDosePosition (VVector): The position of the maximum dose. - MeanDose (DoseValue): The mean dose. - MedianDose (DoseValue): The median dose. - MinDose (DoseValue): The minimum dose. - MinDosePosition (VVector): The position of the minimum dose. - SamplingCoverage (float): The sampling coverage. - StdDev (float): The standard deviation. - Volume (float): The volume of the structure in cubic centimeters. - """ - def __init__(self) -> None: ... - - Coverage: float - - CurveData: Array[DVHPoint] - - MaxDose: DoseValue - - MaxDosePosition: VVector - - MeanDose: DoseValue - - MedianDose: DoseValue - - MinDose: DoseValue - - MinDosePosition: VVector - - SamplingCoverage: float - - StdDev: float - - Volume: float - - Coverage: float - - CurveData: Array[DVHPoint] - - MaxDose: DoseValue - - MaxDosePosition: VVector - - MeanDose: DoseValue - - MedianDose: DoseValue - - MinDose: DoseValue - - MinDosePosition: VVector - - SamplingCoverage: float - - StdDev: float - - Volume: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class DynamicWedge: - """ - A Dynamic Wedge is formed by a moving jaw of a standard collimator during irradiation. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class EnhancedDynamicWedge: - """ - An Enhanced Dynamic Wedge is similar to a Dynamic Wedge, but it features more wedge angles than a simple Dynamic Wedge. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class FieldReferencePoint: - """ - This object links a treatment beam to a reference point. - - Attributes: - EffectiveDepth (float): The effective depth of the field reference point. For arc fields this is the average value over the span of the arc. - FieldDose (DoseValue): The field dose. - IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. - IsPrimaryReferencePoint (bool): Checks if the reference point is primary. - ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. - RefPointLocation (VVector): The location of the reference point. - SSD (float): The Source-to-Skin Distance (SSD) of the reference point. For arc fields this is the average value over the span of the arc. - EffectiveDepth (float): The effective depth of the field reference point. For arc fields this is the average value over the span of the arc. - FieldDose (DoseValue): The field dose. - IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. - IsPrimaryReferencePoint (bool): Checks if the reference point is primary. - ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. - RefPointLocation (VVector): The location of the reference point. - SSD (float): The Source-to-Skin Distance (SSD) of the reference point. For arc fields this is the average value over the span of the arc. - """ - def __init__(self) -> None: ... - - EffectiveDepth: float - - FieldDose: DoseValue - - IsFieldDoseNominal: bool - - IsPrimaryReferencePoint: bool - - ReferencePoint: ReferencePoint - - RefPointLocation: VVector - - SSD: float - - EffectiveDepth: float - - FieldDose: DoseValue - - IsFieldDoseNominal: bool - - IsPrimaryReferencePoint: bool - - ReferencePoint: ReferencePoint - - RefPointLocation: VVector - - SSD: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Hospital: - """ - Represents a hospital. - - Attributes: - CreationDateTime (Optional[datetime]): The date when this object was created. - Location (str): The location of the hospital. - CreationDateTime (Optional[datetime]): The date when this object was created. - Location (str): The location of the hospital. - """ - def __init__(self) -> None: ... - - CreationDateTime: Optional[datetime] - - Location: str - - CreationDateTime: Optional[datetime] - - Location: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ScriptContext: - """ - Contains the runtime context information of the active application for the script. - - Attributes: - CurrentUser (User): The current user of the application. - Course (Course): The course. The value may be null if the context has no course. - Image (Image): The 3D image. The value may be null if the context has no image. - StructureSet (StructureSet): The structure set. The value may be null if the context has no structure set. - Calculation (Calculation): Calculation related functions - StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. - Equipment (Equipment): Provides access to clinical devices and accessories. - Patient (Patient): The patient. The value may be null if the context has no patient. - PlanSetup (PlanSetup): The plan setup. The value may be null if the context has no plan setup. - ExternalPlanSetup (ExternalPlanSetup): The active external beam plan setup. The value is null if the active object is not an external beam plan setup. - BrachyPlanSetup (BrachyPlanSetup): The active brachytherapy plan setup. The value is null if the active object is not a brachytherapy plan setup. - IonPlanSetup (IonPlanSetup): The active proton plan setup. The value is null if the active object is not a proton plan setup. - PlansInScope (List[PlanSetup]): Retrieves a list of all plans in the Scope window. - ExternalPlansInScope (List[ExternalPlanSetup]): Retrieves a list of all external beam plans in the Scope window. - BrachyPlansInScope (List[BrachyPlanSetup]): Retrieves a list of all brachytherapy plans in the Scope window. - IonPlansInScope (List[IonPlanSetup]): Retrieves a list of all proton plans in the Scope window. - PlanSumsInScope (List[PlanSum]): Retrieves a list of all plan sums in the Scope window. - PlanSum (PlanSum): Retrieves the active plan sum. - ActiveStructure (Any): Retrieves the active structure. - ApplicationName (str): The name of the active application. - VersionInfo (str): The version number of Eclipse. - CurrentUser (User): The current user of the application. - Course (Course): The course. The value may be null if the context has no course. - Image (Image): The 3D image. The value may be null if the context has no image. - StructureSet (StructureSet): The structure set. The value may be null if the context has no structure set. - Calculation (Calculation): Calculation related functions - StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. - Equipment (Equipment): Provides access to clinical devices and accessories. - Patient (Patient): The patient. The value may be null if the context has no patient. - PlanSetup (PlanSetup): The plan setup. The value may be null if the context has no plan setup. - ExternalPlanSetup (ExternalPlanSetup): The active external beam plan setup. The value is null if the active object is not an external beam plan setup. - BrachyPlanSetup (BrachyPlanSetup): The active brachytherapy plan setup. The value is null if the active object is not a brachytherapy plan setup. - IonPlanSetup (IonPlanSetup): The active proton plan setup. The value is null if the active object is not a proton plan setup. - PlansInScope (List[PlanSetup]): Retrieves a list of all plans in the Scope window. - ExternalPlansInScope (List[ExternalPlanSetup]): Retrieves a list of all external beam plans in the Scope window. - BrachyPlansInScope (List[BrachyPlanSetup]): Retrieves a list of all brachytherapy plans in the Scope window. - IonPlansInScope (List[IonPlanSetup]): Retrieves a list of all proton plans in the Scope window. - PlanSumsInScope (List[PlanSum]): Retrieves a list of all plan sums in the Scope window. - PlanSum (PlanSum): Retrieves the active plan sum. - ActiveStructure (Any): Retrieves the active structure. - ApplicationName (str): The name of the active application. - VersionInfo (str): The version number of Eclipse. - """ - # Provides scripts an access to the current data context. A context instance is given as a parameter in the Execute function of the script. The script itself does not instantiate the context. - @overload - def __init__(self, context: Any, user: Any, dvhEstimation: Any, appName: str) -> None: - """ - Args: - context: The internal data context. - user: The internal user object. - dvhEstimation: The internal dvh estimation model library object. - appName: The application name. - """ - ... - - - # Provides scripts an access to the current data context. A context instance is given as a parameter in the Execute function of the script. The script itself does not instantiate the context. - @overload - def __init__(self, context: Any, user: Any, dvhEstimation: Any, appName: str) -> None: - """ - Args: - context: The internal data context. - user: The internal user object. - dvhEstimation: The internal dvh estimation model library object. - appName: The application name. - """ - ... - - - CurrentUser: User - - Course: Course - - Image: Image - - StructureSet: StructureSet - - Calculation: Calculation - - StructureCodes: ActiveStructureCodeDictionaries - - Equipment: Equipment - - Patient: Patient - - PlanSetup: PlanSetup - - ExternalPlanSetup: ExternalPlanSetup - - BrachyPlanSetup: BrachyPlanSetup - - IonPlanSetup: IonPlanSetup - - PlansInScope: List[PlanSetup] - - ExternalPlansInScope: List[ExternalPlanSetup] - - BrachyPlansInScope: List[BrachyPlanSetup] - - IonPlansInScope: List[IonPlanSetup] - - PlanSumsInScope: List[PlanSum] - - PlanSum: PlanSum - - ActiveStructure: Any - - ApplicationName: str - - VersionInfo: str - - CurrentUser: User - - Course: Course - - Image: Image - - StructureSet: StructureSet - - Calculation: Calculation - - StructureCodes: ActiveStructureCodeDictionaries - - Equipment: Equipment - - Patient: Patient - - PlanSetup: PlanSetup - - ExternalPlanSetup: ExternalPlanSetup - - BrachyPlanSetup: BrachyPlanSetup - - IonPlanSetup: IonPlanSetup - - PlansInScope: List[PlanSetup] - - ExternalPlansInScope: List[ExternalPlanSetup] - - BrachyPlansInScope: List[BrachyPlanSetup] - - IonPlansInScope: List[IonPlanSetup] - - PlanSumsInScope: List[PlanSum] - - PlanSum: PlanSum - - ActiveStructure: Any - - ApplicationName: str - - VersionInfo: str - - -class Isodose: - """ - Represents an isodose level for a fixed absolute or relative dose value. - - Attributes: - Color (Windows.Media.Color): The color of the isodose. - Level (DoseValue): The dose value of the isodose level. - MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The triangle mesh of the isodose. Returned for those isodose levels that are rendered in 3D in Eclipse. - Color (Windows.Media.Color): The color of the isodose. - Level (DoseValue): The dose value of the isodose level. - MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The triangle mesh of the isodose. Returned for those isodose levels that are rendered in 3D in Eclipse. - """ - def __init__(self) -> None: ... - - Color: Windows.Media.Color - - Level: DoseValue - - MeshGeometry: Windows.Media.Media3D.MeshGeometry3D - - Color: Windows.Media.Color - - Level: DoseValue - - MeshGeometry: Windows.Media.Media3D.MeshGeometry3D - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class MLC: - """ - Represents a Multileaf Collimator (MLC) add-on. - - Attributes: - ManufacturerName (str): The name of the manufacturer of the Multileaf Collimator (MLC). - MinDoseDynamicLeafGap (float): For dose-dynamic treatments, the minimum gap (mm) between moving, open leaf pairs that the Multileaf Collimator (MLC) hardware can handle. - Model (str): The number or name of the Multileaf Collimator (MLC) model. - SerialNumber (str): The serial number given to the Multileaf Collimator (MLC) by the factory. - ManufacturerName (str): The name of the manufacturer of the Multileaf Collimator (MLC). - MinDoseDynamicLeafGap (float): For dose-dynamic treatments, the minimum gap (mm) between moving, open leaf pairs that the Multileaf Collimator (MLC) hardware can handle. - Model (str): The number or name of the Multileaf Collimator (MLC) model. - SerialNumber (str): The serial number given to the Multileaf Collimator (MLC) by the factory. - """ - def __init__(self) -> None: ... - - ManufacturerName: str - - MinDoseDynamicLeafGap: float - - Model: str - - SerialNumber: str - - ManufacturerName: str - - MinDoseDynamicLeafGap: float - - Model: str - - SerialNumber: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class MotorizedWedge: - """ - A motorized wedge is a standard wedge placed in the beam for a user-defined fraction of the total treatment time. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OmniWedge: - """ - An OmniWedge is a special type of wedge that combines an open field, a motorized wedge, and a virtual wedge to create the desired wedge effect. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Patient: - """ - Represents a patient. - - Attributes: - Courses (List[Course]): A collection of the patient's courses. - CreationDateTime (Optional[datetime]): The date when this object was created. - DateOfBirth (Optional[datetime]): The date of birth of the patient. - DefaultDepartment (str): The default department name. - FirstName (str): The first name of the patient. - HasModifiedData (bool): Returns true if the patient object tree has been modified. - Hospital (Hospital): The hospital. - Id2 (str): The patient ID2. - LastName (str): The last name of the patient. - MiddleName (str): The middle name of the patient. - PrimaryOncologistId (str): The identifier of the primary oncologist. - PrimaryOncologistName (str): The primary oncologist name. - ReferencePoints (List[ReferencePoint]): Collection of all reference points for the patient. - Registrations (List[Registration]): A collection of registrations. - Sex (str): The gender of the patient. - SSN (str): The Social Security Account Number (SSN) of the patient. - StructureSets (List[StructureSet]): A collection of structure sets. - Studies (List[Study]): A collection of studies. - Courses (List[Course]): A collection of the patient's courses. - CreationDateTime (Optional[datetime]): The date when this object was created. - DateOfBirth (Optional[datetime]): The date of birth of the patient. - DefaultDepartment (str): The default department name. - FirstName (str): The first name of the patient. - HasModifiedData (bool): Returns true if the patient object tree has been modified. - Hospital (Hospital): The hospital. - Id2 (str): The patient ID2. - LastName (str): The last name of the patient. - MiddleName (str): The middle name of the patient. - PrimaryOncologistId (str): The identifier of the primary oncologist. - PrimaryOncologistName (str): The primary oncologist name. - ReferencePoints (List[ReferencePoint]): Collection of all reference points for the patient. - Registrations (List[Registration]): A collection of registrations. - Sex (str): The gender of the patient. - SSN (str): The Social Security Account Number (SSN) of the patient. - StructureSets (List[StructureSet]): A collection of structure sets. - Studies (List[Study]): A collection of studies. - """ - def __init__(self) -> None: ... - - Courses: List[Course] - - CreationDateTime: Optional[datetime] - - DateOfBirth: Optional[datetime] - - DefaultDepartment: str - - FirstName: str - - HasModifiedData: bool - - Hospital: Hospital - - Id2: str - - LastName: str - - MiddleName: str - - PrimaryOncologistId: str - - PrimaryOncologistName: str - - ReferencePoints: List[ReferencePoint] - - Registrations: List[Registration] - - Sex: str - - SSN: str - - StructureSets: List[StructureSet] - - Studies: List[Study] - - Courses: List[Course] - - CreationDateTime: Optional[datetime] - - DateOfBirth: Optional[datetime] - - DefaultDepartment: str - - FirstName: str - - HasModifiedData: bool - - Hospital: Hospital - - Id2: str - - LastName: str - - MiddleName: str - - PrimaryOncologistId: str - - PrimaryOncologistName: str - - ReferencePoints: List[ReferencePoint] - - Registrations: List[Registration] - - Sex: str - - SSN: str - - StructureSets: List[StructureSet] - - Studies: List[Study] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new course to this patient. - def AddCourse(self) -> Course: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds an empty phantom image to the patient. The empty image is created in a new study. A new structure set is created for the image. - def AddEmptyPhantom(self, imageId: str, orientation: PatientOrientation, xSizePixel: int, ySizePixel: int, widthMM: float, heightMM: float, nrOfPlanes: int, planeSepMM: float) -> StructureSet: - """ - Args: - imageId: The identifier for the empty image to be created. The value must not be empty. - orientation: The patient orientation in the image. - xSizePixel: The x size of the image in pixels. The expected value is from 23 to 2048 pixels. - ySizePixel: The y size of the image in pixels. The expected value is from 23 to 2048 pixels. - widthMM: The height of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. - heightMM: The width of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. - nrOfPlanes: The number of planes in the image. The expected value is from 1 to 10000. - planeSepMM: The distance between the planes in millimeters. The expected value is from 0.1 to 200.0 millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add reference point to a patient - def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: - """ - Args: - target: True if point being added is for target volume - id: Identifier for the new reference point - """ - ... - - - # Enables write-access to the data model from the Scripting API. This function must be called for each patient the script modifies. If this function is not called, the data in the database cannot be modified. - def BeginModifications(self) -> None: - ... - - - # Checks if a new course can be added to the patient. - def CanAddCourse(self) -> bool: - ... - - - # Checks if an empty phantom can be added to the patient. The user should have the appropriate permissions to perform the operation. - def CanAddEmptyPhantom(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If phantom adding is not permitted, contains the error message. - """ - ... - - - # Checks if the image can be copied from the other patient. - def CanCopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str, errorMessage: str) -> bool: - """ - Args: - targetStudy: The target study for the new image series, or null. - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - errorMessage: If copying the image is not permitted, contains the error message. - """ - ... - - - # Returns true if the script can modify patient data in the database. - def CanModifyData(self) -> bool: - ... - - - # Checks if the course can be removed from the patient. - def CanRemoveCourse(self, course: Course) -> bool: - """ - Args: - course: The course to be removed. - """ - ... - - - # Checks if the image can be removed. The image to be removed and the associated structure set should be empty. - def CanRemoveEmptyPhantom(self, structureset: StructureSet, errorMessage: str) -> bool: - """ - Args: - structureset: The structure set to be removed. - errorMessage: If the image and associated structure set cannot be removed, contains the error message. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to this patient. A new study and series is created for the image. The method - def CopyImageFromOtherPatient(self, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: - """ - Args: - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to the given study. A new series is created for the image. The method - def CopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: - """ - Args: - targetStudy: The target study for the new image series. - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the course from the patient and deletes it. - def RemoveCourse(self, course: Course) -> None: - """ - Args: - course: The course that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes an empty image from the patient. The associated structure set is also removed. The image to be removed and the associated structure set should be empty. - def RemoveEmptyPhantom(self, structureset: StructureSet) -> None: - """ - Args: - structureset: The structure set to be removed. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new course to this patient. - def AddCourse(self) -> Course: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds an empty phantom image to the patient. The empty image is created in a new study. A new structure set is created for the image. - def AddEmptyPhantom(self, imageId: str, orientation: PatientOrientation, xSizePixel: int, ySizePixel: int, widthMM: float, heightMM: float, nrOfPlanes: int, planeSepMM: float) -> StructureSet: - """ - Args: - imageId: The identifier for the empty image to be created. The value must not be empty. - orientation: The patient orientation in the image. - xSizePixel: The x size of the image in pixels. The expected value is from 23 to 2048 pixels. - ySizePixel: The y size of the image in pixels. The expected value is from 23 to 2048 pixels. - widthMM: The height of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. - heightMM: The width of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. - nrOfPlanes: The number of planes in the image. The expected value is from 1 to 10000. - planeSepMM: The distance between the planes in millimeters. The expected value is from 0.1 to 200.0 millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add reference point to a patient - def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: - """ - Args: - target: True if point being added is for target volume - id: Identifier for the new reference point - """ - ... - - - # Enables write-access to the data model from the Scripting API. This function must be called for each patient the script modifies. If this function is not called, the data in the database cannot be modified. - def BeginModifications(self) -> None: - ... - - - # Checks if a new course can be added to the patient. - def CanAddCourse(self) -> bool: - ... - - - # Checks if an empty phantom can be added to the patient. The user should have the appropriate permissions to perform the operation. - def CanAddEmptyPhantom(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If phantom adding is not permitted, contains the error message. - """ - ... - - - # Checks if the image can be copied from the other patient. - def CanCopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str, errorMessage: str) -> bool: - """ - Args: - targetStudy: The target study for the new image series, or null. - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - errorMessage: If copying the image is not permitted, contains the error message. - """ - ... - - - # Returns true if the script can modify patient data in the database. - def CanModifyData(self) -> bool: - ... - - - # Checks if the course can be removed from the patient. - def CanRemoveCourse(self, course: Course) -> bool: - """ - Args: - course: The course to be removed. - """ - ... - - - # Checks if the image can be removed. The image to be removed and the associated structure set should be empty. - def CanRemoveEmptyPhantom(self, structureset: StructureSet, errorMessage: str) -> bool: - """ - Args: - structureset: The structure set to be removed. - errorMessage: If the image and associated structure set cannot be removed, contains the error message. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to this patient. A new study and series is created for the image. The method - def CopyImageFromOtherPatient(self, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: - """ - Args: - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to the given study. A new series is created for the image. The method - def CopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: - """ - Args: - targetStudy: The target study for the new image series. - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the course from the patient and deletes it. - def RemoveCourse(self, course: Course) -> None: - """ - Args: - course: The course that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes an empty image from the patient. The associated structure set is also removed. The image to be removed and the associated structure set should be empty. - def RemoveEmptyPhantom(self, structureset: StructureSet) -> None: - """ - Args: - structureset: The structure set to be removed. - """ - ... - - - -class PatientSummary: - """ - Basic information about the patient. - - Attributes: - CreationDateTime (Optional[datetime]): The date when the patient object was created. - DateOfBirth (Optional[datetime]): The date of birth of the patient. - FirstName (str): The first name of the patient. - Id (str): The patient ID. - Id2 (str): The patient ID2. - LastName (str): The last name of the patient. - MiddleName (str): The middle name of the patient. - Sex (str): The gender of the patient. - SSN (str): The Social Security Account Number (SSN) of the patient. - CreationDateTime (Optional[datetime]): The date when the patient object was created. - DateOfBirth (Optional[datetime]): The date of birth of the patient. - FirstName (str): The first name of the patient. - Id (str): The patient ID. - Id2 (str): The patient ID2. - LastName (str): The last name of the patient. - MiddleName (str): The middle name of the patient. - Sex (str): The gender of the patient. - SSN (str): The Social Security Account Number (SSN) of the patient. - """ - def __init__(self) -> None: ... - - CreationDateTime: Optional[datetime] - - DateOfBirth: Optional[datetime] - - FirstName: str - - Id: str - - Id2: str - - LastName: str - - MiddleName: str - - Sex: str - - SSN: str - - CreationDateTime: Optional[datetime] - - DateOfBirth: Optional[datetime] - - FirstName: str - - Id: str - - Id2: str - - LastName: str - - MiddleName: str - - Sex: str - - SSN: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PlanningItem: - """ - Common properties of a treatment plan and a plan sum. - - Attributes: - Course (Course): Used for navigating to parent course. - CreationDateTime (Optional[datetime]): The date when this object was created. - Dose (PlanningItemDose): The total dose. The total dose is the dose of all planned fractions together. - DoseValuePresentation (DoseValuePresentation): The presentation of the dose as absolute or relative. - StructureSet (StructureSet): The structure set. - StructuresSelectedForDvh (List[Structure]): The collection of the structures that have been selected for DVH evaluation in Eclipse. - Course (Course): Used for navigating to parent course. - CreationDateTime (Optional[datetime]): The date when this object was created. - Dose (PlanningItemDose): The total dose. The total dose is the dose of all planned fractions together. - DoseValuePresentation (DoseValuePresentation): The presentation of the dose as absolute or relative. - StructureSet (StructureSet): The structure set. - StructuresSelectedForDvh (List[Structure]): The collection of the structures that have been selected for DVH evaluation in Eclipse. - """ - def __init__(self) -> None: ... - - Course: Course - - CreationDateTime: Optional[datetime] - - Dose: PlanningItemDose - - DoseValuePresentation: DoseValuePresentation - - StructureSet: StructureSet - - StructuresSelectedForDvh: List[Structure] - - Course: Course - - CreationDateTime: Optional[datetime] - - Dose: PlanningItemDose - - DoseValuePresentation: DoseValuePresentation - - StructureSet: StructureSet - - StructuresSelectedForDvh: List[Structure] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Get the list of clinical goals assigned to a planning item. - def GetClinicalGoals(self) -> List[ClinicalGoal]: - ... - - - # Returns cumulative Dose Volume Histogram (DVH) data. - def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: - """ - Args: - structure: Structure for which the DVH data is requested. - dosePresentation: Requested dose presentation mode (absolute or relative). Note, that only absolute dose is supported for PlanSums. - volumePresentation: Requested volume presentation mode. - binWidth: Requested width of the bin. - """ - ... - - - # Gets the dose at a volume. - def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: - """ - Args: - structure: Structure for which the value is requested. - volume: Volume at which the dose is requested. - volumePresentation: Presentation mode of the volume parameter. - requestedDosePresentation: Requested dose presentation mode (absolute or relative). - """ - ... - - - # Gets the volume at the dose. - def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: - """ - Args: - structure: Structure for which the value is requested. - dose: Dose at which the volume is requested. - requestedVolumePresentation: Requested volume presentation mode. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Get the list of clinical goals assigned to a planning item. - def GetClinicalGoals(self) -> List[ClinicalGoal]: - ... - - - # Returns cumulative Dose Volume Histogram (DVH) data. - def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: - """ - Args: - structure: Structure for which the DVH data is requested. - dosePresentation: Requested dose presentation mode (absolute or relative). Note, that only absolute dose is supported for PlanSums. - volumePresentation: Requested volume presentation mode. - binWidth: Requested width of the bin. - """ - ... - - - # Gets the dose at a volume. - def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: - """ - Args: - structure: Structure for which the value is requested. - volume: Volume at which the dose is requested. - volumePresentation: Presentation mode of the volume parameter. - requestedDosePresentation: Requested dose presentation mode (absolute or relative). - """ - ... - - - # Gets the volume at the dose. - def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: - """ - Args: - structure: Structure for which the value is requested. - dose: Dose at which the volume is requested. - requestedVolumePresentation: Requested volume presentation mode. - """ - ... - - - -class PlanSum: - """ - A plan sum describes the cumulative dose summation of several treatment plans. It can be used, for example, to evaluate the dose the patient received from a treatment plan and boost plan together. - - Attributes: - PlanSumComponents (List[PlanSumComponent]): A collection of plans in a plan sum. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSum. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the PlanSum. - PlanSetups (List[PlanSetup]): A collection of plan setups. - PlanSumComponents (List[PlanSumComponent]): A collection of plans in a plan sum. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSum. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the PlanSum. - PlanSetups (List[PlanSetup]): A collection of plan setups. - """ - def __init__(self) -> None: ... - - PlanSumComponents: List[PlanSumComponent] - - Id: str - - Name: str - - PlanSetups: List[PlanSetup] - - PlanSumComponents: List[PlanSumComponent] - - Id: str - - Name: str - - PlanSetups: List[PlanSetup] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum with default parameters ( - def AddItem(self, pi: PlanningItem) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum. If item to be added is a plan sum, all plans of the plan sum will be added. - def AddItem(self, pi: PlanningItem, operation: PlanSumOperation, planWeight: float) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - operation: The summing operation of the plan in the plan sum. - planWeight: Plan weight - """ - ... - - - # Returns the summing operation of the plan in the plan sum. - def GetPlanSumOperation(self, planSetupInPlanSum: PlanSetup) -> PlanSumOperation: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - """ - ... - - - # Returns the weight of the plan included in the sum. - def GetPlanWeight(self, planSetupInPlanSum: PlanSetup) -> float: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove a planning item from the plan sum. If item to be removed is a plan sum, all plans of the plan sum will be removed. - def RemoveItem(self, pi: PlanningItem) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the summing operation for the plan in the plan sum. - def SetPlanSumOperation(self, planSetupInPlanSum: PlanSetup, operation: PlanSumOperation) -> None: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - operation: The summing operation of the plan in the plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the weight of the plan included in the sum. - def SetPlanWeight(self, planSetupInPlanSum: PlanSetup, weight: float) -> None: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - weight: Plan weight - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum with default parameters ( - def AddItem(self, pi: PlanningItem) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum. If item to be added is a plan sum, all plans of the plan sum will be added. - def AddItem(self, pi: PlanningItem, operation: PlanSumOperation, planWeight: float) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - operation: The summing operation of the plan in the plan sum. - planWeight: Plan weight - """ - ... - - - # Returns the summing operation of the plan in the plan sum. - def GetPlanSumOperation(self, planSetupInPlanSum: PlanSetup) -> PlanSumOperation: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - """ - ... - - - # Returns the weight of the plan included in the sum. - def GetPlanWeight(self, planSetupInPlanSum: PlanSetup) -> float: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove a planning item from the plan sum. If item to be removed is a plan sum, all plans of the plan sum will be removed. - def RemoveItem(self, pi: PlanningItem) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the summing operation for the plan in the plan sum. - def SetPlanSumOperation(self, planSetupInPlanSum: PlanSetup, operation: PlanSumOperation) -> None: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - operation: The summing operation of the plan in the plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the weight of the plan included in the sum. - def SetPlanWeight(self, planSetupInPlanSum: PlanSetup, weight: float) -> None: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - weight: Plan weight - """ - ... - - - -class SerializableObject: - """ - Base class for objects that can be serialized. - """ - def __init__(self) -> None: ... - - # This member is internal to the Eclipse Scripting API. - def GetSchema(self) -> Xml.Schema.XmlSchema: - ... - - - # This member is internal to the Eclipse Scripting API. - def ReadXml(self, reader: Xml.XmlReader) -> None: - """ - Args: - reader: XmlReader - """ - ... - - - # Serializes this object to the given XmlWriter. - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: XmlWriter where this object is serialized. - """ - ... - - - # Serializes everything except IEnumerable. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Any) -> None: - """ - Args: - writer: XmlWriter - name: Name. - obj: Object. - """ - ... - - - # Serializes a string. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: str) -> None: - """ - Args: - writer: XmlWriter. - name: Name. - obj: String. - """ - ... - - - # Serializes IEnumerable. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: IEnumerable[T]) -> None: - ... - - - # Serializes IDictionary. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Dict[T, T2]) -> None: - ... - - - # Must be called at the beginning of serialization - def StartSerialization(self, typeName: str, typeId: str) -> Any: - """ - Args: - typeName: Name of the type to serialize. - typeId: Id of the object. - """ - ... - - - # Must be called at the end of serialization. Clear history records and type names. - def EndSerialization(self) -> Any: - ... - - - # Check if history contains information about class - def IsTypeSerialized(self) -> Any: - ... - - - # Add history record - def AddTypeToHistory(self) -> Any: - ... - - - # This member is internal to the Eclipse Scripting API. - def ClearSerializationHistory(self) -> None: - ... - - - # This member is internal to the Eclipse Scripting API. - def GetSchema(self) -> Xml.Schema.XmlSchema: - ... - - - # This member is internal to the Eclipse Scripting API. - def ReadXml(self, reader: Xml.XmlReader) -> None: - """ - Args: - reader: XmlReader - """ - ... - - - # Serializes this object to the given XmlWriter. - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: XmlWriter where this object is serialized. - """ - ... - - - # Serializes everything except IEnumerable. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Any) -> None: - """ - Args: - writer: XmlWriter - name: Name. - obj: Object. - """ - ... - - - # Serializes a string. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: str) -> None: - """ - Args: - writer: XmlWriter. - name: Name. - obj: String. - """ - ... - - - # Serializes IEnumerable. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: IEnumerable[T]) -> None: - ... - - - # Serializes IDictionary. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Dict[T, T2]) -> None: - ... - - - # Must be called at the beginning of serialization - def StartSerialization(self, typeName: str, typeId: str) -> Any: - """ - Args: - typeName: Name of the type to serialize. - typeId: Id of the object. - """ - ... - - - # Must be called at the end of serialization. Clear history records and type names. - def EndSerialization(self) -> Any: - ... - - - # Check if history contains information about class - def IsTypeSerialized(self) -> Any: - ... - - - # Add history record - def AddTypeToHistory(self) -> Any: - ... - - - # This member is internal to the Eclipse Scripting API. - def ClearSerializationHistory(self) -> None: - ... - - - -class Registration: - """ - Represents the spatial registration matrix between two frames of reference. - - Attributes: - CreationDateTime (Optional[datetime]): The date when this object was created. - RegisteredFOR (str): The frame of reference UID of the registered coordinate system. - SourceFOR (str): The frame of reference UID of the source coordinate system. - Status (RegistrationApprovalStatus): The current approval status of the registration. - StatusDateTime (Optional[datetime]): The approval status date and time. - StatusUserDisplayName (str): Full user name of user who changed the approval status. - StatusUserName (str): User ID of the user who changed the approval status. - TransformationMatrix (Array[float]): The elements of the 4x4 transformation matrix. - UID (str): The SOP Instance UID of this registration object. - CreationDateTime (Optional[datetime]): The date when this object was created. - RegisteredFOR (str): The frame of reference UID of the registered coordinate system. - SourceFOR (str): The frame of reference UID of the source coordinate system. - Status (RegistrationApprovalStatus): The current approval status of the registration. - StatusDateTime (Optional[datetime]): The approval status date and time. - StatusUserDisplayName (str): Full user name of user who changed the approval status. - StatusUserName (str): User ID of the user who changed the approval status. - TransformationMatrix (Array[float]): The elements of the 4x4 transformation matrix. - UID (str): The SOP Instance UID of this registration object. - """ - def __init__(self) -> None: ... - - CreationDateTime: Optional[datetime] - - RegisteredFOR: str - - SourceFOR: str - - Status: RegistrationApprovalStatus - - StatusDateTime: Optional[datetime] - - StatusUserDisplayName: str - - StatusUserName: str - - TransformationMatrix: Array[float] - - UID: str - - CreationDateTime: Optional[datetime] - - RegisteredFOR: str - - SourceFOR: str - - Status: RegistrationApprovalStatus - - StatusDateTime: Optional[datetime] - - StatusUserDisplayName: str - - StatusUserName: str - - TransformationMatrix: Array[float] - - UID: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Transforms a point in the inverse direction, that is, from the coordinate system of the RegisteredFOR to the coordinate system of the SourceFOR. - def InverseTransformPoint(self, pt: VVector) -> VVector: - """ - Args: - pt: Point in the RegisteredFOR coordinate system. - """ - ... - - - # Transforms a point from the SourceFOR coordinate system to the RegisteredFOR coordinate system. - def TransformPoint(self, pt: VVector) -> VVector: - """ - Args: - pt: Point in the SourceFOR coordinate system. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Transforms a point in the inverse direction, that is, from the coordinate system of the RegisteredFOR to the coordinate system of the SourceFOR. - def InverseTransformPoint(self, pt: VVector) -> VVector: - """ - Args: - pt: Point in the RegisteredFOR coordinate system. - """ - ... - - - # Transforms a point from the SourceFOR coordinate system to the RegisteredFOR coordinate system. - def TransformPoint(self, pt: VVector) -> VVector: - """ - Args: - pt: Point in the SourceFOR coordinate system. - """ - ... - - - -class Series: - """ - A series is a collection of radiation therapy objects of a patient. The series is part of a study. See the definition of a DICOM Series for more information. - - Attributes: - FOR (str): The UID of the frame of reference. - Images (List[Image]): A collection of images that belong to the series. - ImagingDeviceDepartment (str): The assigned department of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device department is not defined. - ImagingDeviceId (str): The identifier of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device identifier is not defined. - ImagingDeviceManufacturer (str): The manufacturer of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device manufacturer is not defined. - ImagingDeviceModel (str): The model of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device model is not defined. - ImagingDeviceSerialNo (str): The serial number of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device serial number is not defined. - Modality (SeriesModality): The modality of the series. - Study (Study): Used for navigating to parent study. - UID (str): The DICOM UID. - FOR (str): The UID of the frame of reference. - Images (List[Image]): A collection of images that belong to the series. - ImagingDeviceDepartment (str): The assigned department of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device department is not defined. - ImagingDeviceId (str): The identifier of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device identifier is not defined. - ImagingDeviceManufacturer (str): The manufacturer of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device manufacturer is not defined. - ImagingDeviceModel (str): The model of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device model is not defined. - ImagingDeviceSerialNo (str): The serial number of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device serial number is not defined. - Modality (SeriesModality): The modality of the series. - Study (Study): Used for navigating to parent study. - UID (str): The DICOM UID. - """ - def __init__(self) -> None: ... - - FOR: str - - Images: List[Image] - - ImagingDeviceDepartment: str - - ImagingDeviceId: str - - ImagingDeviceManufacturer: str - - ImagingDeviceModel: str - - ImagingDeviceSerialNo: str - - Modality: SeriesModality - - Study: Study - - UID: str - - FOR: str - - Images: List[Image] - - ImagingDeviceDepartment: str - - ImagingDeviceId: str - - ImagingDeviceManufacturer: str - - ImagingDeviceModel: str - - ImagingDeviceSerialNo: str - - Modality: SeriesModality - - Study: Study - - UID: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the imaging device for the image series based on the identifier of the imaging device. If the imaging device identifier is not found, an exception is thrown. - def SetImagingDevice(self, imagingDeviceId: str) -> None: - """ - Args: - imagingDeviceId: Identifier of the imaging device. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the imaging device for the image series based on the identifier of the imaging device. If the imaging device identifier is not found, an exception is thrown. - def SetImagingDevice(self, imagingDeviceId: str) -> None: - """ - Args: - imagingDeviceId: Identifier of the imaging device. - """ - ... - - - -class Slot: - """ - A slot is the location (typically on the collimator head of the gantry) where an add-on, such as a wedge or block, is mounted. - - Attributes: - Number (int): The slot number is unique within an instance of a treatment machine. - Number (int): The slot number is unique within an instance of a treatment machine. - """ - def __init__(self) -> None: ... - - Number: int - - Number: int - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Study: - """ - A study is a collection of series. - - Attributes: - CreationDateTime (Optional[datetime]): The date when this object was created. - Images3D (List[Image]): A collection of 3D images in a study. - Series (List[Series]): A collection of series. - UID (str): The DICOM UID. - CreationDateTime (Optional[datetime]): The date when this object was created. - Images3D (List[Image]): A collection of 3D images in a study. - Series (List[Series]): A collection of series. - UID (str): The DICOM UID. - """ - def __init__(self) -> None: ... - - CreationDateTime: Optional[datetime] - - Images3D: List[Image] - - Series: List[Series] - - UID: str - - CreationDateTime: Optional[datetime] - - Images3D: List[Image] - - Series: List[Series] - - UID: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Technique: - """ - Treatment technique used for a beam. Can be, for example, static or arc, or (for proton beams) modulated scanning. - - Attributes: - IsArc (bool): Returns the value true if the beam technique is 'ARC' or 'SRS ARC'. - IsModulatedScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING'. - IsProton (bool): Returns the value true if it is a proton beam. - IsScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING' or 'UNIFORM_SCANNING'. - IsStatic (bool): Returns the value true if the beam technique is 'STATIC' or 'SRS STATIC'. - IsArc (bool): Returns the value true if the beam technique is 'ARC' or 'SRS ARC'. - IsModulatedScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING'. - IsProton (bool): Returns the value true if it is a proton beam. - IsScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING' or 'UNIFORM_SCANNING'. - IsStatic (bool): Returns the value true if the beam technique is 'STATIC' or 'SRS STATIC'. - """ - def __init__(self) -> None: ... - - IsArc: bool - - IsModulatedScanning: bool - - IsProton: bool - - IsScanning: bool - - IsStatic: bool - - IsArc: bool - - IsModulatedScanning: bool - - IsProton: bool - - IsScanning: bool - - IsStatic: bool - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class TradeoffObjective: - """ - Trade-off objective interface that consists of a set of optimization objectives. - - Attributes: - Id (int): Identifier of the trade-off objective. - OptimizationObjectives (List[OptimizationObjective]): The collection of objectives that this trade-off objective represents. - Structure (Structure): Structure that this trade-off objective represents. - Id (int): Identifier of the trade-off objective. - OptimizationObjectives (List[OptimizationObjective]): The collection of objectives that this trade-off objective represents. - Structure (Structure): Structure that this trade-off objective represents. - """ - def __init__(self) -> None: ... - - Id: int - - OptimizationObjectives: List[OptimizationObjective] - - Structure: Structure - - Id: int - - OptimizationObjectives: List[OptimizationObjective] - - Structure: Structure - - -class Tray: - """ - A tray add-on is a plate where blocks, compensators, and other beam modifying materials can be fixed to. The tray is inserted into a slot during the treatment of a beam. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class TreatmentPhase: - """ - Treatment phase. - - Attributes: - OtherInfo (str): Other info (notes). - PhaseGapNumberOfDays (int): Number of days between phases. - Prescriptions (List[RTPrescription]): A collection of RT prescriptions in the course. - TimeGapType (str): Type of the time gap. - OtherInfo (str): Other info (notes). - PhaseGapNumberOfDays (int): Number of days between phases. - Prescriptions (List[RTPrescription]): A collection of RT prescriptions in the course. - TimeGapType (str): Type of the time gap. - """ - def __init__(self) -> None: ... - - OtherInfo: str - - PhaseGapNumberOfDays: int - - Prescriptions: List[RTPrescription] - - TimeGapType: str - - OtherInfo: str - - PhaseGapNumberOfDays: int - - Prescriptions: List[RTPrescription] - - TimeGapType: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class TreatmentSession: - """ - Treatment session. - - Attributes: - SessionNumber (int): Treatment session number. - SessionPlans (List[PlanTreatmentSession]): Plans in this treatment session. - SessionNumber (int): Treatment session number. - SessionPlans (List[PlanTreatmentSession]): Plans in this treatment session. - """ - def __init__(self) -> None: ... - - SessionNumber: int - - SessionPlans: List[PlanTreatmentSession] - - SessionNumber: int - - SessionPlans: List[PlanTreatmentSession] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class TreatmentUnitOperatingLimit: - """ - Describes the limits of a treatment unit parameter and provides descriptive information related to it. - - Attributes: - Label (str): Gets the descriptive name of the operating limit parameter. - MaxValue (float): Gets the maximum allowed value for the operating limit parameter. - MinValue (float): Gets the minimum allowed value for the operating limit parameter. - Precision (Optional[int]): Gets the number of decimal places to display for the operating limit parameter. - UnitString (str): Gets the string that describes the unit of the operating limit parameter. - Label (str): Gets the descriptive name of the operating limit parameter. - MaxValue (float): Gets the maximum allowed value for the operating limit parameter. - MinValue (float): Gets the minimum allowed value for the operating limit parameter. - Precision (Optional[int]): Gets the number of decimal places to display for the operating limit parameter. - UnitString (str): Gets the string that describes the unit of the operating limit parameter. - """ - def __init__(self) -> None: ... - - Label: str - - MaxValue: float - - MinValue: float - - Precision: Optional[int] - - UnitString: str - - Label: str - - MaxValue: float - - MinValue: float - - Precision: Optional[int] - - UnitString: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class TreatmentUnitOperatingLimits: - """ - Provides operating limit information for treatment unit parameters. - - Attributes: - CollimatorAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the collimator angle parameter. - GantryAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the gantry angle parameter. - MU (TreatmentUnitOperatingLimit): Gets the operating limit information for the monitor unit (MU) parameter. - PatientSupportAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the patient support angle parameter. - CollimatorAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the collimator angle parameter. - GantryAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the gantry angle parameter. - MU (TreatmentUnitOperatingLimit): Gets the operating limit information for the monitor unit (MU) parameter. - PatientSupportAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the patient support angle parameter. - """ - def __init__(self) -> None: ... - - CollimatorAngle: TreatmentUnitOperatingLimit - - GantryAngle: TreatmentUnitOperatingLimit - - MU: TreatmentUnitOperatingLimit - - PatientSupportAngle: TreatmentUnitOperatingLimit - - CollimatorAngle: TreatmentUnitOperatingLimit - - GantryAngle: TreatmentUnitOperatingLimit - - MU: TreatmentUnitOperatingLimit - - PatientSupportAngle: TreatmentUnitOperatingLimit - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Wedge: - """ - A wedge is a beam modulating add-on that modifies the dose intensity over all or a part of a treatment beam. - - Attributes: - Direction (float): The wedge orientation with respect to the beam orientation, in degrees. - WedgeAngle (float): The wedge angle. - Direction (float): The wedge orientation with respect to the beam orientation, in degrees. - WedgeAngle (float): The wedge angle. - - Note: - Use run-time type information via operator - """ - def __init__(self) -> None: ... - - Direction: float - - WedgeAngle: float - - Direction: float - - WedgeAngle: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class AddOn: - """ - Represents an add-on, which is a beam modifying device that is inserted into a beam in an accessory slot of the external beam machine. An add-on is used to shape the beam or modulate its intensity or both. Add-ons are blocks, MLCs, wedges, compensators, applicators, a tray, and other devices or materials that can be fixed to a tray to be mounted into an accessory slot. - - Attributes: - CreationDateTime (Optional[datetime]): The date when this object was created. - CreationDateTime (Optional[datetime]): The date when this object was created. - """ - def __init__(self) -> None: ... - - CreationDateTime: Optional[datetime] - - CreationDateTime: Optional[datetime] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class AddOnMaterial: - """ - Add-on material describes the dosimetric and physical properties of the metal alloy or other substance used to create the add-on. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ApplicationPackage: - """ - Presents the application package information in the system. Note: not all methods are necessarily Published at the moment. - - Attributes: - ApprovalStatus (ApplicationScriptApprovalStatus): The status of the application package. Possible values are defined by a lookup RT_APP_EXTENSION_STATUS. - Description (str): Description of functionality provided by the package. - ExpirationDate (Optional[datetime]): An optional expiration date of the package. The package cannot be executed after expiration date. The date is presented in UTC. - PackageId (str): Unique Package ID. - PackageName (str): The full name of the package. - PackageVersion (str): The version number of the package. - PublisherData (str): Optional JSON data that can be used by package internally, e.g. customer key. - PublisherName (str): The name of the organization or author that created the package. This is a free text that can be set by the approver. - ApprovalStatus (ApplicationScriptApprovalStatus): The status of the application package. Possible values are defined by a lookup RT_APP_EXTENSION_STATUS. - Description (str): Description of functionality provided by the package. - ExpirationDate (Optional[datetime]): An optional expiration date of the package. The package cannot be executed after expiration date. The date is presented in UTC. - PackageId (str): Unique Package ID. - PackageName (str): The full name of the package. - PackageVersion (str): The version number of the package. - PublisherData (str): Optional JSON data that can be used by package internally, e.g. customer key. - PublisherName (str): The name of the organization or author that created the package. This is a free text that can be set by the approver. - """ - def __init__(self) -> None: ... - - ApprovalStatus: ApplicationScriptApprovalStatus - - Description: str - - ExpirationDate: Optional[datetime] - - PackageId: str - - PackageName: str - - PackageVersion: str - - PublisherData: str - - PublisherName: str - - ApprovalStatus: ApplicationScriptApprovalStatus - - Description: str - - ExpirationDate: Optional[datetime] - - PackageId: str - - PackageName: str - - PackageVersion: str - - PublisherData: str - - PublisherName: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ApplicationScript: - """ - Presents the application script information in the system. The location of the script file is not stored in the system. - - Attributes: - ApprovalStatus (ApplicationScriptApprovalStatus): The status of the script. - ApprovalStatusDisplayText (str): The display text of the approval status. - AssemblyName (Reflection.AssemblyName): The full name of the script assembly. - ExpirationDate (Optional[datetime]): An optional expiration date of the script. The script cannot be executed after expiration date. The date is presented in UTC. - IsReadOnlyScript (bool): Returns true if the script is intended only to read patient data. - IsWriteableScript (bool): Returns true if the script is intended to modify persistent data. - PublisherName (str): The name of the organization or author that created the script. This is a free text that can be set by the approver. - ScriptType (ApplicationScriptType): The type of the application script. - StatusDate (Optional[datetime]): A timestamp of the last approval status modification. - StatusUserIdentity (UserIdentity): The identity of the user who last modified the approval status. - ApprovalStatus (ApplicationScriptApprovalStatus): The status of the script. - ApprovalStatusDisplayText (str): The display text of the approval status. - AssemblyName (Reflection.AssemblyName): The full name of the script assembly. - ExpirationDate (Optional[datetime]): An optional expiration date of the script. The script cannot be executed after expiration date. The date is presented in UTC. - IsReadOnlyScript (bool): Returns true if the script is intended only to read patient data. - IsWriteableScript (bool): Returns true if the script is intended to modify persistent data. - PublisherName (str): The name of the organization or author that created the script. This is a free text that can be set by the approver. - ScriptType (ApplicationScriptType): The type of the application script. - StatusDate (Optional[datetime]): A timestamp of the last approval status modification. - StatusUserIdentity (UserIdentity): The identity of the user who last modified the approval status. - """ - def __init__(self) -> None: ... - - ApprovalStatus: ApplicationScriptApprovalStatus - - ApprovalStatusDisplayText: str - - AssemblyName: Reflection.AssemblyName - - ExpirationDate: Optional[datetime] - - IsReadOnlyScript: bool - - IsWriteableScript: bool - - PublisherName: str - - ScriptType: ApplicationScriptType - - StatusDate: Optional[datetime] - - StatusUserIdentity: UserIdentity - - ApprovalStatus: ApplicationScriptApprovalStatus - - ApprovalStatusDisplayText: str - - AssemblyName: Reflection.AssemblyName - - ExpirationDate: Optional[datetime] - - IsReadOnlyScript: bool - - IsWriteableScript: bool - - PublisherName: str - - ScriptType: ApplicationScriptType - - StatusDate: Optional[datetime] - - StatusUserIdentity: UserIdentity - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ApplicationScriptLog: - """ - The log entry of the application script execution. - - Attributes: - CourseId (str): The identifier of the course that was modified by the script. - PatientId (str): The identifier of the patient that was modified by the script. - PlanSetupId (str): The identifier of the plan that was modified by the script, or an empty string if the script did not modify the plan. - PlanUID (str): The DICOM UID of the plan that was modified by the script, or an empty string if the script did not modify the plan. - Script (ApplicationScript): The script that modified the plan or structure set. - ScriptFullName (str): The full name of the script assembly that modified the plan or structure set. A System.Reflection.AssemblyName object can be created from the string. - StructureSetId (str): The identifier of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. - StructureSetUID (str): The DICOM UID of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. - CourseId (str): The identifier of the course that was modified by the script. - PatientId (str): The identifier of the patient that was modified by the script. - PlanSetupId (str): The identifier of the plan that was modified by the script, or an empty string if the script did not modify the plan. - PlanUID (str): The DICOM UID of the plan that was modified by the script, or an empty string if the script did not modify the plan. - Script (ApplicationScript): The script that modified the plan or structure set. - ScriptFullName (str): The full name of the script assembly that modified the plan or structure set. A System.Reflection.AssemblyName object can be created from the string. - StructureSetId (str): The identifier of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. - StructureSetUID (str): The DICOM UID of the structure set that was modified by the script, or an empty string if the script did not modify the structure set. - """ - def __init__(self) -> None: ... - - CourseId: str - - PatientId: str - - PlanSetupId: str - - PlanUID: str - - Script: ApplicationScript - - ScriptFullName: str - - StructureSetId: str - - StructureSetUID: str - - CourseId: str - - PatientId: str - - PlanSetupId: str - - PlanUID: str - - Script: ApplicationScript - - ScriptFullName: str - - StructureSetId: str - - StructureSetUID: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Applicator: - """ - An applicator add-on, either an electron applicator or cone applicator. - - Attributes: - ApplicatorLengthInMM (float): Applicator length in mm. - DiameterInMM (float): Applicator Diameter in mm. - FieldSizeX (float): The field width in direction X (cm). - FieldSizeY (float): The field width in direction Y (cm). - IsStereotactic (bool): Is stereotactic. - ApplicatorLengthInMM (float): Applicator length in mm. - DiameterInMM (float): Applicator Diameter in mm. - FieldSizeX (float): The field width in direction X (cm). - FieldSizeY (float): The field width in direction Y (cm). - IsStereotactic (bool): Is stereotactic. - """ - def __init__(self) -> None: ... - - ApplicatorLengthInMM: float - - DiameterInMM: float - - FieldSizeX: float - - FieldSizeY: float - - IsStereotactic: bool - - ApplicatorLengthInMM: float - - DiameterInMM: float - - FieldSizeX: float - - FieldSizeY: float - - IsStereotactic: bool - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class BeamDose: - """ - Represents a dose that is connected to a Beam. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts a relative beam dose value into absolute units. This method factors in the field weight, dose prescription, prescribed percentage and plan normalization. - def GetAbsoluteBeamDoseValue(self, relative: DoseValue) -> DoseValue: - """ - Args: - relative: The relative dose value from this beam dose matrix to be converted. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts a relative beam dose value into absolute units. This method factors in the field weight, dose prescription, prescribed percentage and plan normalization. - def GetAbsoluteBeamDoseValue(self, relative: DoseValue) -> DoseValue: - """ - Args: - relative: The relative dose value from this beam dose matrix to be converted. - """ - ... - - - -class BeamParameters: - """ - An editable copy of the parameters of a treatment beam. - - Attributes: - ControlPoints (List[ControlPointParameters]): Editable control point parameters copied from the treatment beam. - GantryDirection (GantryDirection): The direction of gantry rotation (clockwise or counterclockwise). - Isocenter (VVector): A copy of the isocenter position, in millimeters. - WeightFactor (float): The weight factor of the beam. - ControlPoints (List[ControlPointParameters]): Editable control point parameters copied from the treatment beam. - GantryDirection (GantryDirection): The direction of gantry rotation (clockwise or counterclockwise). - Isocenter (VVector): A copy of the isocenter position, in millimeters. - WeightFactor (float): The weight factor of the beam. - - Note: - To apply the parameters, call the - """ - def __init__(self) -> None: ... - - ControlPoints: List[ControlPointParameters] - - GantryDirection: GantryDirection - - Isocenter: VVector - - WeightFactor: float - - ControlPoints: List[ControlPointParameters] - - GantryDirection: GantryDirection - - Isocenter: VVector - - WeightFactor: float - - # Assigns the given leaf positions to each of the control point parameters. - def SetAllLeafPositions(self, leafPositions: Array[float]) -> None: - """ - Args: - leafPositions: The positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. - """ - ... - - - # Assigns the given jaw positions to each of the control point parameters. - def SetJawPositions(self, positions: VRect[float]) -> None: - """ - Args: - positions: A rectangle describing the jaw positions in millimeters in IEC BEAM LIMITING DEVICE coordinates. - """ - ... - - - # Assigns the given leaf positions to each of the control point parameters. - def SetAllLeafPositions(self, leafPositions: Array[float]) -> None: - """ - Args: - leafPositions: The positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. - """ - ... - - - # Assigns the given jaw positions to each of the control point parameters. - def SetJawPositions(self, positions: VRect[float]) -> None: - """ - Args: - positions: A rectangle describing the jaw positions in millimeters in IEC BEAM LIMITING DEVICE coordinates. - """ - ... - - - -class BeamUncertainty: - """ - Access to beam uncertainty. - - Attributes: - Beam (Beam): The beam to which this uncertainty is linked. - BeamNumber (BeamNumber): Beam number of the related beam. - Dose (Dose): Dose of this beam uncertainty. - Beam (Beam): The beam to which this uncertainty is linked. - BeamNumber (BeamNumber): Beam number of the related beam. - Dose (Dose): Dose of this beam uncertainty. - """ - def __init__(self) -> None: ... - - Beam: Beam - - BeamNumber: BeamNumber - - Dose: Dose - - Beam: Beam - - BeamNumber: BeamNumber - - Dose: Dose - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class BrachyFieldReferencePoint: - """ - This object links a Brachy field to a reference point. - - Attributes: - FieldDose (DoseValue): The field dose. - IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. - IsPrimaryReferencePoint (bool): Checks if the reference point is primary. - ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. - RefPointLocation (VVector): The location of the reference point. - FieldDose (DoseValue): The field dose. - IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. - IsPrimaryReferencePoint (bool): Checks if the reference point is primary. - ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. - RefPointLocation (VVector): The location of the reference point. - """ - def __init__(self) -> None: ... - - FieldDose: DoseValue - - IsFieldDoseNominal: bool - - IsPrimaryReferencePoint: bool - - ReferencePoint: ReferencePoint - - RefPointLocation: VVector - - FieldDose: DoseValue - - IsFieldDoseNominal: bool - - IsPrimaryReferencePoint: bool - - ReferencePoint: ReferencePoint - - RefPointLocation: VVector - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class BrachyPlanSetup: - """ - Represents a brachytherapy treatment plan. - - Attributes: - ApplicationSetupType (str): The application setup type of this brachytherapy plan. Possible types are: "FLETCHER_SUIT", "DELCLOS", "BLOEDORN", "JOSLIN_FLYNN", "CHANDIGARH", "MANCHESTER", "HENSCHKE", "NASOPHARYNGEAL", "OESOPHAGEAL", "ENDOBRONCHIAL", "SYED_NEBLETT", "ENDORECTAL", "PERINEAL", "HAM_FLAB", "EYE_PLAQUE", and "OTHER". - BrachyTreatmentTechnique (BrachyTreatmentTechniqueType): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". - Catheters (List[Catheter]): The catheters or applicator channel centerlines of this brachytherapy plan, including any catheters associated with - NumberOfPdrPulses (Optional[int]): The number of pulses in a brachytherapy Pulse Dose Rate (PDR) treatment. Null if the plan is not for a PDR treatment. - PdrPulseInterval (Optional[float]): The pulse interval in a brachytherapy Pulse Dose Rate (PDR) treatment in seconds. Null if the plan is not for a PDR treatment. - ReferenceLines (List[Structure]): Collection of reference lines in the plan. - SeedCollections (List[SeedCollection]): The seed collections of this brachytherapy plan. - SolidApplicators (List[BrachySolidApplicator]): The solid applicator parts of this brachytherapy plan. - TreatmentTechnique (str): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". - TreatmentDateTime (Optional[datetime]): The treatment date of this brachytherapy plan. - ApplicationSetupType (str): The application setup type of this brachytherapy plan. Possible types are: "FLETCHER_SUIT", "DELCLOS", "BLOEDORN", "JOSLIN_FLYNN", "CHANDIGARH", "MANCHESTER", "HENSCHKE", "NASOPHARYNGEAL", "OESOPHAGEAL", "ENDOBRONCHIAL", "SYED_NEBLETT", "ENDORECTAL", "PERINEAL", "HAM_FLAB", "EYE_PLAQUE", and "OTHER". - BrachyTreatmentTechnique (BrachyTreatmentTechniqueType): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". - Catheters (List[Catheter]): The catheters or applicator channel centerlines of this brachytherapy plan, including any catheters associated with - NumberOfPdrPulses (Optional[int]): The number of pulses in a brachytherapy Pulse Dose Rate (PDR) treatment. Null if the plan is not for a PDR treatment. - PdrPulseInterval (Optional[float]): The pulse interval in a brachytherapy Pulse Dose Rate (PDR) treatment in seconds. Null if the plan is not for a PDR treatment. - ReferenceLines (List[Structure]): Collection of reference lines in the plan. - SeedCollections (List[SeedCollection]): The seed collections of this brachytherapy plan. - SolidApplicators (List[BrachySolidApplicator]): The solid applicator parts of this brachytherapy plan. - TreatmentTechnique (str): The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT". - TreatmentDateTime (Optional[datetime]): The treatment date of this brachytherapy plan. - """ - def __init__(self) -> None: ... - - ApplicationSetupType: str - - BrachyTreatmentTechnique: BrachyTreatmentTechniqueType - - Catheters: List[Catheter] - - NumberOfPdrPulses: Optional[int] - - PdrPulseInterval: Optional[float] - - ReferenceLines: List[Structure] - - SeedCollections: List[SeedCollection] - - SolidApplicators: List[BrachySolidApplicator] - - TreatmentTechnique: str - - TreatmentDateTime: Optional[datetime] - - ApplicationSetupType: str - - BrachyTreatmentTechnique: BrachyTreatmentTechniqueType - - Catheters: List[Catheter] - - NumberOfPdrPulses: Optional[int] - - PdrPulseInterval: Optional[float] - - ReferenceLines: List[Structure] - - SeedCollections: List[SeedCollection] - - SolidApplicators: List[BrachySolidApplicator] - - TreatmentTechnique: str - - TreatmentDateTime: Optional[datetime] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new brachyterapy applicator to the plan. - def AddCatheter(self, catheterId: str, treatmentUnit: BrachyTreatmentUnit, outputDiagnostics: Text.StringBuilder, appendChannelNumToId: bool, channelNum: int) -> Catheter: - """ - Args: - catheterId: Id of the catheter. - treatmentUnit: The - outputDiagnostics: Additional information about brachytherapy applicator creation. - appendChannelNumToId: If true, channel number will be appended to the given catheterId. - channelNum: Channel number of the catheter. 0 assigns next available free channel number. -1 assigns empty channel number. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add location to reference point. - def AddLocationToExistingReferencePoint(self, location: VVector, referencePoint: ReferencePoint) -> None: - """ - Args: - location: Reference point location in mm. - referencePoint: Reference point. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point without location. Created reference point is linked to the plan. - def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: - """ - Args: - target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). - id: Reference point ID. - """ - ... - - - # Calculates and returns the dose profile. Profile is calculated on the fly with TG-43 formalism. - def CalculateAccurateTG43DoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Changes the brachy treatment unit for all applicators in the brachy plan. - def ChangeTreatmentUnit(self, treatmentUnit: BrachyTreatmentUnit, messages: bool, keepDoseIntact: List[str]) -> ChangeBrachyTreatmentUnitResult: - """ - Args: - treatmentUnit: The - messages: An output parameter that may be populated with 1..n messages of additional information. - keepDoseIntact: If true, the dwell times are scaled to keep the dose intact. If false, dwell times are not scaled, and the dose may be invalidated. - """ - ... - - - # Calculates 3D dose using the TG-43 brachy calculator. - def CalculateTG43Dose(self) -> CalculateBrachy3DDoseResult: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new brachyterapy applicator to the plan. - def AddCatheter(self, catheterId: str, treatmentUnit: BrachyTreatmentUnit, outputDiagnostics: Text.StringBuilder, appendChannelNumToId: bool, channelNum: int) -> Catheter: - """ - Args: - catheterId: Id of the catheter. - treatmentUnit: The - outputDiagnostics: Additional information about brachytherapy applicator creation. - appendChannelNumToId: If true, channel number will be appended to the given catheterId. - channelNum: Channel number of the catheter. 0 assigns next available free channel number. -1 assigns empty channel number. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add location to reference point. - def AddLocationToExistingReferencePoint(self, location: VVector, referencePoint: ReferencePoint) -> None: - """ - Args: - location: Reference point location in mm. - referencePoint: Reference point. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point without location. Created reference point is linked to the plan. - def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: - """ - Args: - target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). - id: Reference point ID. - """ - ... - - - # Calculates and returns the dose profile. Profile is calculated on the fly with TG-43 formalism. - def CalculateAccurateTG43DoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Changes the brachy treatment unit for all applicators in the brachy plan. - def ChangeTreatmentUnit(self, treatmentUnit: BrachyTreatmentUnit, messages: bool, keepDoseIntact: List[str]) -> ChangeBrachyTreatmentUnitResult: - """ - Args: - treatmentUnit: The - messages: An output parameter that may be populated with 1..n messages of additional information. - keepDoseIntact: If true, the dwell times are scaled to keep the dose intact. If false, dwell times are not scaled, and the dose may be invalidated. - """ - ... - - - # Calculates 3D dose using the TG-43 brachy calculator. - def CalculateTG43Dose(self) -> CalculateBrachy3DDoseResult: - ... - - - -class BrachySolidApplicator: - """ - Represents a brachytherapy solid applicator part, such as a tandem or ovoid in a Fletcher Suit Delclos (FSD) applicator set. This class holds only the metadata related to the solid applicator part, and links to the - - Attributes: - ApplicatorSetName (str): The name of the solid applicator set to which this part belongs. - ApplicatorSetType (str): The type of the solid applicator set to which this part belongs. - Category (str): The category of the solid applicator set to which this part belongs. - Catheters (List[Catheter]): The channel(s) of this solid applicator part. - GroupNumber (int): Applicator Group number. - Note (str): A note or short description of the solid applicator part. - PartName (str): The name of the solid applicator part. - PartNumber (str): The part number of the solid applicator. - Summary (str): A summary of the solid applicator set to which this part belongs. - UID (str): The unique identifier of the solid applicator part. - Vendor (str): The vendor of the solid applicator set to which this part belongs. - Version (str): The version of the solid applicator part. - ApplicatorSetName (str): The name of the solid applicator set to which this part belongs. - ApplicatorSetType (str): The type of the solid applicator set to which this part belongs. - Category (str): The category of the solid applicator set to which this part belongs. - Catheters (List[Catheter]): The channel(s) of this solid applicator part. - GroupNumber (int): Applicator Group number. - Note (str): A note or short description of the solid applicator part. - PartName (str): The name of the solid applicator part. - PartNumber (str): The part number of the solid applicator. - Summary (str): A summary of the solid applicator set to which this part belongs. - UID (str): The unique identifier of the solid applicator part. - Vendor (str): The vendor of the solid applicator set to which this part belongs. - Version (str): The version of the solid applicator part. - """ - def __init__(self) -> None: ... - - ApplicatorSetName: str - - ApplicatorSetType: str - - Category: str - - Catheters: List[Catheter] - - GroupNumber: int - - Note: str - - PartName: str - - PartNumber: str - - Summary: str - - UID: str - - Vendor: str - - Version: str - - ApplicatorSetName: str - - ApplicatorSetType: str - - Category: str - - Catheters: List[Catheter] - - GroupNumber: int - - Note: str - - PartName: str - - PartNumber: str - - Summary: str - - UID: str - - Vendor: str - - Version: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class BrachyTreatmentUnit: - """ - Represents a brachytherapy afterloader. - - Attributes: - DoseRateMode (str): The dose rate mode of this treatment unit. Supported modes are "HDR", "PDR", "MDR", and "LDR". - DwellTimeResolution (float): The dwell time resolution supported by this treatment unit in seconds. - MachineInterface (str): The interface type for communicating with this brachytherapy treatment unit. Possible types are "GammaMed12i", "GammaMedPlus", "VariSource", "Other", and "Omnitron" (obsolete type). - MachineModel (str): The model identifier for this treatment unit. Possible models are "VariSource_5", "VariSource_10", "Remote_Afterloading", "Manual_Loading", "GammaMed12i", and "GammaMedPlus". - MaxDwellTimePerChannel (float): The maximum combined dwell time in a single channel in seconds. - MaxDwellTimePerPos (float): The maximum dwell time in a single dwell position in seconds. - MaxDwellTimePerTreatment (float): The maximum combined dwell time in all the channels during a single treatment session. The value is in seconds. - MaximumChannelLength (float): The maximum channel length supported by this treatment unit in millimeters. - MaximumDwellPositionsPerChannel (int): The maximum number of dwell positions per channel supported by this treatment unit. - MaximumStepSize (float): The maximum distance between adjacent source positions in millimeters. - MinAllowedSourcePos (float): The minimum allowed distance (in millimeters) from the tip of the inner lumen of the applicator to the center of the first dwell position. In other words, no source positions should be placed within this distance from the tip of the inner lumen. - MinimumChannelLength (float): The minimum channel length supported by this treatment unit in millimeters. - MinimumStepSize (float): The minimum distance between adjacent source positions in millimeters. - NumberOfChannels (int): The number of channels in this treatment unit. - SourceCenterOffsetFromTip (float): The offset distance (in millimeters) from the tip of the applicator to the center of the source at its first possible dwell position. In other words, the offset accounts for half of the active source length and encapsulation. - SourceMovementType (str): The source movement type as defined in DICOM. Possible types are "STEPWISE", "FIXED", and "OSCILLATING". - StepSizeResolution (float): The default step size resolution for this treatment unit in millimeters. - DoseRateMode (str): The dose rate mode of this treatment unit. Supported modes are "HDR", "PDR", "MDR", and "LDR". - DwellTimeResolution (float): The dwell time resolution supported by this treatment unit in seconds. - MachineInterface (str): The interface type for communicating with this brachytherapy treatment unit. Possible types are "GammaMed12i", "GammaMedPlus", "VariSource", "Other", and "Omnitron" (obsolete type). - MachineModel (str): The model identifier for this treatment unit. Possible models are "VariSource_5", "VariSource_10", "Remote_Afterloading", "Manual_Loading", "GammaMed12i", and "GammaMedPlus". - MaxDwellTimePerChannel (float): The maximum combined dwell time in a single channel in seconds. - MaxDwellTimePerPos (float): The maximum dwell time in a single dwell position in seconds. - MaxDwellTimePerTreatment (float): The maximum combined dwell time in all the channels during a single treatment session. The value is in seconds. - MaximumChannelLength (float): The maximum channel length supported by this treatment unit in millimeters. - MaximumDwellPositionsPerChannel (int): The maximum number of dwell positions per channel supported by this treatment unit. - MaximumStepSize (float): The maximum distance between adjacent source positions in millimeters. - MinAllowedSourcePos (float): The minimum allowed distance (in millimeters) from the tip of the inner lumen of the applicator to the center of the first dwell position. In other words, no source positions should be placed within this distance from the tip of the inner lumen. - MinimumChannelLength (float): The minimum channel length supported by this treatment unit in millimeters. - MinimumStepSize (float): The minimum distance between adjacent source positions in millimeters. - NumberOfChannels (int): The number of channels in this treatment unit. - SourceCenterOffsetFromTip (float): The offset distance (in millimeters) from the tip of the applicator to the center of the source at its first possible dwell position. In other words, the offset accounts for half of the active source length and encapsulation. - SourceMovementType (str): The source movement type as defined in DICOM. Possible types are "STEPWISE", "FIXED", and "OSCILLATING". - StepSizeResolution (float): The default step size resolution for this treatment unit in millimeters. - """ - def __init__(self) -> None: ... - - DoseRateMode: str - - DwellTimeResolution: float - - MachineInterface: str - - MachineModel: str - - MaxDwellTimePerChannel: float - - MaxDwellTimePerPos: float - - MaxDwellTimePerTreatment: float - - MaximumChannelLength: float - - MaximumDwellPositionsPerChannel: int - - MaximumStepSize: float - - MinAllowedSourcePos: float - - MinimumChannelLength: float - - MinimumStepSize: float - - NumberOfChannels: int - - SourceCenterOffsetFromTip: float - - SourceMovementType: str - - StepSizeResolution: float - - DoseRateMode: str - - DwellTimeResolution: float - - MachineInterface: str - - MachineModel: str - - MaxDwellTimePerChannel: float - - MaxDwellTimePerPos: float - - MaxDwellTimePerTreatment: float - - MaximumChannelLength: float - - MaximumDwellPositionsPerChannel: int - - MaximumStepSize: float - - MinAllowedSourcePos: float - - MinimumChannelLength: float - - MinimumStepSize: float - - NumberOfChannels: int - - SourceCenterOffsetFromTip: float - - SourceMovementType: str - - StepSizeResolution: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns the active radioactive source of this treatment unit. - def GetActiveRadioactiveSource(self) -> RadioactiveSource: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns the active radioactive source of this treatment unit. - def GetActiveRadioactiveSource(self) -> RadioactiveSource: - ... - - - -class CalculateBrachy3DDoseResult: - """ - Brachy 3D dose calculation result - - Attributes: - Errors (List[str]): Error messages if "Success" is false. - RoundedDwellTimeAdjustRatio (float): The ratio with which the dwell times were adjusted to meet the resolution of the treatment unit. A value of zero (0.0) means no adjustment to dwell times was made. Value is undefined if "Success" is false - Success (bool): Was the dose calculation successful? - Errors (List[str]): Error messages if "Success" is false. - RoundedDwellTimeAdjustRatio (float): The ratio with which the dwell times were adjusted to meet the resolution of the treatment unit. A value of zero (0.0) means no adjustment to dwell times was made. Value is undefined if "Success" is false - Success (bool): Was the dose calculation successful? - """ - def __init__(self) -> None: ... - - Errors: List[str] - - RoundedDwellTimeAdjustRatio: float - - Success: bool - - Errors: List[str] - - RoundedDwellTimeAdjustRatio: float - - Success: bool - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Calculation: - """ - Contains a calculation specific functions - - Attributes: - AlgorithmsRootPath (str): Algorithms Root Path - AlgorithmsRootPath (str): Algorithms Root Path - """ - # Calculation object constructor - @overload - def __init__(self, dvhEstimationModelLibrary: IDVHEstimationModelLibrary) -> None: - """ - Args: - dvhEstimationModelLibrary: DVH Estimation Model Library - """ - ... - - - # Calculation object constructor - @overload - def __init__(self, dvhEstimationModelLibrary: IDVHEstimationModelLibrary) -> None: - """ - Args: - dvhEstimationModelLibrary: DVH Estimation Model Library - """ - ... - - - AlgorithmsRootPath: str - - AlgorithmsRootPath: str - - # Installed Algorithms - def GetInstalledAlgorithms(self) -> List[Calculation+Algorithm]: - ... - - - # Retrieves calculation models - def GetCalculationModels(self) -> List[Calculation+CalculationModel]: - ... - - - # Retrieves the list of DVH Estimation Model structures - def GetDvhEstimationModelStructures(self, modelId: Guid) -> List[DVHEstimationModelStructure]: - """ - Args: - modelId: Model ID. - """ - ... - - - # List of DVH Estimation Model summaries. - def GetDvhEstimationModelSummaries(self) -> List[DVHEstimationModelSummary]: - ... - - - # Installed Algorithms - def GetInstalledAlgorithms(self) -> List[Calculation+Algorithm]: - ... - - - # Retrieves calculation models - def GetCalculationModels(self) -> List[Calculation+CalculationModel]: - ... - - - # Retrieves the list of DVH Estimation Model structures - def GetDvhEstimationModelStructures(self, modelId: Guid) -> List[DVHEstimationModelStructure]: - """ - Args: - modelId: Model ID. - """ - ... - - - # List of DVH Estimation Model summaries. - def GetDvhEstimationModelSummaries(self) -> List[DVHEstimationModelSummary]: - ... - - - -class Catheter: - """ - Represents a brachytherapy catheter or an applicator channel centerline. Catheters are associated with a - - Attributes: - ApplicatorLength (float): The total length from the tip of the catheter to the treatment unit in millimeters. - BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): A collection of brachy field reference points. - BrachySolidApplicatorPartID (int): The unique identifier of the - ChannelNumber (int): The channel number of this catheter. - Color (Windows.Media.Color): The color of the catheter in 2D views. - DeadSpaceLength (float): The total length from the tip of the catheter to the start of the inner lumen in millimeters. - FirstSourcePosition (float): The first source position in millimeters in this catheter. This is the source position closest to the tip of the catheter. - GroupNumber (int): Catheter Group number. - LastSourcePosition (float): The last source position in millimeters in this catheter. This is the source position furthest away from the tip of the catheter. - Shape (Array[VVector]): The DICOM coordinates of the applicator shape starting from the tip. - SourcePositions (List[SourcePosition]): The source positions in the catheter starting from the tip. - StepSize (float): The step size of the catheter in millimeters. - TreatmentUnit (BrachyTreatmentUnit): The brachytherapy treatment unit associated with this catheter. - ApplicatorLength (float): The total length from the tip of the catheter to the treatment unit in millimeters. - BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): A collection of brachy field reference points. - BrachySolidApplicatorPartID (int): The unique identifier of the - ChannelNumber (int): The channel number of this catheter. - Color (Windows.Media.Color): The color of the catheter in 2D views. - DeadSpaceLength (float): The total length from the tip of the catheter to the start of the inner lumen in millimeters. - FirstSourcePosition (float): The first source position in millimeters in this catheter. This is the source position closest to the tip of the catheter. - GroupNumber (int): Catheter Group number. - LastSourcePosition (float): The last source position in millimeters in this catheter. This is the source position furthest away from the tip of the catheter. - Shape (Array[VVector]): The DICOM coordinates of the applicator shape starting from the tip. - SourcePositions (List[SourcePosition]): The source positions in the catheter starting from the tip. - StepSize (float): The step size of the catheter in millimeters. - TreatmentUnit (BrachyTreatmentUnit): The brachytherapy treatment unit associated with this catheter. - """ - def __init__(self) -> None: ... - - ApplicatorLength: float - - BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] - - BrachySolidApplicatorPartID: int - - ChannelNumber: int - - Color: Windows.Media.Color - - DeadSpaceLength: float - - FirstSourcePosition: float - - GroupNumber: int - - LastSourcePosition: float - - Shape: Array[VVector] - - SourcePositions: List[SourcePosition] - - StepSize: float - - TreatmentUnit: BrachyTreatmentUnit - - ApplicatorLength: float - - BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] - - BrachySolidApplicatorPartID: int - - ChannelNumber: int - - Color: Windows.Media.Color - - DeadSpaceLength: float - - FirstSourcePosition: float - - GroupNumber: int - - LastSourcePosition: float - - Shape: Array[VVector] - - SourcePositions: List[SourcePosition] - - StepSize: float - - TreatmentUnit: BrachyTreatmentUnit - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # The distance (in millimeters) from the tip of the catheter (in the first possible source position) to the center of the source position. This is an offset from the actual catheter inner lumen tip by half of the source length and encapsulation. - def GetSourcePosCenterDistanceFromTip(self, sourcePosition: SourcePosition) -> float: - """ - Args: - sourcePosition: The source position for which the distance from the catheter tip is got. - """ - ... - - - # The total dwell time in this catheter in seconds. - def GetTotalDwellTime(self) -> float: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Link reference line to applicator. - def LinkRefLine(self, refLine: Structure) -> None: - """ - Args: - refLine: Reference line to link with applicator. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Link reference point to applicator. - def LinkRefPoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to link with applicator. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the ID of the applicator. - def SetId(self, id: str, message: str) -> bool: - """ - Args: - id: The new ID for the applicator. - message: May be populated with a reason why setting the ID failed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the step size, first source position, and last source position, and resets the source positions of the catheter. - def SetSourcePositions(self, stepSize: float, firstSourcePosition: float, lastSourcePosition: float) -> SetSourcePositionsResult: - """ - Args: - stepSize: Step size in millimeters. - firstSourcePosition: First source position in millimeters. - lastSourcePosition: Last source position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference line from applicator. - def UnlinkRefLine(self, refLine: Structure) -> None: - """ - Args: - refLine: Reference line to unlink from applicator - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference point from applicator. - def UnlinkRefPoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to unlink from applicator - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # The distance (in millimeters) from the tip of the catheter (in the first possible source position) to the center of the source position. This is an offset from the actual catheter inner lumen tip by half of the source length and encapsulation. - def GetSourcePosCenterDistanceFromTip(self, sourcePosition: SourcePosition) -> float: - """ - Args: - sourcePosition: The source position for which the distance from the catheter tip is got. - """ - ... - - - # The total dwell time in this catheter in seconds. - def GetTotalDwellTime(self) -> float: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Link reference line to applicator. - def LinkRefLine(self, refLine: Structure) -> None: - """ - Args: - refLine: Reference line to link with applicator. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Link reference point to applicator. - def LinkRefPoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to link with applicator. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the ID of the applicator. - def SetId(self, id: str, message: str) -> bool: - """ - Args: - id: The new ID for the applicator. - message: May be populated with a reason why setting the ID failed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the step size, first source position, and last source position, and resets the source positions of the catheter. - def SetSourcePositions(self, stepSize: float, firstSourcePosition: float, lastSourcePosition: float) -> SetSourcePositionsResult: - """ - Args: - stepSize: Step size in millimeters. - firstSourcePosition: First source position in millimeters. - lastSourcePosition: Last source position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference line from applicator. - def UnlinkRefLine(self, refLine: Structure) -> None: - """ - Args: - refLine: Reference line to unlink from applicator - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Unlink reference point from applicator. - def UnlinkRefPoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to unlink from applicator - """ - ... - - - -class ControlPointParameters: - """ - An editable copy of the parameters of a control point. - - Attributes: - CollimatorAngle (float): A copy of the collimator angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. - JawPositions (VRect[float]): A copy of the jaw positions of the treatment beams at this control point in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - LeafPositions (Array[float]): A copy of the positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If no MLC exists, a (0,0)-length array is returned. - PatientSupportAngle (float): A copy of the patient support angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. - GantryAngle (float): A copy of the gantry angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - MetersetWeight (float): A copy of the cumulative meterset weight to this control point. - CollimatorAngle (float): A copy of the collimator angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. - JawPositions (VRect[float]): A copy of the jaw positions of the treatment beams at this control point in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - LeafPositions (Array[float]): A copy of the positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If no MLC exists, a (0,0)-length array is returned. - PatientSupportAngle (float): A copy of the patient support angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. - GantryAngle (float): A copy of the gantry angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - MetersetWeight (float): A copy of the cumulative meterset weight to this control point. - - Note: - To apply the parameters, call the ApplyParameters method of the Beam class. Because the parameters are simple copies, they do not reflect the current state of the data model. - """ - def __init__(self) -> None: ... - - CollimatorAngle: float - - Index: int - - JawPositions: VRect[float] - - LeafPositions: Array[float] - - PatientSupportAngle: float - - TableTopLateralPosition: float - - TableTopLongitudinalPosition: float - - TableTopVerticalPosition: float - - GantryAngle: float - - MetersetWeight: float - - CollimatorAngle: float - - Index: int - - JawPositions: VRect[float] - - LeafPositions: Array[float] - - PatientSupportAngle: float - - TableTopLateralPosition: float - - TableTopLongitudinalPosition: float - - TableTopVerticalPosition: float - - GantryAngle: float - - MetersetWeight: float - - -class AsyncPump: - """ - Provides a pump that supports running asynchronous methods on the current thread. - """ - def __init__(self) -> None: ... - - # Helper for executing an async (Task-returning) function on a single thread. This can be used in cases where calling Wait() or Result on the Task would cause a deadlock, i.e., when the async part of the Task-returning function cannot be executed purely on a background thread. Exceptions thrown by the async function are re-thrown. If the exception is an - def RunAsyncOnCurrentThread(self, asynchronousFunction: Func[Task[T]]) -> Any: - """ - Args: - asynchronousFunction: The async function to be executed - """ - ... - - - # Helper for executing an async (Task-returning) function on a single thread. This can be used in cases where calling Wait() or Result on the Task would cause a deadlock, i.e., when the async part of the Task-returning function cannot be executed purely on a background thread. Exceptions thrown by the async function are re-thrown. If the exception is an - def RunAsyncOnCurrentThread(self, asynchronousFunction: Func[Task[T]]) -> Any: - """ - Args: - asynchronousFunction: The async function to be executed - """ - ... - - - -class Beam: - """ - Represents one beam (also referred to as "field") of an external beam treatment plan. See the definition of DICOM RT Beam for more details. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Beam. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Beam. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] The Beam comment. - Meterset (MetersetValue): The meterset value of the beam. - BeamNumber (int): DICOM RT Beam Number. The value is unique within the plan in which it is created. - Applicator (Applicator): An applicator is a specific add-on used in the beam. - ArcLength (float): The arc length. - AreControlPointJawsMoving (bool): Checks if jaws are moving. - AverageSSD (float): The average Source-to-Skin Distance (SSD) of an arc beam. - BeamTechnique (BeamTechnique): Returns an enumeration that describes the type of the treatment field. - Blocks (List[Block]): A collection of installed blocks. - Boluses (List[Bolus]): A collection of beam boluses. - CalculationLogs (List[BeamCalculationLog]): A collection of beam calculation logs. - CollimatorRotation (float): Collimator rotation - Compensator (Compensator): The compensator. - ControlPoints (ControlPointCollection): An enumerable sequence of machine parameters that describe the planned treatment beam. - CreationDateTime (Optional[datetime]): The date when this object was created. - Dose (BeamDose): The dose for the beam. Returns null if the dose is not calculated. - DoseRate (int): The dose rate of the treatment machine in MU/min. - DosimetricLeafGap (float): The dosimetric leaf gap that has been configured for the Dynamic Multileaf Collimator (DMLC) beams in the system. The dosimetric leaf gap is used for accounting for dose transmission through rounded MLC leaves. - EnergyMode (EnergyMode): Energy mode of the treatment machine. - EnergyModeDisplayName (str): The display name of the energy mode. For example '18E' or '6X-SRS'. - FieldReferencePoints (List[FieldReferencePoint]): A collection of field reference points. - GantryDirection (GantryDirection): The gantry rotation direction: clockwise (CW), counterclockwise (CCW), or none. - HasAllMLCLeavesClosed (bool): Returns true if all MLC leaves are closed. - IsGantryExtended (bool): Checks if the gantry rotation is extended. For arc beams, checks if the gantry rotation is extended at the start angle. - IsGantryExtendedAtStopAngle (bool): Checks if the gantry rotation is extended at the stop angle of an arc beam. - IsImagingTreatmentField (bool): Checks if a beam is an Imaging Treatment Beam, i.e., a beam that is used to take an MV image and whose dose is calculated and taken into account in treatment planning. - IsIMRT (bool): Checks if a beam is IMRT. - IsocenterPosition (VVector): The position of the isocenter. - IsSetupField (bool): Checks if a beam is a setup field. - MetersetPerGy (float): The calculated meterset/Gy value for the beam. - MLC (MLC): Returns a hardware description of the Multileaf Collimator (MLC) used in an MLC plan, or null if no MLC exists. - MLCPlanType (MLCPlanType): The type of the Multileaf Collimator (MLC) plan. - MLCTransmissionFactor (float): The transmission factor of the Multileaf Collimator (MLC) material. - MotionCompensationTechnique (str): DICOM (respiratory) motion compensation technique. Returns an empty string if motion compensation technique is not used. - MotionSignalSource (str): DICOM (respiratory) signal source. Returns an empty string if motion compensation technique is not used. - NormalizationFactor (float): The beam normalization factor. - NormalizationMethod (str): The beam normalization method. - Plan (PlanSetup): Used for navigating to parent Plan - PlannedSSD (float): The Source-to-Skin Distance (SSD) value defined by the user. - ReferenceImage (Image): The reference image of the beam. - SetupNote (str): The setup note of the field. - SetupTechnique (SetupTechnique): The setup technique. - SSD (float): The Source-to-Skin Distance (SSD). For arc beams, the SSD at the start angle. This value is calculated from the geometrical setup of the beam. - SSDAtStopAngle (float): The Source-to-Skin Distance (SSD) at the stop angle of an arc beam. This value is calculated from the geometrical setup of the beam. - Technique (Technique): The technique used in the planning beam. - ToleranceTableLabel (str): User-defined label for the referenced tolerance table, or an empty string if there is no reference to a tolerance table. - Trays (List[Tray]): A collection of installed trays. - TreatmentTime (float): The treatment time set for the beam in seconds. Plan Approval wizard sets this value by default. - TreatmentUnit (ExternalBeamTreatmentUnit): The external beam treatment unit associated with this beam. - Wedges (List[Wedge]): A collection of installed wedges. - WeightFactor (float): The weight factor of the beam. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Beam. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Beam. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] The Beam comment. - Meterset (MetersetValue): The meterset value of the beam. - BeamNumber (int): DICOM RT Beam Number. The value is unique within the plan in which it is created. - Applicator (Applicator): An applicator is a specific add-on used in the beam. - ArcLength (float): The arc length. - AreControlPointJawsMoving (bool): Checks if jaws are moving. - AverageSSD (float): The average Source-to-Skin Distance (SSD) of an arc beam. - BeamTechnique (BeamTechnique): Returns an enumeration that describes the type of the treatment field. - Blocks (List[Block]): A collection of installed blocks. - Boluses (List[Bolus]): A collection of beam boluses. - CalculationLogs (List[BeamCalculationLog]): A collection of beam calculation logs. - CollimatorRotation (float): Collimator rotation - Compensator (Compensator): The compensator. - ControlPoints (ControlPointCollection): An enumerable sequence of machine parameters that describe the planned treatment beam. - CreationDateTime (Optional[datetime]): The date when this object was created. - Dose (BeamDose): The dose for the beam. Returns null if the dose is not calculated. - DoseRate (int): The dose rate of the treatment machine in MU/min. - DosimetricLeafGap (float): The dosimetric leaf gap that has been configured for the Dynamic Multileaf Collimator (DMLC) beams in the system. The dosimetric leaf gap is used for accounting for dose transmission through rounded MLC leaves. - EnergyMode (EnergyMode): Energy mode of the treatment machine. - EnergyModeDisplayName (str): The display name of the energy mode. For example '18E' or '6X-SRS'. - FieldReferencePoints (List[FieldReferencePoint]): A collection of field reference points. - GantryDirection (GantryDirection): The gantry rotation direction: clockwise (CW), counterclockwise (CCW), or none. - HasAllMLCLeavesClosed (bool): Returns true if all MLC leaves are closed. - IsGantryExtended (bool): Checks if the gantry rotation is extended. For arc beams, checks if the gantry rotation is extended at the start angle. - IsGantryExtendedAtStopAngle (bool): Checks if the gantry rotation is extended at the stop angle of an arc beam. - IsImagingTreatmentField (bool): Checks if a beam is an Imaging Treatment Beam, i.e., a beam that is used to take an MV image and whose dose is calculated and taken into account in treatment planning. - IsIMRT (bool): Checks if a beam is IMRT. - IsocenterPosition (VVector): The position of the isocenter. - IsSetupField (bool): Checks if a beam is a setup field. - MetersetPerGy (float): The calculated meterset/Gy value for the beam. - MLC (MLC): Returns a hardware description of the Multileaf Collimator (MLC) used in an MLC plan, or null if no MLC exists. - MLCPlanType (MLCPlanType): The type of the Multileaf Collimator (MLC) plan. - MLCTransmissionFactor (float): The transmission factor of the Multileaf Collimator (MLC) material. - MotionCompensationTechnique (str): DICOM (respiratory) motion compensation technique. Returns an empty string if motion compensation technique is not used. - MotionSignalSource (str): DICOM (respiratory) signal source. Returns an empty string if motion compensation technique is not used. - NormalizationFactor (float): The beam normalization factor. - NormalizationMethod (str): The beam normalization method. - Plan (PlanSetup): Used for navigating to parent Plan - PlannedSSD (float): The Source-to-Skin Distance (SSD) value defined by the user. - ReferenceImage (Image): The reference image of the beam. - SetupNote (str): The setup note of the field. - SetupTechnique (SetupTechnique): The setup technique. - SSD (float): The Source-to-Skin Distance (SSD). For arc beams, the SSD at the start angle. This value is calculated from the geometrical setup of the beam. - SSDAtStopAngle (float): The Source-to-Skin Distance (SSD) at the stop angle of an arc beam. This value is calculated from the geometrical setup of the beam. - Technique (Technique): The technique used in the planning beam. - ToleranceTableLabel (str): User-defined label for the referenced tolerance table, or an empty string if there is no reference to a tolerance table. - Trays (List[Tray]): A collection of installed trays. - TreatmentTime (float): The treatment time set for the beam in seconds. Plan Approval wizard sets this value by default. - TreatmentUnit (ExternalBeamTreatmentUnit): The external beam treatment unit associated with this beam. - Wedges (List[Wedge]): A collection of installed wedges. - WeightFactor (float): The weight factor of the beam. - """ - def __init__(self) -> None: ... - - Id: str - - Name: str - - Comment: str - - Meterset: MetersetValue - - BeamNumber: int - - Applicator: Applicator - - ArcLength: float - - AreControlPointJawsMoving: bool - - AverageSSD: float - - BeamTechnique: BeamTechnique - - Blocks: List[Block] - - Boluses: List[Bolus] - - CalculationLogs: List[BeamCalculationLog] - - CollimatorRotation: float - - Compensator: Compensator - - ControlPoints: ControlPointCollection - - CreationDateTime: Optional[datetime] - - Dose: BeamDose - - DoseRate: int - - DosimetricLeafGap: float - - EnergyMode: EnergyMode - - EnergyModeDisplayName: str - - FieldReferencePoints: List[FieldReferencePoint] - - GantryDirection: GantryDirection - - HasAllMLCLeavesClosed: bool - - IsGantryExtended: bool - - IsGantryExtendedAtStopAngle: bool - - IsImagingTreatmentField: bool - - IsIMRT: bool - - IsocenterPosition: VVector - - IsSetupField: bool - - MetersetPerGy: float - - MLC: MLC - - MLCPlanType: MLCPlanType - - MLCTransmissionFactor: float - - MotionCompensationTechnique: str - - MotionSignalSource: str - - NormalizationFactor: float - - NormalizationMethod: str - - Plan: PlanSetup - - PlannedSSD: float - - ReferenceImage: Image - - SetupNote: str - - SetupTechnique: SetupTechnique - - SSD: float - - SSDAtStopAngle: float - - Technique: Technique - - ToleranceTableLabel: str - - Trays: List[Tray] - - TreatmentTime: float - - TreatmentUnit: ExternalBeamTreatmentUnit - - Wedges: List[Wedge] - - WeightFactor: float - - Id: str - - Name: str - - Comment: str - - Meterset: MetersetValue - - BeamNumber: int - - Applicator: Applicator - - ArcLength: float - - AreControlPointJawsMoving: bool - - AverageSSD: float - - BeamTechnique: BeamTechnique - - Blocks: List[Block] - - Boluses: List[Bolus] - - CalculationLogs: List[BeamCalculationLog] - - CollimatorRotation: float - - Compensator: Compensator - - ControlPoints: ControlPointCollection - - CreationDateTime: Optional[datetime] - - Dose: BeamDose - - DoseRate: int - - DosimetricLeafGap: float - - EnergyMode: EnergyMode - - EnergyModeDisplayName: str - - FieldReferencePoints: List[FieldReferencePoint] - - GantryDirection: GantryDirection - - HasAllMLCLeavesClosed: bool - - IsGantryExtended: bool - - IsGantryExtendedAtStopAngle: bool - - IsImagingTreatmentField: bool - - IsIMRT: bool - - IsocenterPosition: VVector - - IsSetupField: bool - - MetersetPerGy: float - - MLC: MLC - - MLCPlanType: MLCPlanType - - MLCTransmissionFactor: float - - MotionCompensationTechnique: str - - MotionSignalSource: str - - NormalizationFactor: float - - NormalizationMethod: str - - Plan: PlanSetup - - PlannedSSD: float - - ReferenceImage: Image - - SetupNote: str - - SetupTechnique: SetupTechnique - - SSD: float - - SSDAtStopAngle: float - - Technique: Technique - - ToleranceTableLabel: str - - Trays: List[Tray] - - TreatmentTime: float - - TreatmentUnit: ExternalBeamTreatmentUnit - - Wedges: List[Wedge] - - WeightFactor: float - - # [Availability of this property depends on your Eclipse Scripting API license] Adds a link to bolus. - def AddBolus(self, bolus: Bolus) -> None: - """ - Args: - bolus: The bolus to add. - """ - ... - - - # [Availability of this property depends on your Eclipse Scripting API license] Removes the link to bolus. - def RemoveBolus(self, bolus: Bolus) -> bool: - """ - Args: - bolus: The bolus to remove from the beam. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a link to bolus. - def AddBolus(self, bolusId: str) -> None: - """ - Args: - bolusId: The ID of the bolus to add. The bolus structure must exist in the plan's structure set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a flattening sequence to a static Halcyon field. Throws an exception if the field is not a Halcyon field. - def AddFlatteningSequence(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Modifies the beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. - def ApplyParameters(self, beamParams: BeamParameters) -> None: - """ - Args: - beamParams: The parameters to apply to the beam. - """ - ... - - - # Calculate and get Average Leaf Pair Opening values. ALPO values are calculated on the fly (not serialized). Returns a Dictionary. Key element is the index of carriage group in the field and value element is the ALPO value for that carriage group. - def CalculateAverageLeafPairOpenings(self) -> Dict[int, float]: - ... - - - # Checks if optimal fluence can be set for this beam. - def CanSetOptimalFluence(self, fluence: Fluence, message: str) -> bool: - """ - Args: - fluence: The optimal fluence for the beam. - message: If the optimal fluence cannot be set, contains information about the reason. - """ - ... - - - # Converts the given collimator angle value from the internal IEC scale to the user facing scale of the machine. - def CollimatorAngleToUser(self, val: float) -> float: - """ - Args: - val: Collimator angle value - """ - ... - - - # Counts and returns Subfield count. - def CountSubfields(self) -> int: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the DRR. - def CreateOrReplaceDRR(self, parameters: DRRCalculationParameters) -> Image: - """ - Args: - parameters: DRR calculation parameters - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the collimator to the specified structure - def FitCollimatorToStructure(self, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) -> None: - """ - Args: - margins: Margins used to fit to structure - structure: Structure to fit to - useAsymmetricXJaws: Flag of using asymmetric x jaws - useAsymmetricYJaws: Flag of uisng asymmetric y jaws - optimizeCollimatorRotation: Flag of optimizing collimator angles as fitting result - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with default settings, or with settings from previous fit. - def FitMLCToOutline(self, outline: Array[Array[Windows.Point]]) -> None: - """ - Args: - outline: The shape to fit the MLC leaves to, for example, Block.Outline. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with specified options. - def FitMLCToOutline(self, outline: Array[Array[Windows.Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: - """ - Args: - outline: The shape to fit the MLC leaves to, for example, Block.Outline. - optimizeCollimatorRotation: Specifies if the MLC rotation is optimized. - jawFit: Controls whether the collimator jaws are positioned to match the MLC outline and how it is done. - olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). - clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves in the beam to a structure with the default settings, or with settings from the previous fit. The margin is zero. - def FitMLCToStructure(self, structure: Structure) -> None: - """ - Args: - structure: The structure to fit the MLC leaves to. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a structure projection on the isocenter plane with the specified margin. - def FitMLCToStructure(self, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: - """ - Args: - margins: Specifies the margin in all directions. - structure: The structure to fit the MLC leaves to. - optimizeCollimatorRotation: Specify if the MLC rotation is optimized. - jawFit: Controls whether and how the collimator jaws are positioned to match the MLC outline. - olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). - clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). - """ - ... - - - # Converts the given gantry rotation value from the internal IEC scale to the user facing scale of the machine. - def GantryAngleToUser(self, val: float) -> float: - """ - Args: - val: Gantry rotation value - """ - ... - - - # CAX path length in bolus is calculated along the vector spanning from radiation source to first skin contact (as defined by SSD). - def GetCAXPathLengthInBolus(self, bolus: Bolus) -> float: - ... - - - # Returns an editable copy of the beam parameters. The returned BeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another BeamParameters object. - def GetEditableParameters(self) -> BeamParameters: - ... - - - # Gets the optimal fluence for this beam. Returns null if optimal fluence does not exist. - def GetOptimalFluence(self) -> Fluence: - ... - - - # Returns the location of the radiation source at a given gantry angle of the beam. - def GetSourceLocation(self, gantryAngle: float) -> VVector: - """ - Args: - gantryAngle: Gantry angle - """ - ... - - - # Calculates Source To Bolus distance in mm. - def GetSourceToBolusDistance(self, bolus: Bolus) -> float: - ... - - - # If the structure has a segment, gets the outline of the structure on the isocenter plane of the beam. - def GetStructureOutlines(self, structure: Structure, inBEV: bool) -> Array[Array[Windows.Point]]: - """ - Args: - structure: The structure to be projected to the isocenter plane. - inBEV: If true, outlines are returned in the Beams Eye View (BEV) coordinates, where the collimator angle is 0.0 degrees. If false, outlines are returned in beam coordinates. Suitable for use with FitMLCToOutline(...). - """ - ... - - - # Converts the given jaw positions from the internal IEC scale to a string in the user facing scale of the machine. - def JawPositionsToUserString(self, val: VRect[float]) -> str: - """ - Args: - val: Jaw postitions - """ - ... - - - # Converts the given patient support angle value from the internal IEC scale to the user facing scale of the machine. - def PatientSupportAngleToUser(self, val: float) -> float: - """ - Args: - val: Patient support angle value - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the link to bolus. - def RemoveBolus(self, bolusId: str) -> bool: - """ - Args: - bolusId: The ID of the bolus to remove from the beam. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the flattening sequence from a Halcyon field. Throws an exception if the field is not a Halcyon field. - def RemoveFlatteningSequence(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the optimal fluence for this beam. If the fluence is empty (the fluence is null or the dimensions of the fluence matrix are zero) an ArgumentException will be thrown. Setting the optimal fluence for the beam does not clear DVH Estimations of the plan. - def SetOptimalFluence(self, fluence: Fluence) -> None: - """ - Args: - fluence: The optimal fluence to be set. - """ - ... - - - # [Availability of this property depends on your Eclipse Scripting API license] Adds a link to bolus. - def AddBolus(self, bolus: Bolus) -> None: - """ - Args: - bolus: The bolus to add. - """ - ... - - - # [Availability of this property depends on your Eclipse Scripting API license] Removes the link to bolus. - def RemoveBolus(self, bolus: Bolus) -> bool: - """ - Args: - bolus: The bolus to remove from the beam. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a link to bolus. - def AddBolus(self, bolusId: str) -> None: - """ - Args: - bolusId: The ID of the bolus to add. The bolus structure must exist in the plan's structure set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a flattening sequence to a static Halcyon field. Throws an exception if the field is not a Halcyon field. - def AddFlatteningSequence(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Modifies the beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. - def ApplyParameters(self, beamParams: BeamParameters) -> None: - """ - Args: - beamParams: The parameters to apply to the beam. - """ - ... - - - # Calculate and get Average Leaf Pair Opening values. ALPO values are calculated on the fly (not serialized). Returns a Dictionary. Key element is the index of carriage group in the field and value element is the ALPO value for that carriage group. - def CalculateAverageLeafPairOpenings(self) -> Dict[int, float]: - ... - - - # Checks if optimal fluence can be set for this beam. - def CanSetOptimalFluence(self, fluence: Fluence, message: str) -> bool: - """ - Args: - fluence: The optimal fluence for the beam. - message: If the optimal fluence cannot be set, contains information about the reason. - """ - ... - - - # Converts the given collimator angle value from the internal IEC scale to the user facing scale of the machine. - def CollimatorAngleToUser(self, val: float) -> float: - """ - Args: - val: Collimator angle value - """ - ... - - - # Counts and returns Subfield count. - def CountSubfields(self) -> int: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the DRR. - def CreateOrReplaceDRR(self, parameters: DRRCalculationParameters) -> Image: - """ - Args: - parameters: DRR calculation parameters - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the collimator to the specified structure - def FitCollimatorToStructure(self, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) -> None: - """ - Args: - margins: Margins used to fit to structure - structure: Structure to fit to - useAsymmetricXJaws: Flag of using asymmetric x jaws - useAsymmetricYJaws: Flag of uisng asymmetric y jaws - optimizeCollimatorRotation: Flag of optimizing collimator angles as fitting result - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with default settings, or with settings from previous fit. - def FitMLCToOutline(self, outline: Array[Array[Windows.Point]]) -> None: - """ - Args: - outline: The shape to fit the MLC leaves to, for example, Block.Outline. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a shape on the isocenter plane with specified options. - def FitMLCToOutline(self, outline: Array[Array[Windows.Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: - """ - Args: - outline: The shape to fit the MLC leaves to, for example, Block.Outline. - optimizeCollimatorRotation: Specifies if the MLC rotation is optimized. - jawFit: Controls whether the collimator jaws are positioned to match the MLC outline and how it is done. - olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). - clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves in the beam to a structure with the default settings, or with settings from the previous fit. The margin is zero. - def FitMLCToStructure(self, structure: Structure) -> None: - """ - Args: - structure: The structure to fit the MLC leaves to. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Fits the MLC leaves to a structure projection on the isocenter plane with the specified margin. - def FitMLCToStructure(self, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: - """ - Args: - margins: Specifies the margin in all directions. - structure: The structure to fit the MLC leaves to. - optimizeCollimatorRotation: Specify if the MLC rotation is optimized. - jawFit: Controls whether and how the collimator jaws are positioned to match the MLC outline. - olmp: Specifies the meeting point for MLC leaves and the structure outline (Inside/Middle/Outside). - clmp: Specifies the placement of closed leaf pairs (Bank One/Center/Bank Two). - """ - ... - - - # Converts the given gantry rotation value from the internal IEC scale to the user facing scale of the machine. - def GantryAngleToUser(self, val: float) -> float: - """ - Args: - val: Gantry rotation value - """ - ... - - - # CAX path length in bolus is calculated along the vector spanning from radiation source to first skin contact (as defined by SSD). - def GetCAXPathLengthInBolus(self, bolus: Bolus) -> float: - ... - - - # Returns an editable copy of the beam parameters. The returned BeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another BeamParameters object. - def GetEditableParameters(self) -> BeamParameters: - ... - - - # Gets the optimal fluence for this beam. Returns null if optimal fluence does not exist. - def GetOptimalFluence(self) -> Fluence: - ... - - - # Returns the location of the radiation source at a given gantry angle of the beam. - def GetSourceLocation(self, gantryAngle: float) -> VVector: - """ - Args: - gantryAngle: Gantry angle - """ - ... - - - # Calculates Source To Bolus distance in mm. - def GetSourceToBolusDistance(self, bolus: Bolus) -> float: - ... - - - # If the structure has a segment, gets the outline of the structure on the isocenter plane of the beam. - def GetStructureOutlines(self, structure: Structure, inBEV: bool) -> Array[Array[Windows.Point]]: - """ - Args: - structure: The structure to be projected to the isocenter plane. - inBEV: If true, outlines are returned in the Beams Eye View (BEV) coordinates, where the collimator angle is 0.0 degrees. If false, outlines are returned in beam coordinates. Suitable for use with FitMLCToOutline(...). - """ - ... - - - # Converts the given jaw positions from the internal IEC scale to a string in the user facing scale of the machine. - def JawPositionsToUserString(self, val: VRect[float]) -> str: - """ - Args: - val: Jaw postitions - """ - ... - - - # Converts the given patient support angle value from the internal IEC scale to the user facing scale of the machine. - def PatientSupportAngleToUser(self, val: float) -> float: - """ - Args: - val: Patient support angle value - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the link to bolus. - def RemoveBolus(self, bolusId: str) -> bool: - """ - Args: - bolusId: The ID of the bolus to remove from the beam. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the flattening sequence from a Halcyon field. Throws an exception if the field is not a Halcyon field. - def RemoveFlatteningSequence(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the optimal fluence for this beam. If the fluence is empty (the fluence is null or the dimensions of the fluence matrix are zero) an ArgumentException will be thrown. Setting the optimal fluence for the beam does not clear DVH Estimations of the plan. - def SetOptimalFluence(self, fluence: Fluence) -> None: - """ - Args: - fluence: The optimal fluence to be set. - """ - ... - - - -class Course: - """ - A course represents the course of treatment that a patient will be given. Every patient must have a course, and all plans always belong to a course. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Course. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Course. - ExternalPlanSetups (List[ExternalPlanSetup]): A collection of external beam plans for the course. - BrachyPlanSetups (List[BrachyPlanSetup]): A collection of brachytherapy plans for the course. - IonPlanSetups (List[IonPlanSetup]): A collection of proton plans for the course. - ClinicalStatus (CourseClinicalStatus): Clinical Status of Course. - CompletedDateTime (Optional[datetime]): The date and time when the course was completed. - Diagnoses (List[Diagnosis]): The diagnoses that are attached to the course. - Intent (str): The intent of the course. - Patient (Patient): Patient in which the course is defined. - PlanSetups (List[PlanSetup]): A collection of plans for the course. The plans can be of any type (external beam or brachytherapy). - PlanSums (List[PlanSum]): A collection of plan sums for the course. - StartDateTime (Optional[datetime]): The date and time when the course was started. - TreatmentPhases (List[TreatmentPhase]): All treatment phases in the course. - TreatmentSessions (List[TreatmentSession]): Treatment sessions of the course. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Course. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Course. - ExternalPlanSetups (List[ExternalPlanSetup]): A collection of external beam plans for the course. - BrachyPlanSetups (List[BrachyPlanSetup]): A collection of brachytherapy plans for the course. - IonPlanSetups (List[IonPlanSetup]): A collection of proton plans for the course. - ClinicalStatus (CourseClinicalStatus): Clinical Status of Course. - CompletedDateTime (Optional[datetime]): The date and time when the course was completed. - Diagnoses (List[Diagnosis]): The diagnoses that are attached to the course. - Intent (str): The intent of the course. - Patient (Patient): Patient in which the course is defined. - PlanSetups (List[PlanSetup]): A collection of plans for the course. The plans can be of any type (external beam or brachytherapy). - PlanSums (List[PlanSum]): A collection of plan sums for the course. - StartDateTime (Optional[datetime]): The date and time when the course was started. - TreatmentPhases (List[TreatmentPhase]): All treatment phases in the course. - TreatmentSessions (List[TreatmentSession]): Treatment sessions of the course. - """ - def __init__(self) -> None: ... - - Id: str - - Comment: str - - ExternalPlanSetups: List[ExternalPlanSetup] - - BrachyPlanSetups: List[BrachyPlanSetup] - - IonPlanSetups: List[IonPlanSetup] - - ClinicalStatus: CourseClinicalStatus - - CompletedDateTime: Optional[datetime] - - Diagnoses: List[Diagnosis] - - Intent: str - - Patient: Patient - - PlanSetups: List[PlanSetup] - - PlanSums: List[PlanSum] - - StartDateTime: Optional[datetime] - - TreatmentPhases: List[TreatmentPhase] - - TreatmentSessions: List[TreatmentSession] - - Id: str - - Comment: str - - ExternalPlanSetups: List[ExternalPlanSetup] - - BrachyPlanSetups: List[BrachyPlanSetup] - - IonPlanSetups: List[IonPlanSetup] - - ClinicalStatus: CourseClinicalStatus - - CompletedDateTime: Optional[datetime] - - Diagnoses: List[Diagnosis] - - Intent: str - - Patient: Patient - - PlanSetups: List[PlanSetup] - - PlanSums: List[PlanSum] - - StartDateTime: Optional[datetime] - - TreatmentPhases: List[TreatmentPhase] - - TreatmentSessions: List[TreatmentSession] - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan sum from given planning items. - def CreatePlanSum(self, planningItems: List[PlanningItem], image: Image) -> PlanSum: - """ - Args: - planningItems: Items to create sum from. All plans must share the same image, otherwise please use - image: Plan Sum image - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course with target, primary reference point and additional reference points in arguments - def AddExternalPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: List[ReferencePoint]) -> ExternalPlanSetup: - """ - Args: - structureSet: Valid StructureSet to connected with the plan - targetStructure: Target structure, if defined must be from 'structureSet', if left null target will remain unset. - primaryReferencePoint: Valid reference point to be connected as primary. - additionalReferencePoints: Collection of additional valid reference points - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course with the target structure, primary reference point and additional reference points specified in arguments. - def AddBrachyPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: DoseValue, dosePerFraction: BrachyTreatmentTechniqueType, brachyTreatmentTechnique: List[ReferencePoint]) -> BrachyPlanSetup: - """ - Args: - structureSet: Valid StructureSet to be connected to the plan - targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. - primaryReferencePoint: Valid reference point to be connected as primary reference point. - additionalReferencePoints: Collection of additional valid reference points - dosePerFraction: Dose per fraction - brachyTreatmentTechnique: Brachytherapy treatment technique - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. - def AddIonPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, patientSupportDeviceId: ReferencePoint, primaryReferencePoint: str, additionalReferencePoints: List[ReferencePoint]) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. - patientSupportDeviceId: Id of the patient support device. - primaryReferencePoint: Valid reference point to be connected as primary. - additionalReferencePoints: Collection of additional valid reference points - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course. A new primary reference point is always created for the new brachytherapy plan. - def AddBrachyPlanSetup(self, structureSet: StructureSet, dosePerFraction: DoseValue, brachyTreatmentTechnique: BrachyTreatmentTechniqueType) -> BrachyPlanSetup: - """ - Args: - structureSet: A valid StructureSet to be connected to the plan. - dosePerFraction: Dose per fraction - brachyTreatmentTechnique: Brachytherapy treatment technique - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course. A new primary reference point is always created for the new plan. - def AddExternalPlanSetup(self, structureSet: StructureSet) -> ExternalPlanSetup: - """ - Args: - structureSet: A valid structure set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the verified plan and a new plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. - def AddExternalPlanSetupAsVerificationPlan(self, structureSet: StructureSet, verifiedPlan: ExternalPlanSetup) -> ExternalPlanSetup: - """ - Args: - structureSet: A valid structure set. - verifiedPlan: The verified plan. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. - def AddIonPlanSetup(self, structureSet: StructureSet, patientSupportDeviceId: str) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - patientSupportDeviceId: Id of the patient support device. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the proton plan to be verified and the new verification plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. - def AddIonPlanSetupAsVerificationPlan(self, structureSet: StructureSet, patientSupportDeviceId: str, verifiedPlan: IonPlanSetup) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - patientSupportDeviceId: Id of the patient support device. - verifiedPlan: The verified plan. - """ - ... - - - # Checks if a new plan can be added to this course using the given structure set. - def CanAddPlanSetup(self, structureSet: StructureSet) -> bool: - """ - Args: - structureSet: The structure set used by the plan. - """ - ... - - - # Checks if the plan setup can be removed from this course. - def CanRemovePlanSetup(self, planSetup: PlanSetup) -> bool: - """ - Args: - planSetup: The plan setup to check. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan (the planning image will be the same for both plans). - def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: - """ - Args: - sourcePlan: Brachy plan to copy from - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with the primary image of the sourcePlan. First copies image and then changes planning image. - def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: - """ - Args: - sourcePlan: Brachy plan to copy from - structureset: The structure set along with its associated image that will be assigned to the copied plan - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan (the planning image will be the same for both plans). - def CopyPlanSetup(self, sourcePlan: PlanSetup) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. If there are multiple registrations, just copies isocenter locations and shows a message about this. - def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - targetImage: Image to copy plan to - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. - def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, registration: Registration, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - targetImage: Image to copy plan to - registration: Registration to use to map geometry from source to target - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. - def CopyPlanSetup(self, sourcePlan: PlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - structureset: The structure set along with its associated image that will be assigned to the copied plan - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # Checks if the clinical status of the course is completed or restored. - def IsCompleted(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan setup from the database. Use - def RemovePlanSetup(self, planSetup: PlanSetup) -> None: - """ - Args: - planSetup: The plan setup that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan sum from the database. The PlanSum object given as a parameter is not usable anymore after this operation. - def RemovePlanSum(self, planSum: PlanSum) -> None: - """ - Args: - planSum: The plan sum that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan sum from given planning items. - def CreatePlanSum(self, planningItems: List[PlanningItem], image: Image) -> PlanSum: - """ - Args: - planningItems: Items to create sum from. All plans must share the same image, otherwise please use - image: Plan Sum image - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course with target, primary reference point and additional reference points in arguments - def AddExternalPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: List[ReferencePoint]) -> ExternalPlanSetup: - """ - Args: - structureSet: Valid StructureSet to connected with the plan - targetStructure: Target structure, if defined must be from 'structureSet', if left null target will remain unset. - primaryReferencePoint: Valid reference point to be connected as primary. - additionalReferencePoints: Collection of additional valid reference points - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course with the target structure, primary reference point and additional reference points specified in arguments. - def AddBrachyPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: DoseValue, dosePerFraction: BrachyTreatmentTechniqueType, brachyTreatmentTechnique: List[ReferencePoint]) -> BrachyPlanSetup: - """ - Args: - structureSet: Valid StructureSet to be connected to the plan - targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. - primaryReferencePoint: Valid reference point to be connected as primary reference point. - additionalReferencePoints: Collection of additional valid reference points - dosePerFraction: Dose per fraction - brachyTreatmentTechnique: Brachytherapy treatment technique - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. - def AddIonPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, patientSupportDeviceId: ReferencePoint, primaryReferencePoint: str, additionalReferencePoints: List[ReferencePoint]) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - targetStructure: Target structure. If defined, the value must be from 'structureSet'. If the value is null, the target will remain unset. - patientSupportDeviceId: Id of the patient support device. - primaryReferencePoint: Valid reference point to be connected as primary. - additionalReferencePoints: Collection of additional valid reference points - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new brachytherapy plan to this course. A new primary reference point is always created for the new brachytherapy plan. - def AddBrachyPlanSetup(self, structureSet: StructureSet, dosePerFraction: DoseValue, brachyTreatmentTechnique: BrachyTreatmentTechniqueType) -> BrachyPlanSetup: - """ - Args: - structureSet: A valid StructureSet to be connected to the plan. - dosePerFraction: Dose per fraction - brachyTreatmentTechnique: Brachytherapy treatment technique - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new plan to this course. A new primary reference point is always created for the new plan. - def AddExternalPlanSetup(self, structureSet: StructureSet) -> ExternalPlanSetup: - """ - Args: - structureSet: A valid structure set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the verified plan and a new plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. - def AddExternalPlanSetupAsVerificationPlan(self, structureSet: StructureSet, verifiedPlan: ExternalPlanSetup) -> ExternalPlanSetup: - """ - Args: - structureSet: A valid structure set. - verifiedPlan: The verified plan. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new proton plan to this course. - def AddIonPlanSetup(self, structureSet: StructureSet, patientSupportDeviceId: str) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - patientSupportDeviceId: Id of the patient support device. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new verification plan to this course and adds the relationship between the proton plan to be verified and the new verification plan. Data is not copied from the verified plan. A new primary reference point is always created for the new plan. - def AddIonPlanSetupAsVerificationPlan(self, structureSet: StructureSet, patientSupportDeviceId: str, verifiedPlan: IonPlanSetup) -> IonPlanSetup: - """ - Args: - structureSet: A valid structure set. - patientSupportDeviceId: Id of the patient support device. - verifiedPlan: The verified plan. - """ - ... - - - # Checks if a new plan can be added to this course using the given structure set. - def CanAddPlanSetup(self, structureSet: StructureSet) -> bool: - """ - Args: - structureSet: The structure set used by the plan. - """ - ... - - - # Checks if the plan setup can be removed from this course. - def CanRemovePlanSetup(self, planSetup: PlanSetup) -> bool: - """ - Args: - planSetup: The plan setup to check. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan (the planning image will be the same for both plans). - def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: - """ - Args: - sourcePlan: Brachy plan to copy from - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies brachytherapy plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with the primary image of the sourcePlan. First copies image and then changes planning image. - def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> BrachyPlanSetup: - """ - Args: - sourcePlan: Brachy plan to copy from - structureset: The structure set along with its associated image that will be assigned to the copied plan - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan (the planning image will be the same for both plans). - def CopyPlanSetup(self, sourcePlan: PlanSetup) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. If there are multiple registrations, just copies isocenter locations and shows a message about this. - def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - targetImage: Image to copy plan to - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to targetImage. targetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. - def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, registration: Registration, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - targetImage: Image to copy plan to - registration: Registration to use to map geometry from source to target - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies plan from sourcePlan to the target Image associated with the given structure set. TargetImage must be registered with primary image of the sourcePlan. First copies image and then changes planning image. - def CopyPlanSetup(self, sourcePlan: PlanSetup, structureset: StructureSet, outputDiagnostics: Text.StringBuilder) -> PlanSetup: - """ - Args: - sourcePlan: Plan to copy from - structureset: The structure set along with its associated image that will be assigned to the copied plan - outputDiagnostics: Information about copying, this needs to be shown to the user. - """ - ... - - - # Checks if the clinical status of the course is completed or restored. - def IsCompleted(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan setup from the database. Use - def RemovePlanSetup(self, planSetup: PlanSetup) -> None: - """ - Args: - planSetup: The plan setup that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan sum from the database. The PlanSum object given as a parameter is not usable anymore after this operation. - def RemovePlanSum(self, planSum: PlanSum) -> None: - """ - Args: - planSum: The plan sum that is removed. - """ - ... - - - -class CustomScriptExecutable: - """ - A factory class for creating an application object for a custom script executable. - """ - def __init__(self) -> None: ... - - # Creates an application object for a custom executable and logs it into the system. Application object created by this method can be used when the executable itself is not a script. For example, an interpreter of a high level programming language, or a native C++ application that integrates into .NET and uses ESAPI. The scripts executed with this application object are always read-only in a clinical environment, and writable in a non-clinical environment. - def CreateApplication(self, scriptName: str) -> Application: - """ - Args: - scriptName: The script name for logging in. Preferably use the full absolute path. - """ - ... - - - # Creates an application object for a custom executable and logs it into the system. Application object created by this method can be used when the executable itself is not a script. For example, an interpreter of a high level programming language, or a native C++ application that integrates into .NET and uses ESAPI. The scripts executed with this application object are always read-only in a clinical environment, and writable in a non-clinical environment. - def CreateApplication(self, scriptName: str) -> Application: - """ - Args: - scriptName: The script name for logging in. Preferably use the full absolute path. - """ - ... - - - -class IonPlanSetup: - """ - Represents a proton treatment plan. - - Attributes: - IsPostProcessingNeeded (bool): Instructs whether to include the post-processing of scanning spots in proton dose calculation. - CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. - DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by - IonBeams (List[IonBeam]): Gets the proton beams of the plan. - IsPostProcessingNeeded (bool): Instructs whether to include the post-processing of scanning spots in proton dose calculation. - CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. - DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by - IonBeams (List[IonBeam]): Gets the proton beams of the plan. - """ - def __init__(self) -> None: ... - - IsPostProcessingNeeded: bool - - CalculatePlanUncertaintyDose: bool - - DoseAsEvaluationDose: EvaluationDose - - IonBeams: List[IonBeam] - - IsPostProcessingNeeded: bool - - CalculatePlanUncertaintyDose: bool - - DoseAsEvaluationDose: EvaluationDose - - IonBeams: List[IonBeam] - - # [Availability of this property depends on your Eclipse Scripting API license] Creates a new proton verification plan that is a copy of this plan and that has dose calculated using the DECT proton stopping power values calculated based on the input images "rhoImage" and "zImage". - def CreateDectVerificationPlan(self, rhoImage: Image, zImage: Image) -> IonPlanSetup: - """ - Args: - rhoImage: A DECT relative electron density image where the value each voxel is interpreted as rho = 0.001 * (value + 1000). - zImage: A DECT effective atomic number image. - """ - ... - - - # This method is used to remove the temporary DECT objects under the DECT-study that was created for intermediate dose calculation. The method should be called only after the dose calculation is done, otherwise the intermediate dose is disposed too early. The temporary objects should be removed because they contain virtual CT images we do not want ending into the database. - def RemoveTemporaryObjects(self) -> Any: - ... - - - # Checks whether the proton volume dose calculation model attached to this plan is Proton Convolution Superposition. - def CheckDectCompatibleDoseCalcModel(self) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam line for the proton plan. - def CalculateBeamLine(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the proton plan. - def CalculateDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the proton plan. - def CalculatePlanUncertaintyDoses(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs IMPT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeIMPT(self, options: OptimizationOptionsIMPT) -> OptimizerResult: - """ - Args: - options: IMPT optimization options. - """ - ... - - - # Post-processes the proton plan by creating a final spot list, and calculates the dose. - def PostProcessAndCalculateDose(self) -> CalculationResult: - ... - - - # Calculates the dose for a proton plan without post-processing. The existing final spot list is used, and no new list is created during the calculation. - def CalculateDoseWithoutPostProcessing(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam delivery dynamics for the final spot list of a proton plan. - def CalculateBeamDeliveryDynamics(self) -> CalculationResult: - ... - - - # Returns a list of calculation models for the given calculation type. - def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new proton modulated scanning beam to the plan. - def AddModulatedScanningBeam(self, machineParameters: ProtonBeamMachineParameters, snoutId: str, snoutPosition: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See ExternalBeamMachineParameters. - snoutId: Snout ID. - snoutPosition: Snout position in centimeters. - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. - def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: - """ - Args: - existing: The dose matrix is copied from this object. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the - def CreateEvaluationDose(self) -> EvaluationDose: - ... - - - # Get information on whether the plan is optimized using multi-field optimization or single-field optimization. - def GetOptimizationMode(self) -> IonPlanOptimizationMode: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Set the plan normalization. See cref="PlanNormalizationMode" for the supported plan normalization methods. - def SetNormalization(self, normalizationParameters: IonPlanNormalizationParameters) -> None: - """ - Args: - normalizationParameters: Normalization parameters - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Set proton optimization to use either multi-field or single-field optimization. - def SetOptimizationMode(self, mode: IonPlanOptimizationMode) -> None: - """ - Args: - mode: Set the parameter to MultiFieldOptimization to use multi-field optimization and set to SingleFieldOptimization to use single-field optimization. - """ - ... - - - # [Availability of this property depends on your Eclipse Scripting API license] Creates a new proton verification plan that is a copy of this plan and that has dose calculated using the DECT proton stopping power values calculated based on the input images "rhoImage" and "zImage". - def CreateDectVerificationPlan(self, rhoImage: Image, zImage: Image) -> IonPlanSetup: - """ - Args: - rhoImage: A DECT relative electron density image where the value each voxel is interpreted as rho = 0.001 * (value + 1000). - zImage: A DECT effective atomic number image. - """ - ... - - - # This method is used to remove the temporary DECT objects under the DECT-study that was created for intermediate dose calculation. The method should be called only after the dose calculation is done, otherwise the intermediate dose is disposed too early. The temporary objects should be removed because they contain virtual CT images we do not want ending into the database. - def RemoveTemporaryObjects(self) -> Any: - ... - - - # Checks whether the proton volume dose calculation model attached to this plan is Proton Convolution Superposition. - def CheckDectCompatibleDoseCalcModel(self) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam line for the proton plan. - def CalculateBeamLine(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the proton plan. - def CalculateDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the proton plan. - def CalculatePlanUncertaintyDoses(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs IMPT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeIMPT(self, options: OptimizationOptionsIMPT) -> OptimizerResult: - """ - Args: - options: IMPT optimization options. - """ - ... - - - # Post-processes the proton plan by creating a final spot list, and calculates the dose. - def PostProcessAndCalculateDose(self) -> CalculationResult: - ... - - - # Calculates the dose for a proton plan without post-processing. The existing final spot list is used, and no new list is created during the calculation. - def CalculateDoseWithoutPostProcessing(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the beam delivery dynamics for the final spot list of a proton plan. - def CalculateBeamDeliveryDynamics(self) -> CalculationResult: - ... - - - # Returns a list of calculation models for the given calculation type. - def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new proton modulated scanning beam to the plan. - def AddModulatedScanningBeam(self, machineParameters: ProtonBeamMachineParameters, snoutId: str, snoutPosition: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See ExternalBeamMachineParameters. - snoutId: Snout ID. - snoutPosition: Snout position in centimeters. - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. - def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: - """ - Args: - existing: The dose matrix is copied from this object. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the - def CreateEvaluationDose(self) -> EvaluationDose: - ... - - - # Get information on whether the plan is optimized using multi-field optimization or single-field optimization. - def GetOptimizationMode(self) -> IonPlanOptimizationMode: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Set the plan normalization. See cref="PlanNormalizationMode" for the supported plan normalization methods. - def SetNormalization(self, normalizationParameters: IonPlanNormalizationParameters) -> None: - """ - Args: - normalizationParameters: Normalization parameters - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Set proton optimization to use either multi-field or single-field optimization. - def SetOptimizationMode(self, mode: IonPlanOptimizationMode) -> None: - """ - Args: - mode: Set the parameter to MultiFieldOptimization to use multi-field optimization and set to SingleFieldOptimization to use single-field optimization. - """ - ... - - - -class Dose: - """ - Represents a 3D dose grid. - - Attributes: - DoseMax3D (DoseValue): The maximum dose. - DoseMax3DLocation (VVector): The location of the maximum dose. - Isodoses (List[Isodose]): A collection of isodoses. - Origin (VVector): The origin of the dose matrix. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first dose plane. - Series (Series): Returns the series that contains the dose, or null if the dose is not connected to a series. - SeriesUID (str): Returns the DICOM UID of the series that contains the dose, or an empty string if the dose is not connected to a series. - UID (str): The DICOM UID of the dose. - XDirection (VVector): The direction of the x-axis in the dose matrix. - XRes (float): The dose matrix resolution in X-direction in millimeters. - XSize (int): The dose matrix size in X-direction in voxels. - YDirection (VVector): The direction of the y-axis in the dose matrix. - YRes (float): The dose matrix resolution in Y-direction in millimeters. - YSize (int): The dose matrix size in Y-direction in voxels. - ZDirection (VVector): The direction of the z-axis in the dose matrix. - ZRes (float): The dose matrix resolution in Z-direction in millimeters. - ZSize (int): The dose matrix size in Z-direction in voxels. - DoseMax3D (DoseValue): The maximum dose. - DoseMax3DLocation (VVector): The location of the maximum dose. - Isodoses (List[Isodose]): A collection of isodoses. - Origin (VVector): The origin of the dose matrix. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first dose plane. - Series (Series): Returns the series that contains the dose, or null if the dose is not connected to a series. - SeriesUID (str): Returns the DICOM UID of the series that contains the dose, or an empty string if the dose is not connected to a series. - UID (str): The DICOM UID of the dose. - XDirection (VVector): The direction of the x-axis in the dose matrix. - XRes (float): The dose matrix resolution in X-direction in millimeters. - XSize (int): The dose matrix size in X-direction in voxels. - YDirection (VVector): The direction of the y-axis in the dose matrix. - YRes (float): The dose matrix resolution in Y-direction in millimeters. - YSize (int): The dose matrix size in Y-direction in voxels. - ZDirection (VVector): The direction of the z-axis in the dose matrix. - ZRes (float): The dose matrix resolution in Z-direction in millimeters. - ZSize (int): The dose matrix size in Z-direction in voxels. - """ - def __init__(self) -> None: ... - - DoseMax3D: DoseValue - - DoseMax3DLocation: VVector - - Isodoses: List[Isodose] - - Origin: VVector - - Series: Series - - SeriesUID: str - - UID: str - - XDirection: VVector - - XRes: float - - XSize: int - - YDirection: VVector - - YRes: float - - YSize: int - - ZDirection: VVector - - ZRes: float - - ZSize: int - - DoseMax3D: DoseValue - - DoseMax3DLocation: VVector - - Isodoses: List[Isodose] - - Origin: VVector - - Series: Series - - SeriesUID: str - - UID: str - - XDirection: VVector - - XRes: float - - XSize: int - - YDirection: VVector - - YRes: float - - YSize: int - - ZDirection: VVector - - ZRes: float - - ZSize: int - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Gets the dose profile. - def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # Gets the point dose at a specified location. - def GetDoseToPoint(self, at: VVector) -> DoseValue: - """ - Args: - at: Location - """ - ... - - - # Gets the voxels of the given dose plane. - def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: - """ - Args: - planeIndex: Zero based index of the plane. - preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this dose. - """ - ... - - - # Converts the given raw voxel value to the corresponding dose value. - def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: - """ - Args: - voxelValue: Voxel value. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Gets the dose profile. - def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> DoseProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # Gets the point dose at a specified location. - def GetDoseToPoint(self, at: VVector) -> DoseValue: - """ - Args: - at: Location - """ - ... - - - # Gets the voxels of the given dose plane. - def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: - """ - Args: - planeIndex: Zero based index of the plane. - preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this dose. - """ - ... - - - # Converts the given raw voxel value to the corresponding dose value. - def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: - """ - Args: - voxelValue: Voxel value. - """ - ... - - - -class DVHEstimationModelStructure: - """ - Structure of a DVH estimation model in Planning Model Library - - Attributes: - Id (str): Id of the structure - IsValid (bool): Is Valid - ModelStructureGuid (str): Model Id - StructureCodes (List[StructureCode]): List of structure codes associated with the structure - StructureType (DVHEstimationStructureType): Structure type: PTV or OAR - Id (str): Id of the structure - IsValid (bool): Is Valid - ModelStructureGuid (str): Model Id - StructureCodes (List[StructureCode]): List of structure codes associated with the structure - StructureType (DVHEstimationStructureType): Structure type: PTV or OAR - """ - # Public constructor - @overload - def __init__(self, impl: IDVHEstimationModelStructure) -> None: - """ - Args: - impl: IDVHEstimationModelStructure object - """ - ... - - - # Public constructor - @overload - def __init__(self, impl: IDVHEstimationModelStructure) -> None: - """ - Args: - impl: IDVHEstimationModelStructure object - """ - ... - - - Id: str - - IsValid: bool - - ModelStructureGuid: str - - StructureCodes: List[StructureCode] - - StructureType: DVHEstimationStructureType - - Id: str - - IsValid: bool - - ModelStructureGuid: str - - StructureCodes: List[StructureCode] - - StructureType: DVHEstimationStructureType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Equipment: - """ - Provides access to clinical devices and accessories. - """ - # Equipment object constructor. - @overload - def __init__(self, admin: IAdmin) -> None: - """ - Args: - admin: An IAdmin object for accessing equipment data. - """ - ... - - - # Equipment object constructor. - @overload - def __init__(self, admin: IAdmin) -> None: - """ - Args: - admin: An IAdmin object for accessing equipment data. - """ - ... - - - # Returns the available brachy treatment units. Excludes virtual and deleted ones. - def GetBrachyTreatmentUnits(self) -> List[BrachyTreatmentUnit]: - ... - - - # Returns the available External Beam treatment units. Excludes virtual and deleted ones. - def GetExternalBeamTreatmentUnits(self) -> List[ExternalBeamTreatmentUnit]: - ... - - - # Returns the available brachy treatment units. Excludes virtual and deleted ones. - def GetBrachyTreatmentUnits(self) -> List[BrachyTreatmentUnit]: - ... - - - # Returns the available External Beam treatment units. Excludes virtual and deleted ones. - def GetExternalBeamTreatmentUnits(self) -> List[ExternalBeamTreatmentUnit]: - ... - - - -class ESAPIActionPackAttribute: - """ - Specifies the assembly as an Eclipse visual scripting action pack. Action packs are ESAPI scripts that are used by visual scripts. - - Attributes: - IsWriteable (bool): Returns true if the action pack can modify patient data. - IsWriteable (bool): Returns true if the action pack can modify patient data. - """ - def __init__(self) -> None: ... - - IsWriteable: bool - - IsWriteable: bool - - -class ESAPIScriptAttribute: - """ - Specifies the assembly as an Eclipse Scripting API (ESAPI) script. - - Attributes: - IsWriteable (bool): Returns true if the script can modify patient data. - IsWriteable (bool): Returns true if the script can modify patient data. - """ - def __init__(self) -> None: ... - - IsWriteable: bool - - IsWriteable: bool - - -class OptimizerDVH: - """ - Contains a structure-specific Dose Volume Histogram (DVH) curve generated in optimization. - - Attributes: - CurveData (Array[DVHPoint]): An array of DVH points representing the DVH curve data. - Structure (Structure): The corresponding structure for the DVH curve data. - CurveData (Array[DVHPoint]): An array of DVH points representing the DVH curve data. - Structure (Structure): The corresponding structure for the DVH curve data. - """ - def __init__(self) -> None: ... - - CurveData: Array[DVHPoint] - - Structure: Structure - - CurveData: Array[DVHPoint] - - Structure: Structure - - -class OptimizerObjectiveValue: - """ - The optimizer objective function value for the structure. - - Attributes: - Structure (Structure): The corresponding structure for the objective function value. - Value (float): The objective function value. - Structure (Structure): The corresponding structure for the objective function value. - Value (float): The objective function value. - """ - def __init__(self) -> None: ... - - Structure: Structure - - Value: float - - Structure: Structure - - Value: float - - -class ExternalPlanSetup: - """ - Represents an external beam plan. For more information, see the definition of the DICOM RT Plan. - - Attributes: - TradeoffExplorationContext (TradeoffExplorationContext): [Availability of this property depends on your Eclipse Scripting API license] Gets the - CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. - DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by - TradeoffExplorationContext (TradeoffExplorationContext): [Availability of this property depends on your Eclipse Scripting API license] Gets the - CalculatePlanUncertaintyDose (bool): Instructs whether to calculate nominal or plan uncertainty dose. - DoseAsEvaluationDose (EvaluationDose): The evaluation dose is connected to the plan and contains voxels that are set by - """ - def __init__(self) -> None: ... - - TradeoffExplorationContext: TradeoffExplorationContext - - CalculatePlanUncertaintyDose: bool - - DoseAsEvaluationDose: EvaluationDose - - TradeoffExplorationContext: TradeoffExplorationContext - - CalculatePlanUncertaintyDose: bool - - DoseAsEvaluationDose: EvaluationDose - - # Calculates the dose for the plan with preset meterset values. This applies only to IMRT beams. - def CalculateDoseWithPresetValues(self, presetValues: List[KeyValuePair[str, MetersetValue]]) -> CalculationResult: - """ - Args: - presetValues: The list of preset meterset values for the beams. An element of the list should contain a pair consisting of the beam identifier (as the key) and the corresponding preset meterset value for the beam. Each beam in the plan must have one entry in the list. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the plan. - def CalculateDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the photon plan. - def CalculatePlanUncertaintyDoses(self) -> CalculationResult: - ... - - - # Calculate leaf motions and dose using the calculation models defined in the plan setup. - def CalculateLeafMotionsAndDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. - def CalculateLeafMotions(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Leaf Motion Calculator (LMCV). - def CalculateLeafMotions(self, options: LMCVOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the Varian Leaf Motion Calculator (LMCV) algorithm. - """ - ... - - - # Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Smart LMC. - def CalculateLeafMotions(self, options: SmartLMCOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the Varian Smart LMC algorithm. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be MSS Leaf Motion Calculator (LMCMSS). - def CalculateLeafMotions(self, options: LMCMSSOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the MSS Leaf Motion Calculator (LMCMSS) algorithm. - """ - ... - - - # Returns a list of calculation models for the given calculation type. - def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Runs IMRT optimization for the plan setup. All existing optimal fluences are removed from the beams. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - """ - ... - - - # Runs IMRT optimization for the plan setup. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - optimizationOption: Optimization options. - """ - ... - - - # Runs IMRT optimization for the plan setup. You can add the Multileaf Collimator (MLC) as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption, mlcId: str) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - optimizationOption: Optimization option specifying the initial state. - mlcId: The identifier for the Multileaf Collimator (MLC). - """ - ... - - - # Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self) -> OptimizerResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs IMRT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, options: OptimizationOptionsIMRT) -> OptimizerResult: - """ - Args: - options: Options specifying initial state, intermediate dose, and termination upon convergence. - """ - ... - - - # This method is used to remove the temporary copy of the original IPlanSetup object that was created for intermediate dose calculation. The method should be called only after the optimization is done, otherwise the intermediate dose is disposed too early. The temporary copy should be removed because it is copy of an existing plan and this might cause problems when saving other plans to database, e.g., in automated validation tests. The plan is removed in the same way as in the optimization client for Eclipse. - def RemoveTemporaryPlan(self) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. You can add the MLC as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self, mlcId: str) -> OptimizerResult: - """ - Args: - mlcId: The identifier for the Multileaf Collimator (MLC). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self) -> OptimizerResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup using intermediate dose calculation. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self, options: OptimizationOptionsVMAT) -> OptimizerResult: - """ - Args: - options: VMAT optimization options. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam to the plan. - def AddArcBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new conformal arc beam to the plan. - def AddConformalArcBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, controlPointCount: int, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - controlPointCount: The number of control points to use. - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new fixed sequence (flattening sequence) beam to the plan. - def AddFixedSequenceBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, gantryAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds new imaging beam or beams to the plan. First removes the existing imaging beams. If MV imaging beams are involved, the plan should be optimized again. - def AddImagingSetup(self, machineParameters: ExternalBeamMachineParameters, setupParameters: ImagingBeamSetupParameters, targetStructure: Structure) -> bool: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - setupParameters: Setup parameters for the imaging beam. See - targetStructure: Target structure for imaging. If not specified, the target structure in the plan is used. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam with an MLC to the plan. - def AddMLCArcBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam with an MLC to the plan. - def AddMLCBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field with an MLC to the plan. - def AddMLCSetupBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Multiple Static Segments as the delivery technique. - def AddMultipleStaticSegmentBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field to the plan. - def AddSetupBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Sliding Window as the delivery technique. - def AddSlidingWindowBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new sliding window IMRT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. - def AddSlidingWindowBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: Gantry angle in the IEC GANTRY coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static beam to the plan. - def AddStaticBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam to the plan. - def AddVMATBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. - def AddVMATBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryStartAngle: float, gantryStopAngle: float, gantryDir: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryStartAngle: Gantry start angle in the IEC GANTRY coordinate system (in degrees). - gantryStopAngle: Gantry stop angle in the IEC GANTRY coordinate system (in degrees). - gantryDir: Gantry direction - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. - def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: - """ - Args: - existing: The dose matrix is copied from this object. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the - def CreateEvaluationDose(self) -> EvaluationDose: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes a beam from the plan. - def RemoveBeam(self, beam: Beam) -> None: - """ - Args: - beam: The beam that will be removed from the plan. - """ - ... - - - # Calculates the dose for the plan with preset meterset values. This applies only to IMRT beams. - def CalculateDoseWithPresetValues(self, presetValues: List[KeyValuePair[str, MetersetValue]]) -> CalculationResult: - """ - Args: - presetValues: The list of preset meterset values for the beams. An element of the list should contain a pair consisting of the beam identifier (as the key) and the corresponding preset meterset value for the beam. Each beam in the plan must have one entry in the list. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the plan. - def CalculateDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the photon plan. - def CalculatePlanUncertaintyDoses(self) -> CalculationResult: - ... - - - # Calculate leaf motions and dose using the calculation models defined in the plan setup. - def CalculateLeafMotionsAndDose(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. - def CalculateLeafMotions(self) -> CalculationResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Leaf Motion Calculator (LMCV). - def CalculateLeafMotions(self, options: LMCVOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the Varian Leaf Motion Calculator (LMCV) algorithm. - """ - ... - - - # Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Smart LMC. - def CalculateLeafMotions(self, options: SmartLMCOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the Varian Smart LMC algorithm. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be MSS Leaf Motion Calculator (LMCMSS). - def CalculateLeafMotions(self, options: LMCMSSOptions) -> CalculationResult: - """ - Args: - options: Calculation options for the MSS Leaf Motion Calculator (LMCMSS) algorithm. - """ - ... - - - # Returns a list of calculation models for the given calculation type. - def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Runs IMRT optimization for the plan setup. All existing optimal fluences are removed from the beams. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - """ - ... - - - # Runs IMRT optimization for the plan setup. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - optimizationOption: Optimization options. - """ - ... - - - # Runs IMRT optimization for the plan setup. You can add the Multileaf Collimator (MLC) as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption, mlcId: str) -> OptimizerResult: - """ - Args: - maxIterations: The maximum number of iterations. - optimizationOption: Optimization option specifying the initial state. - mlcId: The identifier for the Multileaf Collimator (MLC). - """ - ... - - - # Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self) -> OptimizerResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs IMRT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def Optimize(self, options: OptimizationOptionsIMRT) -> OptimizerResult: - """ - Args: - options: Options specifying initial state, intermediate dose, and termination upon convergence. - """ - ... - - - # This method is used to remove the temporary copy of the original IPlanSetup object that was created for intermediate dose calculation. The method should be called only after the optimization is done, otherwise the intermediate dose is disposed too early. The temporary copy should be removed because it is copy of an existing plan and this might cause problems when saving other plans to database, e.g., in automated validation tests. The plan is removed in the same way as in the optimization client for Eclipse. - def RemoveTemporaryPlan(self) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. You can add the MLC as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self, mlcId: str) -> OptimizerResult: - """ - Args: - mlcId: The identifier for the Multileaf Collimator (MLC). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self) -> OptimizerResult: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup using intermediate dose calculation. Plan normalization method is changed to 'No plan normalization' after successful optimization. - def OptimizeVMAT(self, options: OptimizationOptionsVMAT) -> OptimizerResult: - """ - Args: - options: VMAT optimization options. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam to the plan. - def AddArcBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new conformal arc beam to the plan. - def AddConformalArcBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, controlPointCount: int, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - controlPointCount: The number of control points to use. - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new fixed sequence (flattening sequence) beam to the plan. - def AddFixedSequenceBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, gantryAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds new imaging beam or beams to the plan. First removes the existing imaging beams. If MV imaging beams are involved, the plan should be optimized again. - def AddImagingSetup(self, machineParameters: ExternalBeamMachineParameters, setupParameters: ImagingBeamSetupParameters, targetStructure: Structure) -> bool: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - setupParameters: Setup parameters for the imaging beam. See - targetStructure: Target structure for imaging. If not specified, the target structure in the plan is used. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam with an MLC to the plan. - def AddMLCArcBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam with an MLC to the plan. - def AddMLCBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field with an MLC to the plan. - def AddMLCSetupBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - leafPositions: The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default. - jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Multiple Static Segments as the delivery technique. - def AddMultipleStaticSegmentBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field to the plan. - def AddSetupBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Sliding Window as the delivery technique. - def AddSlidingWindowBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new sliding window IMRT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. - def AddSlidingWindowBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: Gantry angle in the IEC GANTRY coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new static beam to the plan. - def AddStaticBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - jawPositions: The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam to the plan. - def AddVMATBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryAngle: The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - gantryStop: The stop angle of the gantry, in degrees. - gantryDirection: The rotation direction of the arc. - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position, in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account. - def AddVMATBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryStartAngle: float, gantryStopAngle: float, gantryDir: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: - """ - Args: - machineParameters: Configuration of the used treatment unit. See - metersetWeights: The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points. - collimatorAngle: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - gantryStartAngle: Gantry start angle in the IEC GANTRY coordinate system (in degrees). - gantryStopAngle: Gantry stop angle in the IEC GANTRY coordinate system (in degrees). - gantryDir: Gantry direction - patientSupportAngle: The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - isocenter: The isocenter position in millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams. - def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: - """ - Args: - existing: The dose matrix is copied from this object. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the - def CreateEvaluationDose(self) -> EvaluationDose: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes a beam from the plan. - def RemoveBeam(self, beam: Beam) -> None: - """ - Args: - beam: The beam that will be removed from the plan. - """ - ... - - - -class ReferencePoint: - """ - A reference point associated with a patient. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Reference Point. - DailyDoseLimit (DoseValue): Daily dose limit of this reference point. - SessionDoseLimit (DoseValue): Session dose limit of this reference point. - TotalDoseLimit (DoseValue): Total dose limit of this reference point. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Reference Point. - DailyDoseLimit (DoseValue): Daily dose limit of this reference point. - SessionDoseLimit (DoseValue): Session dose limit of this reference point. - TotalDoseLimit (DoseValue): Total dose limit of this reference point. - """ - def __init__(self) -> None: ... - - Id: str - - DailyDoseLimit: DoseValue - - SessionDoseLimit: DoseValue - - TotalDoseLimit: DoseValue - - Id: str - - DailyDoseLimit: DoseValue - - SessionDoseLimit: DoseValue - - TotalDoseLimit: DoseValue - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add location for reference point into image 'Image' - def AddLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image into which location is inserted - x: x coordinate - y: y coordinate - z: z coordinate - errorHint: Holder for error message if addition fails - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Change location for reference point into image 'Image' - def ChangeLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image into which location is inserted - x: x coordinate in mm - y: y coordinate in mm - z: z coordinate in mm - errorHint: Holder for error message if location cannot be changed - """ - ... - - - # 3D location of this reference point in mm - def GetReferencePointLocation(self, Image: Image) -> VVector: - """ - Args: - Image: Image for which the location is requested - """ - ... - - - # The location of the reference point in mm. - def GetReferencePointLocation(self, planSetup: PlanSetup) -> VVector: - """ - Args: - planSetup: Plan setup that this reference point is connected to. - """ - ... - - - # Tests if a valid reference point location exists. - def HasLocation(self, planSetup: PlanSetup) -> bool: - """ - Args: - planSetup: Plan setup that this reference point is connected to - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove reference point location from image 'Image' - def RemoveLocation(self, Image: Image, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image from which the location for the reference point is removed - errorHint: Holder for error message if removal fails - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add location for reference point into image 'Image' - def AddLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image into which location is inserted - x: x coordinate - y: y coordinate - z: z coordinate - errorHint: Holder for error message if addition fails - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Change location for reference point into image 'Image' - def ChangeLocation(self, Image: Image, x: float, y: float, z: float, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image into which location is inserted - x: x coordinate in mm - y: y coordinate in mm - z: z coordinate in mm - errorHint: Holder for error message if location cannot be changed - """ - ... - - - # 3D location of this reference point in mm - def GetReferencePointLocation(self, Image: Image) -> VVector: - """ - Args: - Image: Image for which the location is requested - """ - ... - - - # The location of the reference point in mm. - def GetReferencePointLocation(self, planSetup: PlanSetup) -> VVector: - """ - Args: - planSetup: Plan setup that this reference point is connected to. - """ - ... - - - # Tests if a valid reference point location exists. - def HasLocation(self, planSetup: PlanSetup) -> bool: - """ - Args: - planSetup: Plan setup that this reference point is connected to - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove reference point location from image 'Image' - def RemoveLocation(self, Image: Image, errorHint: Text.StringBuilder) -> bool: - """ - Args: - Image: Image from which the location for the reference point is removed - errorHint: Holder for error message if removal fails - """ - ... - - - -class SeedCollection: - """ - Represents a collection of brachytherapy - - Attributes: - BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): Obsolete. - Color (Windows.Media.Color): The color of the seeds in the seed collection in the views. - SourcePositions (List[SourcePosition]): The source positions in this collection in creation order. - BrachyFieldReferencePoints (List[BrachyFieldReferencePoint]): Obsolete. - Color (Windows.Media.Color): The color of the seeds in the seed collection in the views. - SourcePositions (List[SourcePosition]): The source positions in this collection in creation order. - """ - def __init__(self) -> None: ... - - BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] - - Color: Windows.Media.Color - - SourcePositions: List[SourcePosition] - - BrachyFieldReferencePoints: List[BrachyFieldReferencePoint] - - Color: Windows.Media.Color - - SourcePositions: List[SourcePosition] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class SourcePosition: - """ - Represents a brachytherapy source dwell position in a - - Attributes: - DwellTime (float): Dwell time. - DwellTimeLock (Optional[bool]): Identifies if the dwell time is locked. Set dwell time either locked = true, or unlocked = false. Locked when not allowed to change the dwell time. If unlocked, the dwell time can be changed. - NominalDwellTime (float): The nominal dwell time associated with this source position in seconds. - RadioactiveSource (RadioactiveSource): The radioactive source associated with this dwell position. - Transform (Array[float]): The 4x4 transformation matrix represents the orientation and location of the source position in space. The matrix is composed of a 4x3 rotation submatrix and a 4x1 translation vector. Its bottom row indicates scaling and is always [0 0 0 1]. The translation vector indicates the coordinates of the source position center, in millimeters. The third column of the rotation matrix indicates the source axis direction. - Translation (VVector): The translation of this source position. - DwellTime (float): Dwell time. - DwellTimeLock (Optional[bool]): Identifies if the dwell time is locked. Set dwell time either locked = true, or unlocked = false. Locked when not allowed to change the dwell time. If unlocked, the dwell time can be changed. - NominalDwellTime (float): The nominal dwell time associated with this source position in seconds. - RadioactiveSource (RadioactiveSource): The radioactive source associated with this dwell position. - Transform (Array[float]): The 4x4 transformation matrix represents the orientation and location of the source position in space. The matrix is composed of a 4x3 rotation submatrix and a 4x1 translation vector. Its bottom row indicates scaling and is always [0 0 0 1]. The translation vector indicates the coordinates of the source position center, in millimeters. The third column of the rotation matrix indicates the source axis direction. - Translation (VVector): The translation of this source position. - """ - def __init__(self) -> None: ... - - DwellTime: float - - DwellTimeLock: Optional[bool] - - NominalDwellTime: float - - RadioactiveSource: RadioactiveSource - - Transform: Array[float] - - Translation: VVector - - DwellTime: float - - DwellTimeLock: Optional[bool] - - NominalDwellTime: float - - RadioactiveSource: RadioactiveSource - - Transform: Array[float] - - Translation: VVector - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class StructureCode: - """ - Represents a structure code and its coding scheme. - - Attributes: - Code (str): The structure code as defined in the associated coding scheme. - CodeMeaning (str): The meaning of the structure code. - CodingScheme (str): The coding scheme of the structure code. - DisplayName (str): The display name of the code. - IsEncompassStructureCode (bool): Indicates whether the structure code is an encompass structure code. - Code (str): The structure code as defined in the associated coding scheme. - CodeMeaning (str): The meaning of the structure code. - CodingScheme (str): The coding scheme of the structure code. - DisplayName (str): The display name of the code. - IsEncompassStructureCode (bool): Indicates whether the structure code is an encompass structure code. - """ - def __init__(self) -> None: ... - - Code: str - - CodeMeaning: str - - CodingScheme: str - - DisplayName: str - - IsEncompassStructureCode: bool - - Code: str - - CodeMeaning: str - - CodingScheme: str - - DisplayName: str - - IsEncompassStructureCode: bool - - # Returns a StructureCodeInfo object with the same coding scheme and code as in the current structure code object. - def ToStructureCodeInfo(self) -> StructureCodeInfo: - ... - - - # Determines whether this structure code is considered equal to the specified structure code. - def Equals(self, other: StructureCode) -> bool: - ... - - - # Determines whether the current object is considered equal to the specified object. - def Equals(self, obj: StructureCode) -> bool: - ... - - - # The equality operator. - def op_Equality(self, sc1: StructureCode, sc2: StructureCode) -> bool: - ... - - - # The inequality operator. - def op_Inequality(self, sc1: StructureCode, sc2: StructureCode) -> bool: - ... - - - # Returns a string that represents this object. - def ToString(self) -> str: - ... - - - # Returns the hash code for this structure code. - def GetHashCode(self) -> int: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns a StructureCodeInfo object with the same coding scheme and code as in the current structure code object. - def ToStructureCodeInfo(self) -> StructureCodeInfo: - ... - - - # Determines whether this structure code is considered equal to the specified structure code. - def Equals(self, other: StructureCode) -> bool: - ... - - - # Determines whether the current object is considered equal to the specified object. - def Equals(self, obj: StructureCode) -> bool: - ... - - - # The equality operator. - def op_Equality(self, sc1: StructureCode, sc2: StructureCode) -> bool: - ... - - - # The inequality operator. - def op_Inequality(self, sc1: StructureCode, sc2: StructureCode) -> bool: - ... - - - # Returns a string that represents this object. - def ToString(self) -> str: - ... - - - # Returns the hash code for this structure code. - def GetHashCode(self) -> int: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class StructureCodeDictionary: - """ - Represents a set of structure codes as defined by a structure code scheme. The class exposes the structure codes that are available through the implemented - - Attributes: - Name (str): The name of the structure code scheme. - Version (str): The version of the structure code scheme. May be an empty string, if not applicable to the scheme. - Keys (List[str]): Gets a collection containing the structure code identifiers in this structure code dictionary. - Values (List[StructureCode]): Gets a collection containing the structure codes in this structure code dictionary. - Count (int): Gets the number of structure code object key/value pairs in this structure code dictionary. - Name (str): The name of the structure code scheme. - Version (str): The version of the structure code scheme. May be an empty string, if not applicable to the scheme. - Keys (List[str]): Gets a collection containing the structure code identifiers in this structure code dictionary. - Values (List[StructureCode]): Gets a collection containing the structure codes in this structure code dictionary. - Count (int): Gets the number of structure code object key/value pairs in this structure code dictionary. - """ - def __init__(self) -> None: ... - - Name: str - - Version: str - - Keys: List[str] - - Values: List[StructureCode] - - Count: int - - Name: str - - Version: str - - Keys: List[str] - - Values: List[StructureCode] - - Count: int - - # Determines whether the scheme contains the specified key as an active structure code identifier. - def ContainsKey(self, key: str) -> bool: - ... - - - # Gets the structure code object associated with the specified structure code identifier (key). - def TryGetValue(self, key: str, value: StructureCode) -> bool: - """ - Args: - key: The structure code identifier. - value: When the method returns, contains the specified structure code object, if it is found, otherwise null. - """ - ... - - - # Returns an enumerator that iterates through the collection. - def GetEnumerator(self) -> Iterable[KeyValuePair[str, StructureCode]]: - ... - - - # Returns a string that represents this object. - def ToString(self) -> str: - ... - - - # Determines whether the scheme contains the specified key as an active structure code identifier. - def ContainsKey(self, key: str) -> bool: - ... - - - # Gets the structure code object associated with the specified structure code identifier (key). - def TryGetValue(self, key: str, value: StructureCode) -> bool: - """ - Args: - key: The structure code identifier. - value: When the method returns, contains the specified structure code object, if it is found, otherwise null. - """ - ... - - - # Returns an enumerator that iterates through the collection. - def GetEnumerator(self) -> Iterable[KeyValuePair[str, StructureCode]]: - ... - - - # Returns a string that represents this object. - def ToString(self) -> str: - ... - - - -class ActiveStructureCodeDictionaries: - """ - Provides access to the structure code dictionaries with the active structure codes. - - Attributes: - Fma (StructureCodeDictionary): The Foundational Model of Anatomy Ontology structure scheme. - RadLex (StructureCodeDictionary): The RSNA RadLex radiology lexicon structure scheme. - Srt (StructureCodeDictionary): The SNOMED RT structure scheme. - VmsStructCode (StructureCodeDictionary): The Varian 99VMS_STRUCTCODE structure scheme. - Fma (StructureCodeDictionary): The Foundational Model of Anatomy Ontology structure scheme. - RadLex (StructureCodeDictionary): The RSNA RadLex radiology lexicon structure scheme. - Srt (StructureCodeDictionary): The SNOMED RT structure scheme. - VmsStructCode (StructureCodeDictionary): The Varian 99VMS_STRUCTCODE structure scheme. - """ - # Constructs a new ActiveStructureCodeDictionaries instance. - @overload - def __init__(self, providerFunc: Func[str, IReadOnlyDictionary[str, IStructureCode]]) -> None: - ... - - - # Constructs a new ActiveStructureCodeDictionaries instance. - @overload - def __init__(self, providerFunc: Func[str, IReadOnlyDictionary[str, IStructureCode]]) -> None: - ... - - - Fma: StructureCodeDictionary - - RadLex: StructureCodeDictionary - - Srt: StructureCodeDictionary - - VmsStructCode: StructureCodeDictionary - - Fma: StructureCodeDictionary - - RadLex: StructureCodeDictionary - - Srt: StructureCodeDictionary - - VmsStructCode: StructureCodeDictionary - - -class TradeoffPlanGenerationIntermediateDoseMode: - """ - Enumeration that specifies the use of intermediate dose when optimizing a plan collection for trade-off exploring. - """ - def __init__(self) -> None: ... - - -class Image: - """ - Represents a 2D or 3D image, which can be a DRR, a CT, MR, or other volumetric dataset. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the image. - ApprovalHistory (List[ImageApprovalHistoryEntry]): Returns the approval history of the image. - ContrastBolusAgentIngredientName (str): The name of the contrast bolus agent ingredient that is used in the image. If the value has not been specified, returns null. - CreationDateTime (Optional[datetime]): The date when this object was created. - DisplayUnit (str): The name of the display unit in which the voxels of the image are shown in the user interface. - FOR (str): The UID of the frame of reference. - HasUserOrigin (bool): Defines if a user origin has been specified for the image. - ImageType (str): The type of the image as indicated in the properties of the image slices. - ImagingDeviceId (str): Identification of the device that is used to scan the images into the system. - ImagingOrientation (PatientOrientation): The orientation of the patient. - ImagingOrientationAsString (str): The orientation of the patient as a string (localized) - IsProcessed (bool): Returns the value true if an image processing filter is in use for the image. - Level (int): The level setting. The value is given in the internal voxel scale. - Modality (SeriesModality): The modality of the image as indicated in the properties of the image slices. - Origin (VVector): The origin of the image. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first image plane. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - Series (Series): Used for navigating to parent series. - UID (str): Return UID of the first (and the only) slice in case of a 2D Image. Return null in case of a 3D Image. - UserOrigin (VVector): The user origin in DICOM coordinates in millimeter. - UserOriginComments (str): The text typed on the Origin tab in the Image Properties dialog box. - Window (int): The window setting. The value is given in the internal voxel scale. - XDirection (VVector): The direction of the x-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - XRes (float): The image resolution in X-direction in millimeters. - XSize (int): The image size in X-direction in voxels. - YDirection (VVector): The direction of the y-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - YRes (float): The image resolution in Y-direction in millimeters. - YSize (int): The image size in Y-direction in voxels. - ZDirection (VVector): The direction of the z-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - ZRes (float): The image resolution in Z-direction in millimeters. - ZSize (int): The image size in Z-direction in voxels. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the image. - ApprovalHistory (List[ImageApprovalHistoryEntry]): Returns the approval history of the image. - ContrastBolusAgentIngredientName (str): The name of the contrast bolus agent ingredient that is used in the image. If the value has not been specified, returns null. - CreationDateTime (Optional[datetime]): The date when this object was created. - DisplayUnit (str): The name of the display unit in which the voxels of the image are shown in the user interface. - FOR (str): The UID of the frame of reference. - HasUserOrigin (bool): Defines if a user origin has been specified for the image. - ImageType (str): The type of the image as indicated in the properties of the image slices. - ImagingDeviceId (str): Identification of the device that is used to scan the images into the system. - ImagingOrientation (PatientOrientation): The orientation of the patient. - ImagingOrientationAsString (str): The orientation of the patient as a string (localized) - IsProcessed (bool): Returns the value true if an image processing filter is in use for the image. - Level (int): The level setting. The value is given in the internal voxel scale. - Modality (SeriesModality): The modality of the image as indicated in the properties of the image slices. - Origin (VVector): The origin of the image. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first image plane. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - Series (Series): Used for navigating to parent series. - UID (str): Return UID of the first (and the only) slice in case of a 2D Image. Return null in case of a 3D Image. - UserOrigin (VVector): The user origin in DICOM coordinates in millimeter. - UserOriginComments (str): The text typed on the Origin tab in the Image Properties dialog box. - Window (int): The window setting. The value is given in the internal voxel scale. - XDirection (VVector): The direction of the x-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - XRes (float): The image resolution in X-direction in millimeters. - XSize (int): The image size in X-direction in voxels. - YDirection (VVector): The direction of the y-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - YRes (float): The image resolution in Y-direction in millimeters. - YSize (int): The image size in Y-direction in voxels. - ZDirection (VVector): The direction of the z-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs. - ZRes (float): The image resolution in Z-direction in millimeters. - ZSize (int): The image size in Z-direction in voxels. - """ - def __init__(self) -> None: ... - - Id: str - - ApprovalHistory: List[ImageApprovalHistoryEntry] - - ContrastBolusAgentIngredientName: str - - CreationDateTime: Optional[datetime] - - DisplayUnit: str - - FOR: str - - HasUserOrigin: bool - - ImageType: str - - ImagingDeviceId: str - - ImagingOrientation: PatientOrientation - - ImagingOrientationAsString: str - - IsProcessed: bool - - Level: int - - Modality: SeriesModality - - Origin: VVector - - Series: Series - - UID: str - - UserOrigin: VVector - - UserOriginComments: str - - Window: int - - XDirection: VVector - - XRes: float - - XSize: int - - YDirection: VVector - - YRes: float - - YSize: int - - ZDirection: VVector - - ZRes: float - - ZSize: int - - Id: str - - ApprovalHistory: List[ImageApprovalHistoryEntry] - - ContrastBolusAgentIngredientName: str - - CreationDateTime: Optional[datetime] - - DisplayUnit: str - - FOR: str - - HasUserOrigin: bool - - ImageType: str - - ImagingDeviceId: str - - ImagingOrientation: PatientOrientation - - ImagingOrientationAsString: str - - IsProcessed: bool - - Level: int - - Modality: SeriesModality - - Origin: VVector - - Series: Series - - UID: str - - UserOrigin: VVector - - UserOriginComments: str - - Window: int - - XDirection: VVector - - XRes: float - - XSize: int - - YDirection: VVector - - YRes: float - - YSize: int - - ZDirection: VVector - - ZRes: float - - ZSize: int - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns the voxel-wise DECT proton stopping powers of the given image plane calculated from the current image and the rho and Z images. The image FOR, size, and resolution for the rho and Z images must conform with this image. - def CalculateDectProtonStoppingPowers(self, rhoImage: Image, zImage: Image, planeIndex: int, preallocatedBuffer: Array[float]) -> None: - """ - Args: - rhoImage: A DECT relative electron density image. The electron density is interpreted from the image values as rho = 0.001 * (value + 1000). - zImage: A DECT effective atomic number image. - planeIndex: Zero based index of the plane. - preallocatedBuffer: Pre-allocated buffer where the proton stopping power values are stored. The size of the buffer must conform with the X- and Y-size of this image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new structure set. If the image does not yet have a structure set, the new structure set will be assigned directly to it. If the image already has a structure set, a copy of this image is made, and the new structure set is assigned to the copy. The image must be a 3D image. - def CreateNewStructureSet(self) -> StructureSet: - ... - - - # Converts DICOM coordinates to the planning coordinate system used in the Eclipse user interface. - def DicomToUser(self, dicom: VVector, planSetup: PlanSetup) -> VVector: - """ - Args: - dicom: Coordinate value in DICOM coordinate system. - planSetup: Plan that defines the planning orientation or null. - """ - ... - - - # Gets the image profile. - def GetImageProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> ImageProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # Returns the HU to proton stopping power curve associated with the image. - def GetProtonStoppingPowerCurve(self, protonStoppingPowerCurve: SortedList[float, float]) -> bool: - """ - Args: - protonStoppingPowerCurve: An empty list where the curve values will be stored. - """ - ... - - - # Gets the voxels of the given image plane. - def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: - """ - Args: - planeIndex: Zero based index of the plane. - preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this image. - """ - ... - - - # Converts a coordinate value from the planning coordinate system used in the Eclipse user interface to DICOM coordinates. - def UserToDicom(self, user: VVector, planSetup: PlanSetup) -> VVector: - """ - Args: - user: Coordinate value in the planning coordinate system. - planSetup: Plan that defines the planning orientation or null. - """ - ... - - - # Converts the given raw voxel value to the corresponding value in the user interface display unit, for example, HU, Bq/ml. - def VoxelToDisplayValue(self, voxelValue: int) -> float: - """ - Args: - voxelValue: Voxel value. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns the voxel-wise DECT proton stopping powers of the given image plane calculated from the current image and the rho and Z images. The image FOR, size, and resolution for the rho and Z images must conform with this image. - def CalculateDectProtonStoppingPowers(self, rhoImage: Image, zImage: Image, planeIndex: int, preallocatedBuffer: Array[float]) -> None: - """ - Args: - rhoImage: A DECT relative electron density image. The electron density is interpreted from the image values as rho = 0.001 * (value + 1000). - zImage: A DECT effective atomic number image. - planeIndex: Zero based index of the plane. - preallocatedBuffer: Pre-allocated buffer where the proton stopping power values are stored. The size of the buffer must conform with the X- and Y-size of this image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new structure set. If the image does not yet have a structure set, the new structure set will be assigned directly to it. If the image already has a structure set, a copy of this image is made, and the new structure set is assigned to the copy. The image must be a 3D image. - def CreateNewStructureSet(self) -> StructureSet: - ... - - - # Converts DICOM coordinates to the planning coordinate system used in the Eclipse user interface. - def DicomToUser(self, dicom: VVector, planSetup: PlanSetup) -> VVector: - """ - Args: - dicom: Coordinate value in DICOM coordinate system. - planSetup: Plan that defines the planning orientation or null. - """ - ... - - - # Gets the image profile. - def GetImageProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[Double]) -> ImageProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # Returns the HU to proton stopping power curve associated with the image. - def GetProtonStoppingPowerCurve(self, protonStoppingPowerCurve: SortedList[float, float]) -> bool: - """ - Args: - protonStoppingPowerCurve: An empty list where the curve values will be stored. - """ - ... - - - # Gets the voxels of the given image plane. - def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: - """ - Args: - planeIndex: Zero based index of the plane. - preallocatedBuffer: Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this image. - """ - ... - - - # Converts a coordinate value from the planning coordinate system used in the Eclipse user interface to DICOM coordinates. - def UserToDicom(self, user: VVector, planSetup: PlanSetup) -> VVector: - """ - Args: - user: Coordinate value in the planning coordinate system. - planSetup: Plan that defines the planning orientation or null. - """ - ... - - - # Converts the given raw voxel value to the corresponding value in the user interface display unit, for example, HU, Bq/ml. - def VoxelToDisplayValue(self, voxelValue: int) -> float: - """ - Args: - voxelValue: Voxel value. - """ - ... - - - -class IDVHEstimationCalculator: - """ - Interface to the calculation of the DVH Estimates - """ - def __init__(self) -> None: ... - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: - """ - Args: - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - """ - ... - - - -class IonBeamParameters: - """ - An editable copy of the parameters of a proton beam. - - Attributes: - ControlPoints (List[IonControlPointParameters]): Editable control point parameters copied from the treatment beam. - PreSelectedRangeShifter1Id (str): ID of the pre-selected range shifter 1 in the field. - PreSelectedRangeShifter1Setting (str): Setting of the pre-selected range shifter 1 in the field. - PreSelectedRangeShifter2Id (str): ID of the pre-selected range shifter 2 in the field. - PreSelectedRangeShifter2Setting (str): Setting of the pre-selected range shifter 2 in the field. - IonControlPointPairs (IonControlPointPairCollection): A copy of editable control point pairs. - SnoutId (str): The snout identifier. Returns null if undefined. - SnoutPosition (float): Snout position in centimeters. - TargetStructure (Structure): Target structure of the field. - ControlPoints (List[IonControlPointParameters]): Editable control point parameters copied from the treatment beam. - PreSelectedRangeShifter1Id (str): ID of the pre-selected range shifter 1 in the field. - PreSelectedRangeShifter1Setting (str): Setting of the pre-selected range shifter 1 in the field. - PreSelectedRangeShifter2Id (str): ID of the pre-selected range shifter 2 in the field. - PreSelectedRangeShifter2Setting (str): Setting of the pre-selected range shifter 2 in the field. - IonControlPointPairs (IonControlPointPairCollection): A copy of editable control point pairs. - SnoutId (str): The snout identifier. Returns null if undefined. - SnoutPosition (float): Snout position in centimeters. - TargetStructure (Structure): Target structure of the field. - - Note: - To apply the parameters, call the - """ - def __init__(self) -> None: ... - - ControlPoints: List[IonControlPointParameters] - - PreSelectedRangeShifter1Id: str - - PreSelectedRangeShifter1Setting: str - - PreSelectedRangeShifter2Id: str - - PreSelectedRangeShifter2Setting: str - - IonControlPointPairs: IonControlPointPairCollection - - SnoutId: str - - SnoutPosition: float - - TargetStructure: Structure - - ControlPoints: List[IonControlPointParameters] - - PreSelectedRangeShifter1Id: str - - PreSelectedRangeShifter1Setting: str - - PreSelectedRangeShifter2Id: str - - PreSelectedRangeShifter2Setting: str - - IonControlPointPairs: IonControlPointPairCollection - - SnoutId: str - - SnoutPosition: float - - TargetStructure: Structure - - -class OptimizationControllerIMPT: - """ - Controls the IMPT optimization from the Script - """ - def __init__(self) -> None: ... - -class OptimizationControllerIMRT: - """ - Controls the IMRT optimization from the Script - """ - def __init__(self) -> None: ... - -class OptimizationControllerVMAT: - """ - Controls the VMAT optimization from the Script - """ - def __init__(self) -> None: ... - -class OptimizationSetup: - """ - Gives access to the optimization parameters and objectives. - - Attributes: - UseJawTracking (bool): [Availability of this property depends on your Eclipse Scripting API license] Jaw tracking parameter for VMAT optimization. The parameter can only be set for plans to be delivered with a treatment machine that supports jaw tracking. - Objectives (List[OptimizationObjective]): A collection of optimization objectives. - Parameters (List[OptimizationParameter]): A collection of optimization parameters. - UseJawTracking (bool): [Availability of this property depends on your Eclipse Scripting API license] Jaw tracking parameter for VMAT optimization. The parameter can only be set for plans to be delivered with a treatment machine that supports jaw tracking. - Objectives (List[OptimizationObjective]): A collection of optimization objectives. - Parameters (List[OptimizationParameter]): A collection of optimization parameters. - """ - def __init__(self) -> None: ... - - UseJawTracking: bool - - Objectives: List[OptimizationObjective] - - Parameters: List[OptimizationParameter] - - UseJawTracking: bool - - Objectives: List[OptimizationObjective] - - Parameters: List[OptimizationParameter] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. - def AddAutomaticNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic SBRT normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. - def AddAutomaticSbrtNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam-specific parameter for IMRT optimization. - def AddBeamSpecificParameter(self, beam: Beam, smoothX: float, smoothY: float, fixedJaws: bool) -> OptimizationIMRTBeamParameter: - """ - Args: - beam: The beam for which the parameters are added. - smoothX: A fluence-smoothing parameter in X-direction. - smoothY: A fluence-smoothing parameter in Y-direction. - fixedJaws: If true, the collimator jaw positions of the beam remain the same during the optimization. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new gEUD objective. - def AddEUDObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, parameterA: float, priority: float) -> OptimizationEUDObjective: - """ - Args: - structure: The target structure of the objective. - objectiveOperator: The type of the gEUD objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - parameterA: gEUD parameter a. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new mean dose objective. - def AddMeanDoseObjective(self, structure: Structure, dose: DoseValue, priority: float) -> OptimizationMeanDoseObjective: - """ - Args: - structure: The target structure of the objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. - def AddNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float, fallOff: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - fallOff: Determines the steepness of the normal tissue objective fall-off. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new point objective. - def AddPointObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, volume: float, priority: float) -> OptimizationPointObjective: - """ - Args: - structure: The target structure of the objective. - objectiveOperator: The type of the dose-volume objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - volume: The volume of the objective. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) for a proton plan or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. - def AddProtonNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization objective. - def RemoveObjective(self, objective: OptimizationObjective) -> None: - """ - Args: - objective: The objective that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization parameter. - def RemoveParameter(self, parameter: OptimizationParameter) -> None: - """ - Args: - parameter: The parameter that is removed. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. - def AddAutomaticNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic SBRT normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. - def AddAutomaticSbrtNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the NTO in relation to other optimization objectives. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new beam-specific parameter for IMRT optimization. - def AddBeamSpecificParameter(self, beam: Beam, smoothX: float, smoothY: float, fixedJaws: bool) -> OptimizationIMRTBeamParameter: - """ - Args: - beam: The beam for which the parameters are added. - smoothX: A fluence-smoothing parameter in X-direction. - smoothY: A fluence-smoothing parameter in Y-direction. - fixedJaws: If true, the collimator jaw positions of the beam remain the same during the optimization. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new gEUD objective. - def AddEUDObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, parameterA: float, priority: float) -> OptimizationEUDObjective: - """ - Args: - structure: The target structure of the objective. - objectiveOperator: The type of the gEUD objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - parameterA: gEUD parameter a. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new mean dose objective. - def AddMeanDoseObjective(self, structure: Structure, dose: DoseValue, priority: float) -> OptimizationMeanDoseObjective: - """ - Args: - structure: The target structure of the objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. - def AddNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float, fallOff: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - fallOff: Determines the steepness of the normal tissue objective fall-off. The value is positive. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new point objective. - def AddPointObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, volume: float, priority: float) -> OptimizationPointObjective: - """ - Args: - structure: The target structure of the objective. - objectiveOperator: The type of the dose-volume objective. - dose: The dose value of the objective. The unit must be the same as defined in the system configuration. - volume: The volume of the objective. - priority: The priority of the objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) for a proton plan or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously. - def AddProtonNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float) -> OptimizationNormalTissueParameter: - """ - Args: - priority: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - distanceFromTargetBorderInMM: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - startDosePercentage: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - endDosePercentage: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization objective. - def RemoveObjective(self, objective: OptimizationObjective) -> None: - """ - Args: - objective: The objective that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization parameter. - def RemoveParameter(self, parameter: OptimizationParameter) -> None: - """ - Args: - parameter: The parameter that is removed. - """ - ... - - - -class CalculationResult: - """ - Holds the result of the calculation (pass/fail). - - Attributes: - Success (bool): Returns true if calculation did not return any errors. Otherwise returns false. - Success (bool): Returns true if calculation did not return any errors. Otherwise returns false. - """ - def __init__(self) -> None: ... - - Success: bool - - Success: bool - - -class OptimizerResult: - """ - Holds the result of the optimization (pass/fail). - - Attributes: - StructureDVHs (List[OptimizerDVH]): A list of Dose Volume Histogram (DVH) curves for structures. - StructureObjectiveValues (List[OptimizerObjectiveValue]): The list of objective function values per structure. - TotalObjectiveFunctionValue (float): The total objective function value for the optimization. - NumberOfIMRTOptimizerIterations (int): The number of iterations taken by the IMRT optimizer. - StructureDVHs (List[OptimizerDVH]): A list of Dose Volume Histogram (DVH) curves for structures. - StructureObjectiveValues (List[OptimizerObjectiveValue]): The list of objective function values per structure. - TotalObjectiveFunctionValue (float): The total objective function value for the optimization. - NumberOfIMRTOptimizerIterations (int): The number of iterations taken by the IMRT optimizer. - """ - def __init__(self) -> None: ... - - StructureDVHs: List[OptimizerDVH] - - StructureObjectiveValues: List[OptimizerObjectiveValue] - - TotalObjectiveFunctionValue: float - - NumberOfIMRTOptimizerIterations: int - - StructureDVHs: List[OptimizerDVH] - - StructureObjectiveValues: List[OptimizerObjectiveValue] - - TotalObjectiveFunctionValue: float - - NumberOfIMRTOptimizerIterations: int - - -class PlanSetup: - """ - Represents a treatment plan. See the definition of a DICOM RT Plan for more information. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSetup. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Plan. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Plan. - PlanNormalizationValue (float): [Availability of this property depends on your Eclipse Scripting API license] The plan normalization value in percentage. The plan is normalized according to the plan normalization value, for instance, 200%. The value is Double.NaN if it is not defined. - PlanUncertainties (List[PlanUncertainty]): Plan uncertainties defined for the plan. - PlanObjectiveStructures (List[str]): The list of structure IDs that are present in the plan objectives (prescriptions and indices). - ApprovalHistory (List[ApprovalHistoryEntry]): Returns the approval history of the plan setup. - DosePerFractionInPrimaryRefPoint (DoseValue): The calculated fraction dose in the primary reference point. - PrescribedDosePerFraction (DoseValue): The prescribed fraction dose. - PrescribedPercentage (float): The prescribed dose percentage as a decimal number. For example, if the prescribed dose percentage shown in the Eclipse user interface is 80 %, returns 0.8 - TotalPrescribedDose (DoseValue): The total prescribed dose. - ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the plan. - ApprovalStatus (PlanSetupApprovalStatus): The approval status. - ApprovalStatusAsString (str): Returns the approval status as a string (localized). - BaseDosePlanningItem (PlanningItem): BaseDose for the optimization, can be either plan or plan sum. - Beams (List[Beam]): A collection of all the beams in the plan (including setup beams). Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. - BeamsInTreatmentOrder (List[Beam]): A collection of all the beams in the plan (including setup beams) in treatment order. Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. - CreationUserName (str): The name of the user who saved the plan for the first time. - DosePerFraction (DoseValue): The dose per fraction. - DVHEstimates (List[EstimatedDVH]): Returns a list of DVH estimate objects for this plan - ElectronCalculationModel (str): The name of the electron calculation model. Not applicable to brachytherapy plans. - ElectronCalculationOptions (Dict[str, str]): The electron calculation options. Not applicable to brachytherapy plans. - IntegrityHash (str): Returns the plan's integrity hash. Returns null if the plan's integrity hash has not been set. - IsDoseValid (bool): Returns the value true if the plan dose is valid. This implies that the dose object returned from the dose property is not null and can therefore be used to query dose values. - IsTreated (bool): Checks if the treatment plan has been delivered. - NumberOfFractions (Optional[int]): The number of fractions. - OptimizationSetup (OptimizationSetup): Provides access to optimization objectives and parameters. - PatientSupportDevice (PatientSupportDevice): Patient support device. - PhotonCalculationModel (str): The name of the photon calculation model. Not applicable to brachytherapy plans. - PhotonCalculationOptions (Dict[str, str]): The photon calculation options. Not applicable to brachytherapy plans. - PlanIntent (str): The plan intent as in DICOM, or an empty string. The defined terms are "CURATIVE", "PALLIATIVE", "PROPHYLACTIC", "VERIFICATION", "MACHINE_QA", "RESEARCH" and "SERVICE", but the value can be different for imported plans. - PlanIsInTreatment (bool): Checks if plan is loaded into console. - PlannedDosePerFraction (DoseValue): The calculated fraction dose in the primary reference point. - PlanningApprovalDate (str): The date when the plan was approved for planning. - PlanningApprover (str): The identifier of the user who approved the plan for planning. - PlanningApproverDisplayName (str): The display name of the user who approved the plan for planning. - PlanNormalizationMethod (str): The user interface name for the current normalization method. - PlanNormalizationPoint (VVector): The plan normalization point. - PlanType (PlanType): The plan type. - PredecessorPlan (PlanSetup): The prior revision of the plan - PredecessorPlanUID (str): The UID of the predecessor plan. - PrimaryReferencePoint (ReferencePoint): The primary reference point. - ProtocolID (str): The protocol identifier. - ProtocolPhaseID (str): The protocol phase identifier. - ProtonCalculationModel (str): The name of the proton calculation model. Not applicable to brachytherapy plans. - ProtonCalculationOptions (Dict[str, str]): The proton calculation options. Not applicable to brachytherapy plans. - ReferencePoints (List[ReferencePoint]): Collection of reference points in the plan. - RTPrescription (RTPrescription): Used for navigating to the linked prescription. - Series (Series): The series that contains this plan. Null if the plan is not connected to a series. - SeriesUID (str): The DICOM UID of the series that contains this plan. Empty string if the plan is not connected to a series. - TargetVolumeID (str): The target volume identifier. - TotalDose (DoseValue): Planned total dose. - TreatmentApprovalDate (str): The date when the plan was approved for treatment. - TreatmentApprover (str): The identifier of the user who approved the plan for treatment. - TreatmentApproverDisplayName (str): The display name of the user who approved the plan for treatment. - TreatmentOrientation (PatientOrientation): The orientation of the treatment. - TreatmentOrientationAsString (str): The orientation of the treatment as a string (localized). - TreatmentPercentage (float): The treatment percentage as a decimal number. For example, if the treatment percentage shown in the Eclipse user interface is 80%, returns 0.8. - TreatmentSessions (List[PlanTreatmentSession]): Treatment sessions for the plan, either scheduled sessions or treated sessions. - UID (str): The DICOM UID of the plan. - UseGating (bool): Boolean to mark if gating is used in the plan. - VerifiedPlan (PlanSetup): Returns the verified plan if this is a verification plan, otherwise returns null. The verified plan is the clinical plan that was used to create the verification plan. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSetup. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Plan. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Plan. - PlanNormalizationValue (float): [Availability of this property depends on your Eclipse Scripting API license] The plan normalization value in percentage. The plan is normalized according to the plan normalization value, for instance, 200%. The value is Double.NaN if it is not defined. - PlanUncertainties (List[PlanUncertainty]): Plan uncertainties defined for the plan. - PlanObjectiveStructures (List[str]): The list of structure IDs that are present in the plan objectives (prescriptions and indices). - ApprovalHistory (List[ApprovalHistoryEntry]): Returns the approval history of the plan setup. - DosePerFractionInPrimaryRefPoint (DoseValue): The calculated fraction dose in the primary reference point. - PrescribedDosePerFraction (DoseValue): The prescribed fraction dose. - PrescribedPercentage (float): The prescribed dose percentage as a decimal number. For example, if the prescribed dose percentage shown in the Eclipse user interface is 80 %, returns 0.8 - TotalPrescribedDose (DoseValue): The total prescribed dose. - ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the plan. - ApprovalStatus (PlanSetupApprovalStatus): The approval status. - ApprovalStatusAsString (str): Returns the approval status as a string (localized). - BaseDosePlanningItem (PlanningItem): BaseDose for the optimization, can be either plan or plan sum. - Beams (List[Beam]): A collection of all the beams in the plan (including setup beams). Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. - BeamsInTreatmentOrder (List[Beam]): A collection of all the beams in the plan (including setup beams) in treatment order. Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan. - CreationUserName (str): The name of the user who saved the plan for the first time. - DosePerFraction (DoseValue): The dose per fraction. - DVHEstimates (List[EstimatedDVH]): Returns a list of DVH estimate objects for this plan - ElectronCalculationModel (str): The name of the electron calculation model. Not applicable to brachytherapy plans. - ElectronCalculationOptions (Dict[str, str]): The electron calculation options. Not applicable to brachytherapy plans. - IntegrityHash (str): Returns the plan's integrity hash. Returns null if the plan's integrity hash has not been set. - IsDoseValid (bool): Returns the value true if the plan dose is valid. This implies that the dose object returned from the dose property is not null and can therefore be used to query dose values. - IsTreated (bool): Checks if the treatment plan has been delivered. - NumberOfFractions (Optional[int]): The number of fractions. - OptimizationSetup (OptimizationSetup): Provides access to optimization objectives and parameters. - PatientSupportDevice (PatientSupportDevice): Patient support device. - PhotonCalculationModel (str): The name of the photon calculation model. Not applicable to brachytherapy plans. - PhotonCalculationOptions (Dict[str, str]): The photon calculation options. Not applicable to brachytherapy plans. - PlanIntent (str): The plan intent as in DICOM, or an empty string. The defined terms are "CURATIVE", "PALLIATIVE", "PROPHYLACTIC", "VERIFICATION", "MACHINE_QA", "RESEARCH" and "SERVICE", but the value can be different for imported plans. - PlanIsInTreatment (bool): Checks if plan is loaded into console. - PlannedDosePerFraction (DoseValue): The calculated fraction dose in the primary reference point. - PlanningApprovalDate (str): The date when the plan was approved for planning. - PlanningApprover (str): The identifier of the user who approved the plan for planning. - PlanningApproverDisplayName (str): The display name of the user who approved the plan for planning. - PlanNormalizationMethod (str): The user interface name for the current normalization method. - PlanNormalizationPoint (VVector): The plan normalization point. - PlanType (PlanType): The plan type. - PredecessorPlan (PlanSetup): The prior revision of the plan - PredecessorPlanUID (str): The UID of the predecessor plan. - PrimaryReferencePoint (ReferencePoint): The primary reference point. - ProtocolID (str): The protocol identifier. - ProtocolPhaseID (str): The protocol phase identifier. - ProtonCalculationModel (str): The name of the proton calculation model. Not applicable to brachytherapy plans. - ProtonCalculationOptions (Dict[str, str]): The proton calculation options. Not applicable to brachytherapy plans. - ReferencePoints (List[ReferencePoint]): Collection of reference points in the plan. - RTPrescription (RTPrescription): Used for navigating to the linked prescription. - Series (Series): The series that contains this plan. Null if the plan is not connected to a series. - SeriesUID (str): The DICOM UID of the series that contains this plan. Empty string if the plan is not connected to a series. - TargetVolumeID (str): The target volume identifier. - TotalDose (DoseValue): Planned total dose. - TreatmentApprovalDate (str): The date when the plan was approved for treatment. - TreatmentApprover (str): The identifier of the user who approved the plan for treatment. - TreatmentApproverDisplayName (str): The display name of the user who approved the plan for treatment. - TreatmentOrientation (PatientOrientation): The orientation of the treatment. - TreatmentOrientationAsString (str): The orientation of the treatment as a string (localized). - TreatmentPercentage (float): The treatment percentage as a decimal number. For example, if the treatment percentage shown in the Eclipse user interface is 80%, returns 0.8. - TreatmentSessions (List[PlanTreatmentSession]): Treatment sessions for the plan, either scheduled sessions or treated sessions. - UID (str): The DICOM UID of the plan. - UseGating (bool): Boolean to mark if gating is used in the plan. - VerifiedPlan (PlanSetup): Returns the verified plan if this is a verification plan, otherwise returns null. The verified plan is the clinical plan that was used to create the verification plan. - """ - def __init__(self) -> None: ... - - Id: str - - Name: str - - Comment: str - - PlanNormalizationValue: float - - PlanUncertainties: List[PlanUncertainty] - - PlanObjectiveStructures: List[str] - - ApprovalHistory: List[ApprovalHistoryEntry] - - DosePerFractionInPrimaryRefPoint: DoseValue - - PrescribedDosePerFraction: DoseValue - - PrescribedPercentage: float - - TotalPrescribedDose: DoseValue - - ApplicationScriptLogs: List[ApplicationScriptLog] - - ApprovalStatus: PlanSetupApprovalStatus - - ApprovalStatusAsString: str - - BaseDosePlanningItem: PlanningItem - - Beams: List[Beam] - - BeamsInTreatmentOrder: List[Beam] - - CreationUserName: str - - DosePerFraction: DoseValue - - DVHEstimates: List[EstimatedDVH] - - ElectronCalculationModel: str - - ElectronCalculationOptions: Dict[str, str] - - IntegrityHash: str - - IsDoseValid: bool - - IsTreated: bool - - NumberOfFractions: Optional[int] - - OptimizationSetup: OptimizationSetup - - PatientSupportDevice: PatientSupportDevice - - PhotonCalculationModel: str - - PhotonCalculationOptions: Dict[str, str] - - PlanIntent: str - - PlanIsInTreatment: bool - - PlannedDosePerFraction: DoseValue - - PlanningApprovalDate: str - - PlanningApprover: str - - PlanningApproverDisplayName: str - - PlanNormalizationMethod: str - - PlanNormalizationPoint: VVector - - PlanType: PlanType - - PredecessorPlan: PlanSetup - - PredecessorPlanUID: str - - PrimaryReferencePoint: ReferencePoint - - ProtocolID: str - - ProtocolPhaseID: str - - ProtonCalculationModel: str - - ProtonCalculationOptions: Dict[str, str] - - ReferencePoints: List[ReferencePoint] - - RTPrescription: RTPrescription - - Series: Series - - SeriesUID: str - - TargetVolumeID: str - - TotalDose: DoseValue - - TreatmentApprovalDate: str - - TreatmentApprover: str - - TreatmentApproverDisplayName: str - - TreatmentOrientation: PatientOrientation - - TreatmentOrientationAsString: str - - TreatmentPercentage: float - - TreatmentSessions: List[PlanTreatmentSession] - - UID: str - - UseGating: bool - - VerifiedPlan: PlanSetup - - Id: str - - Name: str - - Comment: str - - PlanNormalizationValue: float - - PlanUncertainties: List[PlanUncertainty] - - PlanObjectiveStructures: List[str] - - ApprovalHistory: List[ApprovalHistoryEntry] - - DosePerFractionInPrimaryRefPoint: DoseValue - - PrescribedDosePerFraction: DoseValue - - PrescribedPercentage: float - - TotalPrescribedDose: DoseValue - - ApplicationScriptLogs: List[ApplicationScriptLog] - - ApprovalStatus: PlanSetupApprovalStatus - - ApprovalStatusAsString: str - - BaseDosePlanningItem: PlanningItem - - Beams: List[Beam] - - BeamsInTreatmentOrder: List[Beam] - - CreationUserName: str - - DosePerFraction: DoseValue - - DVHEstimates: List[EstimatedDVH] - - ElectronCalculationModel: str - - ElectronCalculationOptions: Dict[str, str] - - IntegrityHash: str - - IsDoseValid: bool - - IsTreated: bool - - NumberOfFractions: Optional[int] - - OptimizationSetup: OptimizationSetup - - PatientSupportDevice: PatientSupportDevice - - PhotonCalculationModel: str - - PhotonCalculationOptions: Dict[str, str] - - PlanIntent: str - - PlanIsInTreatment: bool - - PlannedDosePerFraction: DoseValue - - PlanningApprovalDate: str - - PlanningApprover: str - - PlanningApproverDisplayName: str - - PlanNormalizationMethod: str - - PlanNormalizationPoint: VVector - - PlanType: PlanType - - PredecessorPlan: PlanSetup - - PredecessorPlanUID: str - - PrimaryReferencePoint: ReferencePoint - - ProtocolID: str - - ProtocolPhaseID: str - - ProtonCalculationModel: str - - ProtonCalculationOptions: Dict[str, str] - - ReferencePoints: List[ReferencePoint] - - RTPrescription: RTPrescription - - Series: Series - - SeriesUID: str - - TargetVolumeID: str - - TotalDose: DoseValue - - TreatmentApprovalDate: str - - TreatmentApprover: str - - TreatmentApproverDisplayName: str - - TreatmentOrientation: PatientOrientation - - TreatmentOrientationAsString: str - - TreatmentPercentage: float - - TreatmentSessions: List[PlanTreatmentSession] - - UID: str - - UseGating: bool - - VerifiedPlan: PlanSetup - - # Gets the prescriptions and measures in the protocol that is associated with this plan setup. - def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List[ProtocolPhasePrescription], measures: List[ProtocolPhaseMeasure]) -> None: - """ - Args: - prescriptions: Returned list of prescriptions (plan objectives). - measures: Returned list of plan measures (quality indices). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. - def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: - """ - Args: - target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). - location: Reference point location in mm. - id: Reference point ID. - """ - ... - - - # Attaches event handling. - def AttachToCalcClient(self, doseCalcClient: ICalculationClient) -> Any: - ... - - - # Detaches event handling for the calculation client. - def DetachFromCalcClient(self, doseCalcClient: ICalculationClient) -> Any: - ... - - - # Reporting. - def Report(self, str: str) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimatesImpl(self, dvhCalculator: IPhotonCalculation, client: ICalculationClient, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str], license: LicenseId) -> Any: - """ - Args: - dvhCalculator: Interface for calculating the DVH estimates. - client: Calculation client. - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - license: License required for running the DVH estimation - """ - ... - - - # Check if plan approval status is valid. Note: Configured approval extensions are not executed. - def IsValidForPlanApproval(self, validationResults: List[PlanValidationResultEsapiDetail]) -> bool: - """ - Args: - validationResults: Validation results which contain detailed warning and error messages. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a new plan or field uncertainty with parameters. In case of field specific uncertainty, HUConversionError is overwritten to be always zero. Supported uncertainty types: RangeUncertainty, IsocenterShiftUncertainty, BaselineShiftUncertainty, RobustOptimizationUncertainty (=Perturbation). RangeUncertainty and RobustOptimizationUncertainty are proton specific. IsocenterShiftUncertainty and BaselineShiftUncertainty are photon specific. Field specific plan uncertainty dose can be used only for RobustOptimizationUncertainty. In case of BaselineShiftUncertainty isocenterShift parameter is actually target shift. - def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: - """ - Args: - uncertaintyType: Type of the plan uncertainty dose. - planSpecificUncertainty: The plan uncertainty dose is either plan specific (true) or field specific (false). - HUConversionError: Calibration curve error [%] - isocenterShift: Patient setup error [cm] - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the treatment order of the beams. - def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: - """ - Args: - orderedBeams: The beams in wanted order. All the beams of the plan must be present, otherwise the method fails. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. - def AddReferencePoint(self, refPoint: ReferencePoint) -> ReferencePoint: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Clears the calculation model for the given calculation type. - def ClearCalculationModel(self, calculationType: CalculationType) -> None: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Returns the selected calculation model for the given calculation type. Returns null if no model has been selected. - def GetCalculationModel(self, calculationType: CalculationType) -> str: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Gets the given calculation option value. - def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: - """ - Args: - calculationModel: The name of the calculation model. - optionName: The XPath or name of the option to set. - optionValue: The value of the given option. - """ - ... - - - # Gets all the calculation options and their values for the given calculation model. - def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: - """ - Args: - calculationModel: The name of the calculation model. - """ - ... - - - # Retrieves the name of DVH Estimation Model. - def GetDvhEstimationModelName(self) -> str: - ... - - - # Checks the limits of the current calculation area. - def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Moves the plan setup from its current course to the destination course, maintaining the plan UID. - def MoveToCourse(self, destinationCourse: Course) -> None: - """ - Args: - destinationCourse: The destination course for the plan setup. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove provided reference point from plan - def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to remove. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the calculation model for the given calculation type. - def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: - """ - Args: - calculationType: The type of calculation. - model: The name of the calculation model. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the given calculation option to the given value. Before setting the options for the model, set the calculation model. See - def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: - """ - Args: - calculationModel: The name of the calculation model. - optionName: The XPath or name of the option to set. If this is not an XPath, the method sets the first attribute that matches the name. Example 1: CalculationGridSizeInCM in the Anisotropic Analytical Algorithm (AAA) sets the option /AAACalculationOptions/@CalculationGridSizeInCM. Example 2: MaximalDrillDepthInCM in the Proton Convolution Superposition (PCS) algorithm sets the option /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling1/@MaximalDrillDepthInCM. To set the values, for example, for the Drilling2 settings, you have to specify the entire XPath /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling2/@MaximalDrillDepthInCM. - optionValue: The value to set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets and validates the number of fractions and dose per fraction. - def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: - """ - Args: - numberOfFractions: The number of fractions. - dosePerFraction: The dose per fraction. - treatmentPercentage: The treatment percentage as a decimal number. For example, if the treatment percentage shown in the user interface is 80%, use 0.8. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets or changes target structure if valid dose is not affected by the change. - def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: Text.StringBuilder) -> bool: - """ - Args: - newTargetStructure: New target structure. - errorHint: Holder for error message. - """ - ... - - - # Gets the prescriptions and measures in the protocol that is associated with this plan setup. - def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List[ProtocolPhasePrescription], measures: List[ProtocolPhaseMeasure]) -> None: - """ - Args: - prescriptions: Returned list of prescriptions (plan objectives). - measures: Returned list of plan measures (quality indices). - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. - def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: - """ - Args: - target: Indicates whether the reference point tracks treatment target (true) or organ at risk (false). - location: Reference point location in mm. - id: Reference point ID. - """ - ... - - - # Attaches event handling. - def AttachToCalcClient(self, doseCalcClient: ICalculationClient) -> Any: - ... - - - # Detaches event handling for the calculation client. - def DetachFromCalcClient(self, doseCalcClient: ICalculationClient) -> Any: - ... - - - # Reporting. - def Report(self, str: str) -> Any: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan. - def CalculateDVHEstimatesImpl(self, dvhCalculator: IPhotonCalculation, client: ICalculationClient, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str], license: LicenseId) -> Any: - """ - Args: - dvhCalculator: Interface for calculating the DVH estimates. - client: Calculation client. - modelId: DVH estimation model ID. - targetDoseLevels: Dose levels for the target structures. - structureMatches: Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary). - license: License required for running the DVH estimation - """ - ... - - - # Check if plan approval status is valid. Note: Configured approval extensions are not executed. - def IsValidForPlanApproval(self, validationResults: List[PlanValidationResultEsapiDetail]) -> bool: - """ - Args: - validationResults: Validation results which contain detailed warning and error messages. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a new plan or field uncertainty with parameters. In case of field specific uncertainty, HUConversionError is overwritten to be always zero. Supported uncertainty types: RangeUncertainty, IsocenterShiftUncertainty, BaselineShiftUncertainty, RobustOptimizationUncertainty (=Perturbation). RangeUncertainty and RobustOptimizationUncertainty are proton specific. IsocenterShiftUncertainty and BaselineShiftUncertainty are photon specific. Field specific plan uncertainty dose can be used only for RobustOptimizationUncertainty. In case of BaselineShiftUncertainty isocenterShift parameter is actually target shift. - def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: - """ - Args: - uncertaintyType: Type of the plan uncertainty dose. - planSpecificUncertainty: The plan uncertainty dose is either plan specific (true) or field specific (false). - HUConversionError: Calibration curve error [%] - isocenterShift: Patient setup error [cm] - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the treatment order of the beams. - def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: - """ - Args: - orderedBeams: The beams in wanted order. All the beams of the plan must be present, otherwise the method fails. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point and links it to the plan. - def AddReferencePoint(self, refPoint: ReferencePoint) -> ReferencePoint: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Clears the calculation model for the given calculation type. - def ClearCalculationModel(self, calculationType: CalculationType) -> None: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Returns the selected calculation model for the given calculation type. Returns null if no model has been selected. - def GetCalculationModel(self, calculationType: CalculationType) -> str: - """ - Args: - calculationType: The type of calculation. - """ - ... - - - # Gets the given calculation option value. - def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: - """ - Args: - calculationModel: The name of the calculation model. - optionName: The XPath or name of the option to set. - optionValue: The value of the given option. - """ - ... - - - # Gets all the calculation options and their values for the given calculation model. - def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: - """ - Args: - calculationModel: The name of the calculation model. - """ - ... - - - # Retrieves the name of DVH Estimation Model. - def GetDvhEstimationModelName(self) -> str: - ... - - - # Checks the limits of the current calculation area. - def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Moves the plan setup from its current course to the destination course, maintaining the plan UID. - def MoveToCourse(self, destinationCourse: Course) -> None: - """ - Args: - destinationCourse: The destination course for the plan setup. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove provided reference point from plan - def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: - """ - Args: - refPoint: Reference point to remove. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the calculation model for the given calculation type. - def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: - """ - Args: - calculationType: The type of calculation. - model: The name of the calculation model. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the given calculation option to the given value. Before setting the options for the model, set the calculation model. See - def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: - """ - Args: - calculationModel: The name of the calculation model. - optionName: The XPath or name of the option to set. If this is not an XPath, the method sets the first attribute that matches the name. Example 1: CalculationGridSizeInCM in the Anisotropic Analytical Algorithm (AAA) sets the option /AAACalculationOptions/@CalculationGridSizeInCM. Example 2: MaximalDrillDepthInCM in the Proton Convolution Superposition (PCS) algorithm sets the option /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling1/@MaximalDrillDepthInCM. To set the values, for example, for the Drilling2 settings, you have to specify the entire XPath /ProtonCalculationOptions/ScatteringUniformScanning/CompensatorConversion/Drilling2/@MaximalDrillDepthInCM. - optionValue: The value to set. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets and validates the number of fractions and dose per fraction. - def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: - """ - Args: - numberOfFractions: The number of fractions. - dosePerFraction: The dose per fraction. - treatmentPercentage: The treatment percentage as a decimal number. For example, if the treatment percentage shown in the user interface is 80%, use 0.8. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets or changes target structure if valid dose is not affected by the change. - def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: Text.StringBuilder) -> bool: - """ - Args: - newTargetStructure: New target structure. - errorHint: Holder for error message. - """ - ... - - - -class ProtocolPhaseMeasure: - """ - Represents the plan measures (quality indices) of the clinical protocol. - - Attributes: - TargetValue (float): The target value of this plan measure. - ActualValue (float): The calculated actual value of this plan measure. - TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. - Modifier (MeasureModifier): Measure Modifier. - StructureId (str): ID of the structure to which this measure is applied. - Type (MeasureType): Measure Type. - TypeText (str): Measure type as text, for instance, 'Conformity Index' in 'Conformity Index is more than 10.0'. - TargetValue (float): The target value of this plan measure. - ActualValue (float): The calculated actual value of this plan measure. - TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. - Modifier (MeasureModifier): Measure Modifier. - StructureId (str): ID of the structure to which this measure is applied. - Type (MeasureType): Measure Type. - TypeText (str): Measure type as text, for instance, 'Conformity Index' in 'Conformity Index is more than 10.0'. - """ - def __init__(self) -> None: ... - - TargetValue: float - - ActualValue: float - - TargetIsMet: Optional[bool] - - Modifier: MeasureModifier - - StructureId: str - - Type: MeasureType - - TypeText: str - - TargetValue: float - - ActualValue: float - - TargetIsMet: Optional[bool] - - Modifier: MeasureModifier - - StructureId: str - - Type: MeasureType - - TypeText: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ProtocolPhasePrescription: - """ - Represents the prescriptions (plan objectives) of the clinical protocol. - - Attributes: - TargetTotalDose (DoseValue): Total dose in absolute units specified for this prescription. - TargetFractionDose (DoseValue): Fraction dose in absolute units specified for this prescription. - ActualTotalDose (DoseValue): Actual total dose for this prescription - TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. - PrescModifier (PrescriptionModifier): Prescription Modifier. - PrescParameter (float): Value of the prescription parameter, for instance, '80' in 'At least 80% receives more than 2 Gy'. - PrescType (PrescriptionType): Prescription Type. - StructureId (str): ID of structure to which this prescription is applied. - TargetTotalDose (DoseValue): Total dose in absolute units specified for this prescription. - TargetFractionDose (DoseValue): Fraction dose in absolute units specified for this prescription. - ActualTotalDose (DoseValue): Actual total dose for this prescription - TargetIsMet (Optional[bool]): Indicates whether the target is met. If this cannot be evaluated, the value is null. - PrescModifier (PrescriptionModifier): Prescription Modifier. - PrescParameter (float): Value of the prescription parameter, for instance, '80' in 'At least 80% receives more than 2 Gy'. - PrescType (PrescriptionType): Prescription Type. - StructureId (str): ID of structure to which this prescription is applied. - """ - def __init__(self) -> None: ... - - TargetTotalDose: DoseValue - - TargetFractionDose: DoseValue - - ActualTotalDose: DoseValue - - TargetIsMet: Optional[bool] - - PrescModifier: PrescriptionModifier - - PrescParameter: float - - PrescType: PrescriptionType - - StructureId: str - - TargetTotalDose: DoseValue - - TargetFractionDose: DoseValue - - ActualTotalDose: DoseValue - - TargetIsMet: Optional[bool] - - PrescModifier: PrescriptionModifier - - PrescParameter: float - - PrescType: PrescriptionType - - StructureId: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ScriptEnvironment: - """ - Contains the runtime information of the application environment for the script. - - Attributes: - ApplicationName (str): The name of the active application. - VersionInfo (str): The version number of Eclipse. - ApiVersionInfo (str): The version number of Eclipse Scripting API. - Scripts (List[ApplicationScript]): Retrieves a list of all scripts known by the application. - Packages (List[ApplicationPackage]): Retrieves a list of all packages known by the application. - ApplicationName (str): The name of the active application. - VersionInfo (str): The version number of Eclipse. - ApiVersionInfo (str): The version number of Eclipse Scripting API. - Scripts (List[ApplicationScript]): Retrieves a list of all scripts known by the application. - Packages (List[ApplicationPackage]): Retrieves a list of all packages known by the application. - """ - # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. - @overload - def __init__(self, appName: str, scripts: List[IApplicationScript], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: - """ - Args: - appName: The application name. - scripts: A list of all scripts known by the application. - scriptExecutionEngine: The execution engine for executing a script from another script. - """ - ... - - - # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. - @overload - def __init__(self, appName: str, scripts: List[IApplicationScript], packages: List[IApplicationPackage], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: - """ - Args: - appName: The application name. - scripts: A list of all scripts known by the application. - packages: A list of all packages known by the application. - scriptExecutionEngine: The execution engine for executing a script from another script. - """ - ... - - - # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. - @overload - def __init__(self, appName: str, scripts: List[IApplicationScript], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: - """ - Args: - appName: The application name. - scripts: A list of all scripts known by the application. - scriptExecutionEngine: The execution engine for executing a script from another script. - """ - ... - - - # Provides scripts access to the application environment. A ScriptEnvironment instance is given as an optional parameter in the Execute function of the script. The script itself does not instantiate the ScriptEnvironment. - @overload - def __init__(self, appName: str, scripts: List[IApplicationScript], packages: List[IApplicationPackage], scriptExecutionEngine: Action[Reflection.Assembly, Any, Windows.Window, Any]) -> None: - """ - Args: - appName: The application name. - scripts: A list of all scripts known by the application. - packages: A list of all packages known by the application. - scriptExecutionEngine: The execution engine for executing a script from another script. - """ - ... - - - ApplicationName: str - - VersionInfo: str - - ApiVersionInfo: str - - Scripts: List[ApplicationScript] - - Packages: List[ApplicationPackage] - - ApplicationName: str - - VersionInfo: str - - ApiVersionInfo: str - - Scripts: List[ApplicationScript] - - Packages: List[ApplicationPackage] - - # Executes an other script from script. This allows a script to be used for launching other scripts. Without using this special method, the system would be unaware of the other script, and thus could not save the correct script logs. - def ExecuteScript(self, scriptAssembly: Reflection.Assembly, scriptContext: ScriptContext, window: Windows.Window) -> None: - """ - Args: - scriptAssembly: The other script assembly. The assembly must have a location. - scriptContext: The script context that was passed to the executing script. - window: The script window. This is an optional parameter, can be null. - """ - ... - - - # Executes an other script from script. This allows a script to be used for launching other scripts. Without using this special method, the system would be unaware of the other script, and thus could not save the correct script logs. - def ExecuteScript(self, scriptAssembly: Reflection.Assembly, scriptContext: ScriptContext, window: Windows.Window) -> None: - """ - Args: - scriptAssembly: The other script assembly. The assembly must have a location. - scriptContext: The script context that was passed to the executing script. - window: The script window. This is an optional parameter, can be null. - """ - ... - - - -class Structure: - """ - A structure is a geometrical representation of an anatomical organ, a treatment volume, a marker, or a support structure. See the definition of a DICOM Structure for more information. - - Attributes: - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Structure. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Structure. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Structure. - ApprovalHistory (List[StructureApprovalHistoryEntry]): Returns the approval history of the structure. - CenterPoint (VVector): The center point of the structure. - Color (Windows.Media.Color): The color of the structure. - DicomType (str): The DICOM type of the structure, for example, PTV, MARKER, or ORGAN. - HasCalculatedPlans (bool): Checks if a calculated plan exists for the structure - HasSegment (bool): Checks if the structure has a segment. - IsApproved (bool): Checks if the structure is approved - IsEmpty (bool): Checks if the structure is empty. - IsHighResolution (bool): true if this structure is a high-resolution structure. Otherwise false. - IsTarget (bool): Checks if the structure is PTV, CTV or GTV - MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The mesh geometry. - ROINumber (int): The DICOM ROI Number of the structure. - SegmentVolume (SegmentVolume): Provides access to the segment volume of the structure. - StructureCode (StructureCode): The structure code that identifies this structure. - StructureCodeInfos (List[StructureCodeInfo]): Property value. - Volume (float): The calculated volume. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Structure. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the Structure. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the Structure. - ApprovalHistory (List[StructureApprovalHistoryEntry]): Returns the approval history of the structure. - CenterPoint (VVector): The center point of the structure. - Color (Windows.Media.Color): The color of the structure. - DicomType (str): The DICOM type of the structure, for example, PTV, MARKER, or ORGAN. - HasCalculatedPlans (bool): Checks if a calculated plan exists for the structure - HasSegment (bool): Checks if the structure has a segment. - IsApproved (bool): Checks if the structure is approved - IsEmpty (bool): Checks if the structure is empty. - IsHighResolution (bool): true if this structure is a high-resolution structure. Otherwise false. - IsTarget (bool): Checks if the structure is PTV, CTV or GTV - MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The mesh geometry. - ROINumber (int): The DICOM ROI Number of the structure. - SegmentVolume (SegmentVolume): Provides access to the segment volume of the structure. - StructureCode (StructureCode): The structure code that identifies this structure. - StructureCodeInfos (List[StructureCodeInfo]): Property value. - Volume (float): The calculated volume. - """ - def __init__(self) -> None: ... - - Id: str - - Name: str - - Comment: str - - ApprovalHistory: List[StructureApprovalHistoryEntry] - - CenterPoint: VVector - - Color: Windows.Media.Color - - DicomType: str - - HasCalculatedPlans: bool - - HasSegment: bool - - IsApproved: bool - - IsEmpty: bool - - IsHighResolution: bool - - IsTarget: bool - - MeshGeometry: Windows.Media.Media3D.MeshGeometry3D - - ROINumber: int - - SegmentVolume: SegmentVolume - - StructureCode: StructureCode - - StructureCodeInfos: List[StructureCodeInfo] - - Volume: float - - Id: str - - Name: str - - Comment: str - - ApprovalHistory: List[StructureApprovalHistoryEntry] - - CenterPoint: VVector - - Color: Windows.Media.Color - - DicomType: str - - HasCalculatedPlans: bool - - HasSegment: bool - - IsApproved: bool - - IsEmpty: bool - - IsHighResolution: bool - - IsTarget: bool - - MeshGeometry: Windows.Media.Media3D.MeshGeometry3D - - ROINumber: int - - SegmentVolume: SegmentVolume - - StructureCode: StructureCode - - StructureCodeInfos: List[StructureCodeInfo] - - Volume: float - - # An implicit conversion from Structure to SegmentVolume makes it easier to use the SegmentVolume functionality, such as the boolean operators and margin. - def op_Implicit(self, structure: SegmentVolume) -> SegmentVolume: - """ - Args: - structure: The converted structure. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds the given contour to the given image plane. - def AddContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: - """ - Args: - contour: The contour points, z coordinates are ignored. - z: A zero-based image plane index. - """ - ... - - - # Boolean And operation for structures that have a segment model. Provided here for convenience. - def And(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this segment volume. - """ - ... - - - # Asymmetric margin operation for structures that have a segment model. Provided here for convenience. - def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: - """ - Args: - margins: The margins aligned to the axes of the image coordinate system, in millimeters. The maximum is 50. - """ - ... - - - # Returns true if this structure can be converted to a high-resolution structure. - def CanConvertToHighResolution(self) -> bool: - ... - - - # Checks if the segment volume of the structure can be edited. - def CanEditSegmentVolume(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If the segment volume cannot be edited, contains the error message. - """ - ... - - - # Checks if the HU value of the structure can be modified. - def CanSetAssignedHU(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If the HU value cannot be set, contains the error message. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Clears the contours on the given image plane. - def ClearAllContoursOnImagePlane(self, z: int) -> None: - """ - Args: - z: A zero-based image plane index. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a structure out of an isodose level. - def ConvertDoseLevelToStructure(self, dose: Dose, doseLevel: DoseValue) -> None: - """ - Args: - dose: The dose from which the dose level is extracted. - doseLevel: The dose level. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Converts this structure to a high-resolution structure. Increases the resolution of the segment volume in cases where the image size is larger than 256x256 voxels. - def ConvertToHighResolution(self) -> None: - ... - - - # Returns the HU value of the material. - def GetAssignedHU(self, huValue: float) -> bool: - """ - Args: - huValue: Double value that will contain the HU value upon return from this method - """ - ... - - - # If the structure has a segment, gets the contours of the structure on the given image plane. - def GetContoursOnImagePlane(self, z: int) -> Array[Array[VVector]]: - """ - Args: - z: Zero based image plane index. - """ - ... - - - # If the structure has a segment, returns the number of separate parts. - def GetNumberOfSeparateParts(self) -> int: - ... - - - # If the structure is a reference line, gets its points. - def GetReferenceLinePoints(self) -> Array[VVector]: - ... - - - # If the structure has a segment, gets the segment profile. - def GetSegmentProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Collections.BitArray) -> SegmentProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # If the structure has a segment, checks if the given point lies within the structure. - def IsPointInsideSegment(self, point: VVector) -> bool: - """ - Args: - point: Location of the point. - """ - ... - - - # Margin operation for structures that have a segment model. Provided here for convenience. - def Margin(self, marginInMM: float) -> SegmentVolume: - """ - Args: - marginInMM: The used margin in millimeters. The maximum is 50. - """ - ... - - - # Boolean Not operation for structures that have a segment model. Provided here for convenience. - def Not(self) -> SegmentVolume: - ... - - - # Boolean Or operation for structures that have a segment model. Provided here for convenience. - def Or(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Resets the HU value of the material to "undefined". - def ResetAssignedHU(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the HU value of the material. - def SetAssignedHU(self, huValue: float) -> None: - """ - Args: - huValue: A double value that contains the HU value to be set. - """ - ... - - - # Boolean Sub operation for structures that have a segment model. Provided here for convenience. - def Sub(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is subtracted from this segment volume. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Subtracts the given contour from the given image plane. - def SubtractContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: - """ - Args: - contour: The contour points, z coordinates are ignored. - z: A zero-based image plane index. - """ - ... - - - # Boolean Xor operation for structures that have a segment model. Provided here for convenience. - def Xor(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # An implicit conversion from Structure to SegmentVolume makes it easier to use the SegmentVolume functionality, such as the boolean operators and margin. - def op_Implicit(self, structure: SegmentVolume) -> SegmentVolume: - """ - Args: - structure: The converted structure. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds the given contour to the given image plane. - def AddContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: - """ - Args: - contour: The contour points, z coordinates are ignored. - z: A zero-based image plane index. - """ - ... - - - # Boolean And operation for structures that have a segment model. Provided here for convenience. - def And(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this segment volume. - """ - ... - - - # Asymmetric margin operation for structures that have a segment model. Provided here for convenience. - def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: - """ - Args: - margins: The margins aligned to the axes of the image coordinate system, in millimeters. The maximum is 50. - """ - ... - - - # Returns true if this structure can be converted to a high-resolution structure. - def CanConvertToHighResolution(self) -> bool: - ... - - - # Checks if the segment volume of the structure can be edited. - def CanEditSegmentVolume(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If the segment volume cannot be edited, contains the error message. - """ - ... - - - # Checks if the HU value of the structure can be modified. - def CanSetAssignedHU(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If the HU value cannot be set, contains the error message. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Clears the contours on the given image plane. - def ClearAllContoursOnImagePlane(self, z: int) -> None: - """ - Args: - z: A zero-based image plane index. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a structure out of an isodose level. - def ConvertDoseLevelToStructure(self, dose: Dose, doseLevel: DoseValue) -> None: - """ - Args: - dose: The dose from which the dose level is extracted. - doseLevel: The dose level. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Converts this structure to a high-resolution structure. Increases the resolution of the segment volume in cases where the image size is larger than 256x256 voxels. - def ConvertToHighResolution(self) -> None: - ... - - - # Returns the HU value of the material. - def GetAssignedHU(self, huValue: float) -> bool: - """ - Args: - huValue: Double value that will contain the HU value upon return from this method - """ - ... - - - # If the structure has a segment, gets the contours of the structure on the given image plane. - def GetContoursOnImagePlane(self, z: int) -> Array[Array[VVector]]: - """ - Args: - z: Zero based image plane index. - """ - ... - - - # If the structure has a segment, returns the number of separate parts. - def GetNumberOfSeparateParts(self) -> int: - ... - - - # If the structure is a reference line, gets its points. - def GetReferenceLinePoints(self) -> Array[VVector]: - ... - - - # If the structure has a segment, gets the segment profile. - def GetSegmentProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Collections.BitArray) -> SegmentProfile: - """ - Args: - start: Location of the first point of the profile. - stop: Location of the last point of the profile. - preallocatedBuffer: Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return. - """ - ... - - - # If the structure has a segment, checks if the given point lies within the structure. - def IsPointInsideSegment(self, point: VVector) -> bool: - """ - Args: - point: Location of the point. - """ - ... - - - # Margin operation for structures that have a segment model. Provided here for convenience. - def Margin(self, marginInMM: float) -> SegmentVolume: - """ - Args: - marginInMM: The used margin in millimeters. The maximum is 50. - """ - ... - - - # Boolean Not operation for structures that have a segment model. Provided here for convenience. - def Not(self) -> SegmentVolume: - ... - - - # Boolean Or operation for structures that have a segment model. Provided here for convenience. - def Or(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Resets the HU value of the material to "undefined". - def ResetAssignedHU(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the HU value of the material. - def SetAssignedHU(self, huValue: float) -> None: - """ - Args: - huValue: A double value that contains the HU value to be set. - """ - ... - - - # Boolean Sub operation for structures that have a segment model. Provided here for convenience. - def Sub(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is subtracted from this segment volume. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Subtracts the given contour from the given image plane. - def SubtractContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: - """ - Args: - contour: The contour points, z coordinates are ignored. - z: A zero-based image plane index. - """ - ... - - - # Boolean Xor operation for structures that have a segment model. Provided here for convenience. - def Xor(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - -class StructureSet: - """ - A structure set is a container for structures of a patient, including anatomical organs, treatment volumes and markers, and support structures. - - Attributes: - Structures (List[Structure]): Used for navigating to the child structures. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the structure set. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the structure set. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the structure set. - ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the structure set. - Image (Image): Used for navigating to the image. - Patient (Patient): Used for navigating to the patient. - Series (Series): The series that contains this plan. Null if the plan is not connected to a series. - SeriesUID (str): The DICOM UID of the series that contains this structure set. Empty string if the structure set is not connected to a series. - UID (str): DICOM UID. - Structures (List[Structure]): Used for navigating to the child structures. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the structure set. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the structure set. - Comment (str): [Availability of this property depends on your Eclipse Scripting API license] A comment about the structure set. - ApplicationScriptLogs (List[ApplicationScriptLog]): The log entries of the script executions that have modified the structure set. - Image (Image): Used for navigating to the image. - Patient (Patient): Used for navigating to the patient. - Series (Series): The series that contains this plan. Null if the plan is not connected to a series. - SeriesUID (str): The DICOM UID of the series that contains this structure set. Empty string if the structure set is not connected to a series. - UID (str): DICOM UID. - """ - def __init__(self) -> None: ... - - Structures: List[Structure] - - Id: str - - Name: str - - Comment: str - - ApplicationScriptLogs: List[ApplicationScriptLog] - - Image: Image - - Patient: Patient - - Series: Series - - SeriesUID: str - - UID: str - - Structures: List[Structure] - - Id: str - - Name: str - - Comment: str - - ApplicationScriptLogs: List[ApplicationScriptLog] - - Image: Image - - Patient: Patient - - Series: Series - - SeriesUID: str - - UID: str - - # [Availability of this method depends on your Eclipse Scripting API license] Adds couch structures to the StructureSet. Eclipse can model certain couches for photon treatment planning. A couch is modeled as a set of couch structures.The couch panel surface and interior, movable structural rails and grid(for Unipanel only) are each modeled as separate couch structures. The structure code of a couch structure is Support by default. You can change it to another structure code if necessary. The volume type of a couch structure is always Support. Couch structures are modeled inside a 3D image. If the 3D image is too small, this method will always enlarge the image to fit the couch structures. - def AddCouchStructures(self, couchModel: str, orientation: PatientOrientation, railA: RailPosition, railB: RailPosition, surfaceHU: Optional[float], interiorHU: Optional[float], railHU: Optional[float], addedStructures: IReadOnlyList[Structure], imageResized: bool, error: str) -> bool: - """ - Args: - couchModel: The id of the couch profile configured in Eclipse to use when creating the couch structures. - orientation: Patient orientation specifying where the couch structures are added. Pass NoOrientation to take the orientation from the image. - railA: Position of moveable rail A. - railB: Position of moveable rail B. - surfaceHU: HU value of the modeled couch surface. Pass null to use the setting from the specified couch profile or override by passing another value. - interiorHU: HU value of the modeled couch interior. Pass null to use the setting from the specified couch profile or override by passing another value. - railHU: HU value of the modeled couch rails. Pass null to use the setting from the specified couch profile or override by passing another value. - addedStructures: Returned list of added couch structures if successful. - imageResized: True if image was resized. - error: Returned error message if call failed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes couch structures from the StructureSet. - def RemoveCouchStructures(self, removedStructureIds: IReadOnlyList[str], error: str) -> bool: - """ - Args: - removedStructureIds: Returned list of removed couch structure IDs if successful. - error: Returned error message if call failed. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new reference line. - def AddReferenceLine(self, name: str, id: str, referenceLinePoints: Array[VVector]) -> Structure: - """ - Args: - name: Reference line name. - id: Reference line Id. - referenceLinePoints: Reference line points. Number of points: 1 .. 500. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure according to the DICOM structure type. - def AddStructure(self, dicomType: str, id: str) -> Structure: - """ - Args: - dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". - id: The identifier for the new structure. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure based on structure code. The DICOM structure type and structure ID are automatically assigned. - def AddStructure(self, code: StructureCodeInfo) -> Structure: - """ - Args: - code: The structure code. - """ - ... - - - # This method is used to verify whether it is possible to add couch structures to the StructureSet. - def CanAddCouchStructures(self, error: str) -> bool: - """ - Args: - error: Returned reason why couch structures cannot be added if method returns false. - """ - ... - - - # Returns true if it is possible to add the given type of structure to the structure set. - def CanAddStructure(self, dicomType: str, id: str) -> bool: - """ - Args: - dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". - id: The identifier for the new structure. - """ - ... - - - # This method is used to verify whether it is possible to remove couch structures from the StructureSet. - def CanRemoveCouchStructures(self, error: str) -> bool: - """ - Args: - error: Returned reason why couch structures cannot be removed if method returns false. - """ - ... - - - # Returns true if it is possible to remove the given structure from the structure set. - def CanRemoveStructure(self, structure: Structure) -> bool: - """ - Args: - structure: The structure to check. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a copy of this structure set. - def Copy(self) -> StructureSet: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new Body structure and searches Body with the specified parameters. The existing Body structure is returned, if there is one. - def CreateAndSearchBody(self, parameters: SearchBodyParameters) -> Structure: - """ - Args: - parameters: Parameters for the Search Body feature. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Deletes this structure set. - def Delete(self) -> None: - ... - - - # Gets a default set of Search Body parameters. - def GetDefaultSearchBodyParameters(self) -> SearchBodyParameters: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the structure from this structure set if removal is allowed. - def RemoveStructure(self, structure: Structure) -> None: - """ - Args: - structure: The structure to remove. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds couch structures to the StructureSet. Eclipse can model certain couches for photon treatment planning. A couch is modeled as a set of couch structures.The couch panel surface and interior, movable structural rails and grid(for Unipanel only) are each modeled as separate couch structures. The structure code of a couch structure is Support by default. You can change it to another structure code if necessary. The volume type of a couch structure is always Support. Couch structures are modeled inside a 3D image. If the 3D image is too small, this method will always enlarge the image to fit the couch structures. - def AddCouchStructures(self, couchModel: str, orientation: PatientOrientation, railA: RailPosition, railB: RailPosition, surfaceHU: Optional[float], interiorHU: Optional[float], railHU: Optional[float], addedStructures: IReadOnlyList[Structure], imageResized: bool, error: str) -> bool: - """ - Args: - couchModel: The id of the couch profile configured in Eclipse to use when creating the couch structures. - orientation: Patient orientation specifying where the couch structures are added. Pass NoOrientation to take the orientation from the image. - railA: Position of moveable rail A. - railB: Position of moveable rail B. - surfaceHU: HU value of the modeled couch surface. Pass null to use the setting from the specified couch profile or override by passing another value. - interiorHU: HU value of the modeled couch interior. Pass null to use the setting from the specified couch profile or override by passing another value. - railHU: HU value of the modeled couch rails. Pass null to use the setting from the specified couch profile or override by passing another value. - addedStructures: Returned list of added couch structures if successful. - imageResized: True if image was resized. - error: Returned error message if call failed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes couch structures from the StructureSet. - def RemoveCouchStructures(self, removedStructureIds: IReadOnlyList[str], error: str) -> bool: - """ - Args: - removedStructureIds: Returned list of removed couch structure IDs if successful. - error: Returned error message if call failed. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new reference line. - def AddReferenceLine(self, name: str, id: str, referenceLinePoints: Array[VVector]) -> Structure: - """ - Args: - name: Reference line name. - id: Reference line Id. - referenceLinePoints: Reference line points. Number of points: 1 .. 500. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure according to the DICOM structure type. - def AddStructure(self, dicomType: str, id: str) -> Structure: - """ - Args: - dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". - id: The identifier for the new structure. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds a new structure based on structure code. The DICOM structure type and structure ID are automatically assigned. - def AddStructure(self, code: StructureCodeInfo) -> Structure: - """ - Args: - code: The structure code. - """ - ... - - - # This method is used to verify whether it is possible to add couch structures to the StructureSet. - def CanAddCouchStructures(self, error: str) -> bool: - """ - Args: - error: Returned reason why couch structures cannot be added if method returns false. - """ - ... - - - # Returns true if it is possible to add the given type of structure to the structure set. - def CanAddStructure(self, dicomType: str, id: str) -> bool: - """ - Args: - dicomType: RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION". - id: The identifier for the new structure. - """ - ... - - - # This method is used to verify whether it is possible to remove couch structures from the StructureSet. - def CanRemoveCouchStructures(self, error: str) -> bool: - """ - Args: - error: Returned reason why couch structures cannot be removed if method returns false. - """ - ... - - - # Returns true if it is possible to remove the given structure from the structure set. - def CanRemoveStructure(self, structure: Structure) -> bool: - """ - Args: - structure: The structure to check. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a copy of this structure set. - def Copy(self) -> StructureSet: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a new Body structure and searches Body with the specified parameters. The existing Body structure is returned, if there is one. - def CreateAndSearchBody(self, parameters: SearchBodyParameters) -> Structure: - """ - Args: - parameters: Parameters for the Search Body feature. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Deletes this structure set. - def Delete(self) -> None: - ... - - - # Gets a default set of Search Body parameters. - def GetDefaultSearchBodyParameters(self) -> SearchBodyParameters: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the structure from this structure set if removal is allowed. - def RemoveStructure(self, structure: Structure) -> None: - """ - Args: - structure: The structure to remove. - """ - ... - - - -class TradeoffExplorationContext: - """ - - Attributes: - HasPlanCollection (bool): True if the trade-off exploration context has a plan collection, so that the trade-offs can be explored using the - CanLoadSavedPlanCollection (bool): True if a previously saved plan collection can be loaded. - CanCreatePlanCollection (bool): True if a plan collection can be created. - CanUsePlanDoseAsIntermediateDose (bool): True if plan dose can be used as intermediate dose in - CanUseHybridOptimizationInPlanGeneration (bool): True if VMAT-IMRT hybrid optimization can be used in - TradeoffObjectiveCandidates (List[OptimizationObjective]): Available optimization objectives that can be selected for trade-off exploration in multi-criteria optimization. - TradeoffObjectives (Collections.Generic.IReadOnlyCollection[TradeoffObjective]): Trade-off objectives. If - TradeoffStructureCandidates (List[Structure]): Available structures that can be selected for trade-off exploration in multi-criteria optimization. Only organs at risk can be used for trade-off exploration at the structure level. - TargetStructures (List[Structure]): Target structures in trade-off exploration. These structures cannot be selected for trade-off exploration at the structure level. Homogeneity indices only apply to the target structures. - CurrentDose (Dose): Dose at the current location on the Pareto surface (the current trade-offs). Returns null if no valid dose exists. - HasPlanCollection (bool): True if the trade-off exploration context has a plan collection, so that the trade-offs can be explored using the - CanLoadSavedPlanCollection (bool): True if a previously saved plan collection can be loaded. - CanCreatePlanCollection (bool): True if a plan collection can be created. - CanUsePlanDoseAsIntermediateDose (bool): True if plan dose can be used as intermediate dose in - CanUseHybridOptimizationInPlanGeneration (bool): True if VMAT-IMRT hybrid optimization can be used in - TradeoffObjectiveCandidates (List[OptimizationObjective]): Available optimization objectives that can be selected for trade-off exploration in multi-criteria optimization. - TradeoffObjectives (Collections.Generic.IReadOnlyCollection[TradeoffObjective]): Trade-off objectives. If - TradeoffStructureCandidates (List[Structure]): Available structures that can be selected for trade-off exploration in multi-criteria optimization. Only organs at risk can be used for trade-off exploration at the structure level. - TargetStructures (List[Structure]): Target structures in trade-off exploration. These structures cannot be selected for trade-off exploration at the structure level. Homogeneity indices only apply to the target structures. - CurrentDose (Dose): Dose at the current location on the Pareto surface (the current trade-offs). Returns null if no valid dose exists. - - Note: - To be able to get the - """ - # Creates a trade-off exploration context for a given plan. Acquires an MCO license for the lifetime of the application. - @overload - def __init__(self, param1: ExternalPlanSetup, param2: ILicenseManager, param3: IMcoControllerWithLocalDoseCorrection, param4: IMcoRuleValidator) -> None: - ... - - - # Creates a trade-off exploration context for a given plan. Acquires an MCO license for the lifetime of the application. - @overload - def __init__(self, param1: ExternalPlanSetup, param2: ILicenseManager, param3: IMcoControllerWithLocalDoseCorrection, param4: IMcoRuleValidator) -> None: - ... - - - HasPlanCollection: bool - - CanLoadSavedPlanCollection: bool - - CanCreatePlanCollection: bool - - CanUsePlanDoseAsIntermediateDose: bool - - CanUseHybridOptimizationInPlanGeneration: bool - - TradeoffObjectiveCandidates: List[OptimizationObjective] - - TradeoffObjectives: Collections.Generic.IReadOnlyCollection[TradeoffObjective] - - TradeoffStructureCandidates: List[Structure] - - TargetStructures: List[Structure] - - CurrentDose: Dose - - HasPlanCollection: bool - - CanLoadSavedPlanCollection: bool - - CanCreatePlanCollection: bool - - CanUsePlanDoseAsIntermediateDose: bool - - CanUseHybridOptimizationInPlanGeneration: bool - - TradeoffObjectiveCandidates: List[OptimizationObjective] - - TradeoffObjectives: Collections.Generic.IReadOnlyCollection[TradeoffObjective] - - TradeoffStructureCandidates: List[Structure] - - TargetStructures: List[Structure] - - CurrentDose: Dose - - # Loads a previously saved plan collection and sets - def LoadSavedPlanCollection(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan collection for trade-off exploration and sets - def CreatePlanCollection(self, continueOptimization: bool, intermediateDoseMode: TradeoffPlanGenerationIntermediateDoseMode, useHybridOptimizationForVmat: bool) -> bool: - """ - Args: - continueOptimization: True if the starting point for the trade-off exploration should be created by continuing optimization for the existing plan. Otherwise, the starting point is created by starting optimization from the beginning. - intermediateDoseMode: Specifies which intermediate dose mode is used for plan generation. - useHybridOptimizationForVmat: True if VMAT-IMRT hybrid optimization should be used in VMAT plan generation. Otherwise native VMAT optimization is used. - """ - ... - - - # Gets the current relative cost of a trade-off objective. The costs are normalized to the range [0,1]. If - def GetObjectiveCost(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the cost. - """ - ... - - - # Gets the lower limit value for a trade-off objective. It is not possible to set the cost value of the objective below this value. The range of the objective may be limited because one or more objective has a restrictor ( - def GetObjectiveLowerLimit(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the lower limit. - """ - ... - - - # Gets the upper limit value for a trade-off objective. It is not possible to set the cost value of the objective above this value. The range of the objective may be limited because one or more objective has a restrictor ( - def GetObjectiveUpperLimit(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the upper limit. - """ - ... - - - # Gets the current upper limit of a trade-off objective. The limits are normalized to the range [0,1]. If - def GetObjectiveUpperRestrictor(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective to get the upper limit. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] A single trade-off objective specifies a one dimensional subspace of the Pareto surface. By adjusting the relative cost of the objective, it is possible to move in this one dimensional subspace. The difference between the current relative cost and the new relative cost specifies the direction of the movement. If the difference is negative, the movement is towards the extreme case where the given trade-off objective is emphasized at the cost of all other objectives. If the difference is positive, the movement is away from the extreme case. If - def SetObjectiveCost(self, tradeoffObjective: TradeoffObjective, cost: float) -> None: - """ - Args: - tradeoffObjective: Trade-off objective that specifies the one dimensional subspace. - cost: The relative cost is defined as an interval [0,1]. A smaller value gives more emphasis to the given trade-off objective. - """ - ... - - - # Sets an upper limit for a trade-off objective. The limits are normalized to the range [0,1]. If - def SetObjectiveUpperRestrictor(self, tradeoffObjective: TradeoffObjective, restrictorValue: float) -> None: - """ - Args: - tradeoffObjective: Optimization objective selected for trade-off exploration. This trade-off objective specifies the one dimensional subspace of the Pareto surface. - restrictorValue: New upper limit [0,1] of the given trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Resets the costs of a trade-off objective to correspond to the balanced plan. If - def ResetToBalancedPlan(self) -> None: - ... - - - # Calculates a DVH for a given structure based on the dose at the current location on the Pareto surface (current trade-offs). If - def GetStructureDvh(self, structure: Structure) -> DVHData: - """ - Args: - structure: Structure for which the DVH is calculated. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a homogeneity objective for a given target structure to be used as a trade-off objective. Only target structures with an upper dose objective with larger than zero priority may have a homogeneity objective. Adding a new trade-off objective sets - def AddTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: - """ - Args: - targetStructure: Structure for which the homogeneity objective is created. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from all objectives associated with the given structure. Targets cannot be used in trade-off exploration at the structure level. Structures that do not have objectives or are not included in the plan cannot be added as trade-off objectives. Adding a new trade-off objective sets - def AddTradeoffObjective(self, structure: Structure) -> bool: - """ - Args: - structure: Structure to be added as a trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from an individual optimization objective. Adding a new trade-off objective sets - def AddTradeoffObjective(self, objective: OptimizationObjective) -> bool: - """ - Args: - objective: Objective to be added as a trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the given trade-off objective. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTradeoffObjective(self, tradeoffObjective: TradeoffObjective) -> bool: - """ - Args: - tradeoffObjective: Trade-off objective to be removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the homogeneity trade-off objective of the given target structure. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: - """ - Args: - targetStructure: Target structure for which the homogeneity objective is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the trade-off objective of the given structure. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTradeoffObjective(self, structure: Structure) -> bool: - """ - Args: - structure: Structure for which the trade-off objective is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan collection from the plan setup and database. Removing the plan collection sets - def RemovePlanCollection(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes all the trade-off objectives of the current plan collection. Removing all trade-off objectives invalidates the current plan collection and sets - def RemoveAllTradeoffObjectives(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Saves the trade-off exploration result. Also applies the trade-off exploration result to the plan setup for IMRT plans. For VMAT plans, to apply the results to the plan setup, an additional call to the - def ApplyTradeoffExplorationResult(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Applies the trade-off exploration result to the plan setup for VMAT plans. - def CreateDeliverableVmatPlan(self, useIntermediateDose: bool) -> bool: - """ - Args: - useIntermediateDose: True if intermediate dose is used when creating the VMAT plan. - """ - ... - - - # Loads a previously saved plan collection and sets - def LoadSavedPlanCollection(self) -> bool: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a plan collection for trade-off exploration and sets - def CreatePlanCollection(self, continueOptimization: bool, intermediateDoseMode: TradeoffPlanGenerationIntermediateDoseMode, useHybridOptimizationForVmat: bool) -> bool: - """ - Args: - continueOptimization: True if the starting point for the trade-off exploration should be created by continuing optimization for the existing plan. Otherwise, the starting point is created by starting optimization from the beginning. - intermediateDoseMode: Specifies which intermediate dose mode is used for plan generation. - useHybridOptimizationForVmat: True if VMAT-IMRT hybrid optimization should be used in VMAT plan generation. Otherwise native VMAT optimization is used. - """ - ... - - - # Gets the current relative cost of a trade-off objective. The costs are normalized to the range [0,1]. If - def GetObjectiveCost(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the cost. - """ - ... - - - # Gets the lower limit value for a trade-off objective. It is not possible to set the cost value of the objective below this value. The range of the objective may be limited because one or more objective has a restrictor ( - def GetObjectiveLowerLimit(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the lower limit. - """ - ... - - - # Gets the upper limit value for a trade-off objective. It is not possible to set the cost value of the objective above this value. The range of the objective may be limited because one or more objective has a restrictor ( - def GetObjectiveUpperLimit(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective for which to get the upper limit. - """ - ... - - - # Gets the current upper limit of a trade-off objective. The limits are normalized to the range [0,1]. If - def GetObjectiveUpperRestrictor(self, objective: TradeoffObjective) -> float: - """ - Args: - objective: Trade-off objective to get the upper limit. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] A single trade-off objective specifies a one dimensional subspace of the Pareto surface. By adjusting the relative cost of the objective, it is possible to move in this one dimensional subspace. The difference between the current relative cost and the new relative cost specifies the direction of the movement. If the difference is negative, the movement is towards the extreme case where the given trade-off objective is emphasized at the cost of all other objectives. If the difference is positive, the movement is away from the extreme case. If - def SetObjectiveCost(self, tradeoffObjective: TradeoffObjective, cost: float) -> None: - """ - Args: - tradeoffObjective: Trade-off objective that specifies the one dimensional subspace. - cost: The relative cost is defined as an interval [0,1]. A smaller value gives more emphasis to the given trade-off objective. - """ - ... - - - # Sets an upper limit for a trade-off objective. The limits are normalized to the range [0,1]. If - def SetObjectiveUpperRestrictor(self, tradeoffObjective: TradeoffObjective, restrictorValue: float) -> None: - """ - Args: - tradeoffObjective: Optimization objective selected for trade-off exploration. This trade-off objective specifies the one dimensional subspace of the Pareto surface. - restrictorValue: New upper limit [0,1] of the given trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Resets the costs of a trade-off objective to correspond to the balanced plan. If - def ResetToBalancedPlan(self) -> None: - ... - - - # Calculates a DVH for a given structure based on the dose at the current location on the Pareto surface (current trade-offs). If - def GetStructureDvh(self, structure: Structure) -> DVHData: - """ - Args: - structure: Structure for which the DVH is calculated. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a homogeneity objective for a given target structure to be used as a trade-off objective. Only target structures with an upper dose objective with larger than zero priority may have a homogeneity objective. Adding a new trade-off objective sets - def AddTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: - """ - Args: - targetStructure: Structure for which the homogeneity objective is created. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from all objectives associated with the given structure. Targets cannot be used in trade-off exploration at the structure level. Structures that do not have objectives or are not included in the plan cannot be added as trade-off objectives. Adding a new trade-off objective sets - def AddTradeoffObjective(self, structure: Structure) -> bool: - """ - Args: - structure: Structure to be added as a trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Creates a trade-off objective from an individual optimization objective. Adding a new trade-off objective sets - def AddTradeoffObjective(self, objective: OptimizationObjective) -> bool: - """ - Args: - objective: Objective to be added as a trade-off objective. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the given trade-off objective. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTradeoffObjective(self, tradeoffObjective: TradeoffObjective) -> bool: - """ - Args: - tradeoffObjective: Trade-off objective to be removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the homogeneity trade-off objective of the given target structure. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: - """ - Args: - targetStructure: Target structure for which the homogeneity objective is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the trade-off objective of the given structure. Removing the trade-off objective invalidates the current plan collection and sets - def RemoveTradeoffObjective(self, structure: Structure) -> bool: - """ - Args: - structure: Structure for which the trade-off objective is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the plan collection from the plan setup and database. Removing the plan collection sets - def RemovePlanCollection(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes all the trade-off objectives of the current plan collection. Removing all trade-off objectives invalidates the current plan collection and sets - def RemoveAllTradeoffObjectives(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Saves the trade-off exploration result. Also applies the trade-off exploration result to the plan setup for IMRT plans. For VMAT plans, to apply the results to the plan setup, an additional call to the - def ApplyTradeoffExplorationResult(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Applies the trade-off exploration result to the plan setup for VMAT plans. - def CreateDeliverableVmatPlan(self, useIntermediateDose: bool) -> bool: - """ - Args: - useIntermediateDose: True if intermediate dose is used when creating the VMAT plan. - """ - ... - - - -class TypeBasedIdValidator: - """ - A utility class for validating the data object identifier. - """ - def __init__(self) -> None: ... - - # Returns true if the given identifier is valid for the given data object. - def IsValidId(self, id: str, dataObject: ApiDataObject, errorHint: Text.StringBuilder) -> bool: - """ - Args: - id: The new identifier to check. - dataObject: The data object for whom the new identifier is checked. - errorHint: The error string that is set if the validation failed. - """ - ... - - - # Throws System.ArgumentException if the given identifier is not valid for the given data object. - def ThrowIfNotValidId(self, id: str, dataObject: ApiDataObject) -> None: - """ - Args: - id: The new identifier to check. - dataObject: The data object for whom the new identifier is checked. - """ - ... - - - # Returns true if the given identifier is valid for the given data object. - def IsValidId(self, id: str, dataObject: ApiDataObject, errorHint: Text.StringBuilder) -> bool: - """ - Args: - id: The new identifier to check. - dataObject: The data object for whom the new identifier is checked. - errorHint: The error string that is set if the validation failed. - """ - ... - - - # Throws System.ArgumentException if the given identifier is not valid for the given data object. - def ThrowIfNotValidId(self, id: str, dataObject: ApiDataObject) -> None: - """ - Args: - id: The new identifier to check. - dataObject: The data object for whom the new identifier is checked. - """ - ... - - - -class User: - """ - Represents a user. - - Attributes: - Id (str): The identifier of the user. - Language (str): The language of the user. - Name (str): The display name of the user. - Id (str): The identifier of the user. - Language (str): The language of the user. - Name (str): The display name of the user. - """ - def __init__(self) -> None: ... - - Id: str - - Language: str - - Name: str - - Id: str - - Language: str - - Name: str - - # Returns a string that represents the current object. - def ToString(self) -> str: - ... - - - # Determines whether the specified Object is equal to the current Object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: Object to compare with the current object - """ - ... - - - # Serves as a hash function for this type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: User, b: User) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: User, b: User) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns a string that represents the current object. - def ToString(self) -> str: - ... - - - # Determines whether the specified Object is equal to the current Object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: Object to compare with the current object - """ - ... - - - # Serves as a hash function for this type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: User, b: User) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: User, b: User) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Diagnosis: - """ - Represents a diagnosis of the patient. - - Attributes: - ClinicalDescription (str): User-defined clinical description of the diagnosis. - Code (str): The disease code from the specified code table. - CodeTable (str): Identifies the coding system table, for example, ICD-9-CM. - ClinicalDescription (str): User-defined clinical description of the diagnosis. - Code (str): The disease code from the specified code table. - CodeTable (str): Identifies the coding system table, for example, ICD-9-CM. - """ - def __init__(self) -> None: ... - - ClinicalDescription: str - - Code: str - - CodeTable: str - - ClinicalDescription: str - - Code: str - - CodeTable: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class DVHEstimationModelSummary: - """ - A summary of an DVH Estimation Model. Contains the needed information for selecting a model. - - Attributes: - Description (str): Model Description - IsPublished (bool): True if set to published state. Only published models are available for optimizing. - IsTrained (bool): True if the model contains data. - ModelDataVersion (str): Version - ModelParticleType (ParticleType): Returns particle type for the model. Either ParticleType.Proton or ParticleType.Photon. - ModelUID (str): Model UID. To be used for the Load command. - Name (str): Display Name - Revision (int): Publish revision of the model - TreatmentSite (str): Indicating the treatment site the model was created for - Description (str): Model Description - IsPublished (bool): True if set to published state. Only published models are available for optimizing. - IsTrained (bool): True if the model contains data. - ModelDataVersion (str): Version - ModelParticleType (ParticleType): Returns particle type for the model. Either ParticleType.Proton or ParticleType.Photon. - ModelUID (str): Model UID. To be used for the Load command. - Name (str): Display Name - Revision (int): Publish revision of the model - TreatmentSite (str): Indicating the treatment site the model was created for - """ - def __init__(self) -> None: ... - - Description: str - - IsPublished: bool - - IsTrained: bool - - ModelDataVersion: str - - ModelParticleType: ParticleType - - ModelUID: str - - Name: str - - Revision: int - - TreatmentSite: str - - Description: str - - IsPublished: bool - - IsTrained: bool - - ModelDataVersion: str - - ModelParticleType: ParticleType - - ModelUID: str - - Name: str - - Revision: int - - TreatmentSite: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class EnergyMode: - """ - Represents an energy mode. - - Attributes: - IsElectron (bool): Checks if the mode is electron. - IsPhoton (bool): Checks if the mode is photon. - IsProton (bool): Checks if the mode is proton. - IsElectron (bool): Checks if the mode is electron. - IsPhoton (bool): Checks if the mode is photon. - IsProton (bool): Checks if the mode is proton. - """ - def __init__(self) -> None: ... - - IsElectron: bool - - IsPhoton: bool - - IsProton: bool - - IsElectron: bool - - IsPhoton: bool - - IsProton: bool - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class EstimatedDVH: - """ - Represents an estimated Dose Volume Histogram (DVH) curve. - - Attributes: - CurveData (Array[DVHPoint]): The points of the estimated DVH curve. - PlanSetup (PlanSetup): Parent plan. - PlanSetupId (str): ID of the parent plan. - Structure (Structure): Parent structure. - StructureId (str): ID of the parent structure. - TargetDoseLevel (DoseValue): Dose level of the associated target structure. - Type (DVHEstimateType): Type of DVH estimate curve. - CurveData (Array[DVHPoint]): The points of the estimated DVH curve. - PlanSetup (PlanSetup): Parent plan. - PlanSetupId (str): ID of the parent plan. - Structure (Structure): Parent structure. - StructureId (str): ID of the parent structure. - TargetDoseLevel (DoseValue): Dose level of the associated target structure. - Type (DVHEstimateType): Type of DVH estimate curve. - """ - def __init__(self) -> None: ... - - CurveData: Array[DVHPoint] - - PlanSetup: PlanSetup - - PlanSetupId: str - - Structure: Structure - - StructureId: str - - TargetDoseLevel: DoseValue - - Type: DVHEstimateType - - CurveData: Array[DVHPoint] - - PlanSetup: PlanSetup - - PlanSetupId: str - - Structure: Structure - - StructureId: str - - TargetDoseLevel: DoseValue - - Type: DVHEstimateType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class EvaluationDose: - """ - Represents an evaluation dose that is connected to a plan that has no beams. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts the given dose value to the corresponding raw voxel value. - def DoseValueToVoxel(self, doseValue: DoseValue) -> int: - """ - Args: - doseValue: Dose value. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] For an evaluation dose (the dose of a plan that has no beams), sets the voxels of the given dose plane. Create the evaluation dose first using - def SetVoxels(self, planeIndex: int, values: Array[int]) -> None: - """ - Args: - planeIndex: Zero-based index of the plane. - values: The plane of voxel values. The size of the array must conform to the X-size and Y-size of the dose. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts the given dose value to the corresponding raw voxel value. - def DoseValueToVoxel(self, doseValue: DoseValue) -> int: - """ - Args: - doseValue: Dose value. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] For an evaluation dose (the dose of a plan that has no beams), sets the voxels of the given dose plane. Create the evaluation dose first using - def SetVoxels(self, planeIndex: int, values: Array[int]) -> None: - """ - Args: - planeIndex: Zero-based index of the plane. - values: The plane of voxel values. The size of the array must conform to the X-size and Y-size of the dose. - """ - ... - - - -class ExternalBeamTreatmentUnit: - """ - Represents a treatment machine used for delivering external beam radiotherapy. - - Attributes: - MachineDepartmentName (str): Default department associated with the machine. - MachineModel (str): The model of the treatment unit. - MachineModelName (str): The displayed name of the treatment unit model. - MachineScaleDisplayName (str): The name of the scale used in the treatment unit. - OperatingLimits (TreatmentUnitOperatingLimits): Information about operating limits for a set of treatment unit parameters. - SourceAxisDistance (float): The Source to Axis Distance (SAD). - MachineDepartmentName (str): Default department associated with the machine. - MachineModel (str): The model of the treatment unit. - MachineModelName (str): The displayed name of the treatment unit model. - MachineScaleDisplayName (str): The name of the scale used in the treatment unit. - OperatingLimits (TreatmentUnitOperatingLimits): Information about operating limits for a set of treatment unit parameters. - SourceAxisDistance (float): The Source to Axis Distance (SAD). - """ - def __init__(self) -> None: ... - - MachineDepartmentName: str - - MachineModel: str - - MachineModelName: str - - MachineScaleDisplayName: str - - OperatingLimits: TreatmentUnitOperatingLimits - - SourceAxisDistance: float - - MachineDepartmentName: str - - MachineModel: str - - MachineModelName: str - - MachineScaleDisplayName: str - - OperatingLimits: TreatmentUnitOperatingLimits - - SourceAxisDistance: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonBeam: - """ - Proton beam interface. - - Attributes: - AirGap (float): The user-defined air gap in mm. - BeamLineStatus (ProtonBeamLineStatus): Determine beamline's status - DistalTargetMargin (float): Distal end margin, in mm. - LateralMargins (VRect[float]): The lateral margins of this field, in mm. - LateralSpreadingDevices (List[LateralSpreadingDevice]): The lateral spreading devices in this beam. - NominalRange (float): The nominal range of the beam line, in mm. - NominalSOBPWidth (float): The nominal width of the Spread Out Bragg Peak, in mm. - OptionId (str): The identifier of the selected beam-line setting for proton beams. For a typical double scattering system, for example, an option is a combination of range modulator, second scatterer, and nominal energy that correspond to a broad proton beam with a certain range in patient and field size. Returns null if the option is undefined. - PatientSupportId (str): Patient support identifier. Returns null if undefined. - PatientSupportType (PatientSupportType): Patient support type. - IonControlPoints (IonControlPointCollection): Gets the proton control points. - ProximalTargetMargin (float): Proximal end margin, in mm. - RangeModulators (List[RangeModulator]): The range modulator devices in this beam. - RangeShifters (List[RangeShifter]): The range shifter devices in this beam. - ScanMode (IonBeamScanMode): The method of beam scanning to be used during treatment. - SnoutId (str): The Snout identifier. Returns null if undefined. - SnoutPosition (float): The snout position in cm. Returns System::Double::NaN if undefined. - TargetStructure (Structure): Returns the field target structure. Null if the field target is not defined (and axial margins are defined around the isocenter level). - VirtualSADX (float): Virtual Source-to-Axis Distance X, in mm. - VirtualSADY (float): Virtual Source-to-Axis Distance Y, in mm. - AirGap (float): The user-defined air gap in mm. - BeamLineStatus (ProtonBeamLineStatus): Determine beamline's status - DistalTargetMargin (float): Distal end margin, in mm. - LateralMargins (VRect[float]): The lateral margins of this field, in mm. - LateralSpreadingDevices (List[LateralSpreadingDevice]): The lateral spreading devices in this beam. - NominalRange (float): The nominal range of the beam line, in mm. - NominalSOBPWidth (float): The nominal width of the Spread Out Bragg Peak, in mm. - OptionId (str): The identifier of the selected beam-line setting for proton beams. For a typical double scattering system, for example, an option is a combination of range modulator, second scatterer, and nominal energy that correspond to a broad proton beam with a certain range in patient and field size. Returns null if the option is undefined. - PatientSupportId (str): Patient support identifier. Returns null if undefined. - PatientSupportType (PatientSupportType): Patient support type. - IonControlPoints (IonControlPointCollection): Gets the proton control points. - ProximalTargetMargin (float): Proximal end margin, in mm. - RangeModulators (List[RangeModulator]): The range modulator devices in this beam. - RangeShifters (List[RangeShifter]): The range shifter devices in this beam. - ScanMode (IonBeamScanMode): The method of beam scanning to be used during treatment. - SnoutId (str): The Snout identifier. Returns null if undefined. - SnoutPosition (float): The snout position in cm. Returns System::Double::NaN if undefined. - TargetStructure (Structure): Returns the field target structure. Null if the field target is not defined (and axial margins are defined around the isocenter level). - VirtualSADX (float): Virtual Source-to-Axis Distance X, in mm. - VirtualSADY (float): Virtual Source-to-Axis Distance Y, in mm. - """ - def __init__(self) -> None: ... - - AirGap: float - - BeamLineStatus: ProtonBeamLineStatus - - DistalTargetMargin: float - - LateralMargins: VRect[float] - - LateralSpreadingDevices: List[LateralSpreadingDevice] - - NominalRange: float - - NominalSOBPWidth: float - - OptionId: str - - PatientSupportId: str - - PatientSupportType: PatientSupportType - - IonControlPoints: IonControlPointCollection - - ProximalTargetMargin: float - - RangeModulators: List[RangeModulator] - - RangeShifters: List[RangeShifter] - - ScanMode: IonBeamScanMode - - SnoutId: str - - SnoutPosition: float - - TargetStructure: Structure - - VirtualSADX: float - - VirtualSADY: float - - AirGap: float - - BeamLineStatus: ProtonBeamLineStatus - - DistalTargetMargin: float - - LateralMargins: VRect[float] - - LateralSpreadingDevices: List[LateralSpreadingDevice] - - NominalRange: float - - NominalSOBPWidth: float - - OptionId: str - - PatientSupportId: str - - PatientSupportType: PatientSupportType - - IonControlPoints: IonControlPointCollection - - ProximalTargetMargin: float - - RangeModulators: List[RangeModulator] - - RangeShifters: List[RangeShifter] - - ScanMode: IonBeamScanMode - - SnoutId: str - - SnoutPosition: float - - TargetStructure: Structure - - VirtualSADX: float - - VirtualSADY: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Modifies the proton beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. DVH Estimations of the plan, if any, are cleared. - def ApplyParameters(self, beamParams: BeamParameters) -> None: - """ - Args: - beamParams: The parameters to apply to the beam. - """ - ... - - - # Returns a proton field deliverability status by room ID. Proton field deliverability status can be Deliverable, Undeliverable or NotCalculated. - def GetDeliveryTimeStatusByRoomId(self, roomId: str) -> ProtonDeliveryTimeStatus: - """ - Args: - roomId: Treatment room ID. - """ - ... - - - # Returns a new editable copy of the ion beam parameters. The returned IonBeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another IonBeamParameters object. - def GetEditableParameters(self) -> IonBeamParameters: - ... - - - # Returns a proton delivery time by room ID in seconds. Returns System::Double::NaN if delivery time status is Undeliverable or NotCalculated. - def GetProtonDeliveryTimeByRoomIdAsNumber(self, roomId: str) -> float: - """ - Args: - roomId: Treatment room ID. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Modifies the proton beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. DVH Estimations of the plan, if any, are cleared. - def ApplyParameters(self, beamParams: BeamParameters) -> None: - """ - Args: - beamParams: The parameters to apply to the beam. - """ - ... - - - # Returns a proton field deliverability status by room ID. Proton field deliverability status can be Deliverable, Undeliverable or NotCalculated. - def GetDeliveryTimeStatusByRoomId(self, roomId: str) -> ProtonDeliveryTimeStatus: - """ - Args: - roomId: Treatment room ID. - """ - ... - - - # Returns a new editable copy of the ion beam parameters. The returned IonBeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another IonBeamParameters object. - def GetEditableParameters(self) -> IonBeamParameters: - ... - - - # Returns a proton delivery time by room ID in seconds. Returns System::Double::NaN if delivery time status is Undeliverable or NotCalculated. - def GetProtonDeliveryTimeByRoomIdAsNumber(self, roomId: str) -> float: - """ - Args: - roomId: Treatment room ID. - """ - ... - - - -class IonControlPoint: - """ - Proton control point interface. - - Attributes: - FinalSpotList (IonSpotCollection): Gets a cached copy of the post-processed final spot list. - LateralSpreadingDeviceSettings (List[LateralSpreadingDeviceSettings]): The lateral spreading device settings. - NominalBeamEnergy (float): Nominal beam energy, in megavolts. - NumberOfPaintings (int): The number of times the scan pattern shall be applied at the current control point. - RangeModulatorSettings (List[RangeModulatorSettings]): The range modulator settings. - RangeShifterSettings (List[RangeShifterSettings]): The range shifter settings. - RawSpotList (IonSpotCollection): Gets a cached copy of the raw spot list. - ScanningSpotSizeX (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY X direction (mm). - ScanningSpotSizeY (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY Y direction (mm). - ScanSpotTuneId (str): User-supplied or machine code identifier for machine configuration to produce beam spot. This may be the nominal spot size or some other machine-specific value. Returns null if undefined. - SnoutPosition (float): The snout position, in mm. - FinalSpotList (IonSpotCollection): Gets a cached copy of the post-processed final spot list. - LateralSpreadingDeviceSettings (List[LateralSpreadingDeviceSettings]): The lateral spreading device settings. - NominalBeamEnergy (float): Nominal beam energy, in megavolts. - NumberOfPaintings (int): The number of times the scan pattern shall be applied at the current control point. - RangeModulatorSettings (List[RangeModulatorSettings]): The range modulator settings. - RangeShifterSettings (List[RangeShifterSettings]): The range shifter settings. - RawSpotList (IonSpotCollection): Gets a cached copy of the raw spot list. - ScanningSpotSizeX (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY X direction (mm). - ScanningSpotSizeY (float): The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY Y direction (mm). - ScanSpotTuneId (str): User-supplied or machine code identifier for machine configuration to produce beam spot. This may be the nominal spot size or some other machine-specific value. Returns null if undefined. - SnoutPosition (float): The snout position, in mm. - """ - def __init__(self) -> None: ... - - FinalSpotList: IonSpotCollection - - LateralSpreadingDeviceSettings: List[LateralSpreadingDeviceSettings] - - NominalBeamEnergy: float - - NumberOfPaintings: int - - RangeModulatorSettings: List[RangeModulatorSettings] - - RangeShifterSettings: List[RangeShifterSettings] - - RawSpotList: IonSpotCollection - - ScanningSpotSizeX: float - - ScanningSpotSizeY: float - - ScanSpotTuneId: str - - SnoutPosition: float - - FinalSpotList: IonSpotCollection - - LateralSpreadingDeviceSettings: List[LateralSpreadingDeviceSettings] - - NominalBeamEnergy: float - - NumberOfPaintings: int - - RangeModulatorSettings: List[RangeModulatorSettings] - - RangeShifterSettings: List[RangeShifterSettings] - - RawSpotList: IonSpotCollection - - ScanningSpotSizeX: float - - ScanningSpotSizeY: float - - ScanSpotTuneId: str - - SnoutPosition: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonControlPointCollection: - """ - Represents a collection of machine parameters that describe the planned proton beam. - - Attributes: - Count (int): The number of control points in the collection. - Count (int): The number of control points in the collection. - """ - def __init__(self) -> None: ... - - Count: int - - Count: int - - # Retrieves enumerator for IonControlPoints in the collection. - def GetEnumerator(self) -> Iterable[IonControlPoint]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Retrieves enumerator for IonControlPoints in the collection. - def GetEnumerator(self) -> Iterable[IonControlPoint]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonControlPointPair: - """ - An editable copy of a control point pair (the pair of the start control point with an even index, and the end control point with an odd index). - - Attributes: - EndControlPoint (IonControlPointParameters): The end control point in the pair, with an odd index. - FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the editable post-processed final spot list. - NominalBeamEnergy (float): Nominal beam energy in megavolts. - RawSpotList (IonSpotParametersCollection): Gets a cached copy of the editable raw spot list - StartControlPoint (IonControlPointParameters): Start control point in the pair, with an even index from zero. - StartIndex (int): The index of the start control point in the pair. The index should be an even number starting from zero. - EndControlPoint (IonControlPointParameters): The end control point in the pair, with an odd index. - FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the editable post-processed final spot list. - NominalBeamEnergy (float): Nominal beam energy in megavolts. - RawSpotList (IonSpotParametersCollection): Gets a cached copy of the editable raw spot list - StartControlPoint (IonControlPointParameters): Start control point in the pair, with an even index from zero. - StartIndex (int): The index of the start control point in the pair. The index should be an even number starting from zero. - - Note: - To apply the parameters, call the - """ - def __init__(self) -> None: ... - - EndControlPoint: IonControlPointParameters - - FinalSpotList: IonSpotParametersCollection - - NominalBeamEnergy: float - - RawSpotList: IonSpotParametersCollection - - StartControlPoint: IonControlPointParameters - - StartIndex: int - - EndControlPoint: IonControlPointParameters - - FinalSpotList: IonSpotParametersCollection - - NominalBeamEnergy: float - - RawSpotList: IonSpotParametersCollection - - StartControlPoint: IonControlPointParameters - - StartIndex: int - - # Resizes the list of final spots. - def ResizeFinalSpotList(self, count: int) -> None: - """ - Args: - count: New length of the list. - """ - ... - - - # Resizes the list of raw spots. - def ResizeRawSpotList(self, count: int) -> None: - """ - Args: - count: New length of the list. - """ - ... - - - # Resizes the list of final spots. - def ResizeFinalSpotList(self, count: int) -> None: - """ - Args: - count: New length of the list. - """ - ... - - - # Resizes the list of raw spots. - def ResizeRawSpotList(self, count: int) -> None: - """ - Args: - count: New length of the list. - """ - ... - - - -class IonControlPointPairCollection: - """ - A collection of editable copies of control point pairs that describe the planned proton beam. - - Attributes: - Count (int): The number of control point pairs in the collection. - Count (int): The number of control point pairs in the collection. - - Note: - To apply the parameters, call the - """ - def __init__(self) -> None: ... - - Count: int - - Count: int - - # Retrieves enumerator for IonControlPointPairs in the collection. - def GetEnumerator(self) -> Iterable[IonControlPointPair]: - ... - - - # Retrieves enumerator for IonControlPointPairs in the collection. - def GetEnumerator(self) -> Iterable[IonControlPointPair]: - ... - - - -class IonControlPointParameters: - """ - An editable copy of the parameters of a proton control point. - - Attributes: - FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the post-processed final spot list. - RawSpotList (IonSpotParametersCollection): Gets a cached copy of the raw spot list. - SnoutPosition (float): Snout position in centimeters. - FinalSpotList (IonSpotParametersCollection): Gets a cached copy of the post-processed final spot list. - RawSpotList (IonSpotParametersCollection): Gets a cached copy of the raw spot list. - SnoutPosition (float): Snout position in centimeters. - - Note: - To apply the parameters, call the ApplyParameters method of the Beam class. Because the parameters are simple copies, they do not reflect the current state of the data model. - """ - def __init__(self) -> None: ... - - FinalSpotList: IonSpotParametersCollection - - RawSpotList: IonSpotParametersCollection - - SnoutPosition: float - - FinalSpotList: IonSpotParametersCollection - - RawSpotList: IonSpotParametersCollection - - SnoutPosition: float - - -class IonSpot: - """ - The proton scanning spot interface that contains the 3D spot position and spot weight. - - Attributes: - Position (VVector): Read-only spot position in X, Y, and Z directions. - Weight (float): Read-only spot weight. - Position (VVector): Read-only spot position in X, Y, and Z directions. - Weight (float): Read-only spot weight. - """ - def __init__(self) -> None: ... - - Position: VVector - - Weight: float - - Position: VVector - - Weight: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonSpotCollection: - """ - Interface for the proton scanning spot list. - - Attributes: - Count (int): The number of scanning spots in this collection (spot list). - Count (int): The number of scanning spots in this collection (spot list). - """ - def __init__(self) -> None: ... - - Count: int - - Count: int - - # Retrieves enumerator for IonSpots in the collection. - def GetEnumerator(self) -> Iterable[IonSpot]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Retrieves enumerator for IonSpots in the collection. - def GetEnumerator(self) -> Iterable[IonSpot]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonSpotParameters: - """ - Interface for the proton scanning spot that contains the 3D spot position and spot weight. - - Attributes: - Weight (float): Editable spot weight. - X (float): Editable X position. - Y (float): Editable Y position. - Weight (float): Editable spot weight. - X (float): Editable X position. - Y (float): Editable Y position. - """ - def __init__(self) -> None: ... - - Weight: float - - X: float - - Y: float - - Weight: float - - X: float - - Y: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class IonSpotParametersCollection: - """ - Interface for the editable proton scanning spot list. - - Attributes: - Count (int): The number of editable scanning spots in this collection (spot list). - Count (int): The number of editable scanning spots in this collection (spot list). - """ - def __init__(self) -> None: ... - - Count: int - - Count: int - - # Retrieves enumerator for IonSpotParameterss in the collection. - def GetEnumerator(self) -> Iterable[IonSpotParameters]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Retrieves enumerator for IonSpotParameterss in the collection. - def GetEnumerator(self) -> Iterable[IonSpotParameters]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class LateralSpreadingDevice: - """ - The lateral spreading device. - - Attributes: - Type (LateralSpreadingDeviceType): The type of the device. - Type (LateralSpreadingDeviceType): The type of the device. - """ - def __init__(self) -> None: ... - - Type: LateralSpreadingDeviceType - - Type: LateralSpreadingDeviceType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class LateralSpreadingDeviceSettings: - """ - Settings for the lateral spreading device. - - Attributes: - IsocenterToLateralSpreadingDeviceDistance (float): Distance from the isocenter to the downstream edge of the lateral spreading device (mm) at the current control point. - LateralSpreadingDeviceSetting (str): Machine-specific setting. - LateralSpreadingDeviceWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the lateral spreading device at the central axis for the beam energy incident upon the device. - ReferencedLateralSpreadingDevice (LateralSpreadingDevice): The referenced lateral spreading device. - IsocenterToLateralSpreadingDeviceDistance (float): Distance from the isocenter to the downstream edge of the lateral spreading device (mm) at the current control point. - LateralSpreadingDeviceSetting (str): Machine-specific setting. - LateralSpreadingDeviceWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the lateral spreading device at the central axis for the beam energy incident upon the device. - ReferencedLateralSpreadingDevice (LateralSpreadingDevice): The referenced lateral spreading device. - """ - def __init__(self) -> None: ... - - IsocenterToLateralSpreadingDeviceDistance: float - - LateralSpreadingDeviceSetting: str - - LateralSpreadingDeviceWaterEquivalentThickness: float - - ReferencedLateralSpreadingDevice: LateralSpreadingDevice - - IsocenterToLateralSpreadingDeviceDistance: float - - LateralSpreadingDeviceSetting: str - - LateralSpreadingDeviceWaterEquivalentThickness: float - - ReferencedLateralSpreadingDevice: LateralSpreadingDevice - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationEUDObjective: - """ - A gEUD objective is an exact, upper or lower objective. An exact gEUD objective defines an exact dose value that a target structure should receive. An upper gEUD objective defines the maximum dose value that a structure should receive. A lower gEUD objective defines the minimum dose value that a target structure should receive. Generalized Equivalent Uniform Dose (gEUD) is a uniform dose that, if delivered over the same number of fractions, yields the same radiobiological effect as the non-uniform dose distribution of interest. - - Attributes: - Dose (DoseValue): The dose value for the objective. - ParameterA (float): A tissue-specific parameter that illustrates the effect of the volume on the dose. - Dose (DoseValue): The dose value for the objective. - ParameterA (float): A tissue-specific parameter that illustrates the effect of the volume on the dose. - """ - def __init__(self) -> None: ... - - Dose: DoseValue - - ParameterA: float - - Dose: DoseValue - - ParameterA: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationExcludeStructureParameter: - """ - Structures that have this parameter are excluded from the optimization. - - Attributes: - Structure (Structure): The structure to be excluded. - Structure (Structure): The structure to be excluded. - """ - def __init__(self) -> None: ... - - Structure: Structure - - Structure: Structure - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationIMRTBeamParameter: - """ - Beam-specific optimization parameter for IMRT optimization. - - Attributes: - Beam (Beam): The beam to which this parameter belongs. - BeamId (str): The identifier of the beam. - Excluded (bool): True if the beam is excluded from the optimization. - FixedJaws (bool): If true, the collimator jaw positions of the beam remain the same during the optimization. - SmoothX (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. - SmoothY (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. - Beam (Beam): The beam to which this parameter belongs. - BeamId (str): The identifier of the beam. - Excluded (bool): True if the beam is excluded from the optimization. - FixedJaws (bool): If true, the collimator jaw positions of the beam remain the same during the optimization. - SmoothX (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. - SmoothY (float): A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value. - """ - def __init__(self) -> None: ... - - Beam: Beam - - BeamId: str - - Excluded: bool - - FixedJaws: bool - - SmoothX: float - - SmoothY: float - - Beam: Beam - - BeamId: str - - Excluded: bool - - FixedJaws: bool - - SmoothX: float - - SmoothY: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationJawTrackingUsedParameter: - """ - An optimization parameter for using jaw tracking in VMAT optimization. The parameter exists if OptimizationSetup.UseJawTracking has been set to true. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationLineObjective: - """ - A line objective is a collection of point objectives that have the same priority. It is used to limit the dose in a given structure. - - Attributes: - CurveData (Array[DVHPoint]): The points in the line objective. - CurveData (Array[DVHPoint]): The points in the line objective. - """ - def __init__(self) -> None: ... - - CurveData: Array[DVHPoint] - - CurveData: Array[DVHPoint] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationMeanDoseObjective: - """ - A mean objective defines the mean dose that should not be exceeded. The mean objective is used to decrease the dose that a structure receives. - - Attributes: - Dose (DoseValue): The dose value for the objective. - Dose (DoseValue): The dose value for the objective. - """ - def __init__(self) -> None: ... - - Dose: DoseValue - - Dose: DoseValue - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationNormalTissueParameter: - """ - An optimization parameter for the normal tissue objective. - - Attributes: - DistanceFromTargetBorderInMM (float): Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - EndDosePercentage (float): Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - FallOff (float): Determines the steepness of the normal tissue objective fall-off. The value is positive. - IsAutomatic (bool): Returns True if an automatic normal tissue objective (NTO) is used. The automatic NTO adapts to the patient anatomy and the optimization objectives, and automatically determines the dose fall-off criteria. When an automatic NTO is used, the other properties of this object, except Priority, are not used. - IsAutomaticSbrt (bool): Returns True if an automatic SBRT normal tissue objective (NTO) is used. When an automatic SBRT NTO is used, the other properties of this object, except Priority, are not used. - IsAutomaticSrs (bool): Returns True if an automatic SRS normal tissue objective (NTO) is used. When an automatic SRS NTO is used, the other properties of this object, except Priority, are not used. - Priority (float): Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - StartDosePercentage (float): Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - DistanceFromTargetBorderInMM (float): Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins. - EndDosePercentage (float): Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100. - FallOff (float): Determines the steepness of the normal tissue objective fall-off. The value is positive. - IsAutomatic (bool): Returns True if an automatic normal tissue objective (NTO) is used. The automatic NTO adapts to the patient anatomy and the optimization objectives, and automatically determines the dose fall-off criteria. When an automatic NTO is used, the other properties of this object, except Priority, are not used. - IsAutomaticSbrt (bool): Returns True if an automatic SBRT normal tissue objective (NTO) is used. When an automatic SBRT NTO is used, the other properties of this object, except Priority, are not used. - IsAutomaticSrs (bool): Returns True if an automatic SRS normal tissue objective (NTO) is used. When an automatic SRS NTO is used, the other properties of this object, except Priority, are not used. - Priority (float): Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive. - StartDosePercentage (float): Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100. - """ - def __init__(self) -> None: ... - - DistanceFromTargetBorderInMM: float - - EndDosePercentage: float - - FallOff: float - - IsAutomatic: bool - - IsAutomaticSbrt: bool - - IsAutomaticSrs: bool - - Priority: float - - StartDosePercentage: float - - DistanceFromTargetBorderInMM: float - - EndDosePercentage: float - - FallOff: float - - IsAutomatic: bool - - IsAutomaticSbrt: bool - - IsAutomaticSrs: bool - - Priority: float - - StartDosePercentage: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationObjective: - """ - Provides a common base type for all structure-specific optimization objectives. - - Attributes: - Operator (OptimizationObjectiveOperator): Specifies the type of the objective (upper, lower, exact). - Priority (float): The priority of the objective as a positive double. - Structure (Structure): The structure to which this optimization objective belongs. - StructureId (str): The identifier of the structure. - Operator (OptimizationObjectiveOperator): Specifies the type of the objective (upper, lower, exact). - Priority (float): The priority of the objective as a positive double. - Structure (Structure): The structure to which this optimization objective belongs. - StructureId (str): The identifier of the structure. - """ - def __init__(self) -> None: ... - - Operator: OptimizationObjectiveOperator - - Priority: float - - Structure: Structure - - StructureId: str - - Operator: OptimizationObjectiveOperator - - Priority: float - - Structure: Structure - - StructureId: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Determines whether the specified object is equal to the current object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: The object to compare with the current object. - """ - ... - - - # Serves as a hash function for a particular type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Determines whether the specified object is equal to the current object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: The object to compare with the current object. - """ - ... - - - # Serves as a hash function for a particular type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: OptimizationObjective, b: OptimizationObjective) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - -class OptimizationParameter: - """ - Provides a common base type for all optimization parameters. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Determines whether the specified object is equal to the current object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: The object to compare with the current object. - """ - ... - - - # Serves as a hash function for a particular type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Determines whether the specified object is equal to the current object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: The object to compare with the current object. - """ - ... - - - # Serves as a hash function for a particular type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: OptimizationParameter, b: OptimizationParameter) -> bool: - """ - Args: - a: The first operand. - b: The second operand. - """ - ... - - - -class OptimizationPointCloudParameter: - """ - Structure-specific parameter for point cloud optimization. Relevant if the optimization algorithm uses a point cloud. The point cloud parameters are automatically created with default values when you add other structure-specific parameters or objectives in the optimization setup. - - Attributes: - PointResolutionInMM (float): The point cloud resolution. - Structure (Structure): The structure whose parameters these are. - PointResolutionInMM (float): The point cloud resolution. - Structure (Structure): The structure whose parameters these are. - """ - def __init__(self) -> None: ... - - PointResolutionInMM: float - - Structure: Structure - - PointResolutionInMM: float - - Structure: Structure - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationPointObjective: - """ - A point objective is either an upper or lower objective. An upper objective is used to limit the dose in a given structure. A lower objective is used to define the desired dose levels in target structures. - - Attributes: - Dose (DoseValue): The dose value for the objective. - Volume (float): Percentage of the structure volume (0-100 %) to receive the dose. - Dose (DoseValue): The dose value for the objective. - Volume (float): Percentage of the structure volume (0-100 %) to receive the dose. - """ - def __init__(self) -> None: ... - - Dose: DoseValue - - Volume: float - - Dose: DoseValue - - Volume: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OptimizationVMATAvoidanceSectors: - """ - Beam-specific optimization parameter for VMAT Avoidance sectors. - - Attributes: - AvoidanceSector1 (OptimizationAvoidanceSector): Avoidance Sector 1. - AvoidanceSector2 (OptimizationAvoidanceSector): Avoidance Sector 2. - Beam (Beam): The beam to which this parameter belongs. - IsValid (bool): Is Avoidance Sectors valid. - ValidationError (str): Validation error if any. - AvoidanceSector1 (OptimizationAvoidanceSector): Avoidance Sector 1. - AvoidanceSector2 (OptimizationAvoidanceSector): Avoidance Sector 2. - Beam (Beam): The beam to which this parameter belongs. - IsValid (bool): Is Avoidance Sectors valid. - ValidationError (str): Validation error if any. - """ - def __init__(self) -> None: ... - - AvoidanceSector1: OptimizationAvoidanceSector - - AvoidanceSector2: OptimizationAvoidanceSector - - Beam: Beam - - IsValid: bool - - ValidationError: str - - AvoidanceSector1: OptimizationAvoidanceSector - - AvoidanceSector2: OptimizationAvoidanceSector - - Beam: Beam - - IsValid: bool - - ValidationError: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PatientSupportDevice: - """ - Represents a proton patient support device. - - Attributes: - PatientSupportAccessoryCode (str): Patient support device accessory code. - PatientSupportDeviceType (str): Type of the patient support device. - PatientSupportAccessoryCode (str): Patient support device accessory code. - PatientSupportDeviceType (str): Type of the patient support device. - """ - def __init__(self) -> None: ... - - PatientSupportAccessoryCode: str - - PatientSupportDeviceType: str - - PatientSupportAccessoryCode: str - - PatientSupportDeviceType: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PlanningItemDose: - """ - Represents a dose that is connected to a plan setup or a plan sum. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PlanSumComponent: - """ - Represents a component plan of a plan sum. - - Attributes: - PlanSetupId (str): The unique identification of the plan within the course. - PlanSumOperation (PlanSumOperation): The summing operation (+ or -) that defines how the dose of a component plan contributes to the plan sum. - PlanWeight (float): The weight of a component plan included in the plan sum. - PlanSetupId (str): The unique identification of the plan within the course. - PlanSumOperation (PlanSumOperation): The summing operation (+ or -) that defines how the dose of a component plan contributes to the plan sum. - PlanWeight (float): The weight of a component plan included in the plan sum. - """ - def __init__(self) -> None: ... - - PlanSetupId: str - - PlanSumOperation: PlanSumOperation - - PlanWeight: float - - PlanSetupId: str - - PlanSumOperation: PlanSumOperation - - PlanWeight: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PlanTreatmentSession: - """ - Plan in the treatment session. - - Attributes: - PlanSetup (PlanSetup): Scheduled or treated plan. - Status (TreatmentSessionStatus): Plan status in the treatment session. - TreatmentSession (TreatmentSession): Treatment session. - PlanSetup (PlanSetup): Scheduled or treated plan. - Status (TreatmentSessionStatus): Plan status in the treatment session. - TreatmentSession (TreatmentSession): Treatment session. - """ - def __init__(self) -> None: ... - - PlanSetup: PlanSetup - - Status: TreatmentSessionStatus - - TreatmentSession: TreatmentSession - - PlanSetup: PlanSetup - - Status: TreatmentSessionStatus - - TreatmentSession: TreatmentSession - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PlanUncertainty: - """ - Provides access to Plan Uncertainty parameters. For more information, see Eclipse Photon and Electron Instructions for Use. - - Attributes: - BeamUncertainties (List[BeamUncertainty]): Collection of beam uncertainty doses. - CalibrationCurveError (float): The calibration curve error of the plan uncertainty in percentage. Returns 100 for 100%. NaN if not defined. - DisplayName (str): The display name of the plan variation, including the parameter values. - Dose (Dose): The dose of this plan variation. - IsocenterShift (VVector): The isocenter shift of the plan uncertainty. - UncertaintyType (PlanUncertaintyType): Type of uncertainty, which determines how and in what context the defined parameters are to be used. - BeamUncertainties (List[BeamUncertainty]): Collection of beam uncertainty doses. - CalibrationCurveError (float): The calibration curve error of the plan uncertainty in percentage. Returns 100 for 100%. NaN if not defined. - DisplayName (str): The display name of the plan variation, including the parameter values. - Dose (Dose): The dose of this plan variation. - IsocenterShift (VVector): The isocenter shift of the plan uncertainty. - UncertaintyType (PlanUncertaintyType): Type of uncertainty, which determines how and in what context the defined parameters are to be used. - """ - def __init__(self) -> None: ... - - BeamUncertainties: List[BeamUncertainty] - - CalibrationCurveError: float - - DisplayName: str - - Dose: Dose - - IsocenterShift: VVector - - UncertaintyType: PlanUncertaintyType - - BeamUncertainties: List[BeamUncertainty] - - CalibrationCurveError: float - - DisplayName: str - - Dose: Dose - - IsocenterShift: VVector - - UncertaintyType: PlanUncertaintyType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns cumulative Dose Volume Histogram (DVH) data for this uncertainty plan. - def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: - """ - Args: - structure: Structure, for which the DVH data is requested. - dosePresentation: Requested dose presentation mode (absolute or relative). Note that only absolute dose is supported for PlanSums. - volumePresentation: Requested volume presentation mode. - binWidth: Requested width of the bin. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Returns cumulative Dose Volume Histogram (DVH) data for this uncertainty plan. - def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: - """ - Args: - structure: Structure, for which the DVH data is requested. - dosePresentation: Requested dose presentation mode (absolute or relative). Note that only absolute dose is supported for PlanSums. - volumePresentation: Requested volume presentation mode. - binWidth: Requested width of the bin. - """ - ... - - - -class RadioactiveSource: - """ - Represents a radioactive source installed into a - - Attributes: - CalibrationDate (Optional[datetime]): The calibration date for the strength of this radioactive source. - NominalActivity (bool): Defines whether source decay is accounted for in treatment planning. If the value is true, the dose calculation uses the source at its calibration activity (nominal activity). If the value is false, the source strength is decayed to the treatment activity based on the treatment date of the plan where the source is used. - RadioactiveSourceModel (RadioactiveSourceModel): The brachytherapy radioactive source model associated with this radioactive source. - SerialNumber (str): The serial number of this radioactive source. - Strength (float): The source strength for the radioactive source on the calibration date in cGy cm^2/h. - CalibrationDate (Optional[datetime]): The calibration date for the strength of this radioactive source. - NominalActivity (bool): Defines whether source decay is accounted for in treatment planning. If the value is true, the dose calculation uses the source at its calibration activity (nominal activity). If the value is false, the source strength is decayed to the treatment activity based on the treatment date of the plan where the source is used. - RadioactiveSourceModel (RadioactiveSourceModel): The brachytherapy radioactive source model associated with this radioactive source. - SerialNumber (str): The serial number of this radioactive source. - Strength (float): The source strength for the radioactive source on the calibration date in cGy cm^2/h. - """ - def __init__(self) -> None: ... - - CalibrationDate: Optional[datetime] - - NominalActivity: bool - - RadioactiveSourceModel: RadioactiveSourceModel - - SerialNumber: str - - Strength: float - - CalibrationDate: Optional[datetime] - - NominalActivity: bool - - RadioactiveSourceModel: RadioactiveSourceModel - - SerialNumber: str - - Strength: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RadioactiveSourceModel: - """ - The radioactive source model represents the details of the radioactive source used in brachytherapy. It encapsulates the source isotope, dimensions, and dose calculation parameters. - - Attributes: - ActiveSize (VVector): The active size of the modeled radioactive source in x, y, and z dimensions in millimeters. x represents the source width, y represents the source height, and z the source length. - ActivityConversionFactor (float): The activity-kerma conversion factor is used for converting activity (in mCi) to air-kerma strength (in U = cGy cm^2 / h). The unit of the factor is [U / mCi]. - CalculationModel (str): The dose calculation type used with this source model. Possible values are "Point source" and "Linear source". - DoseRateConstant (float): A conversion factor from the air-kerma strength to the dose rate in tissue. The unit of the dose rate constant is cGy / (h U). - HalfLife (float): The half life of the isotope in seconds. - LiteratureReference (str): The reference to the scientific publications on which the source model is based. - Manufacturer (str): The manufacturer of the modeled radioactive source. - SourceType (str): The DICOM source type. Possible values are "Point", "Line", "Cylinder", and "Sphere". - Status (str): The status of this source model. The status can be either "Unapproved", "Commissioning", "Approved", or "Retired". - StatusDate (Optional[datetime]): The time when the status of the source model was set. - StatusUserName (str): The name of the user who last set the status of the source model. - ActiveSize (VVector): The active size of the modeled radioactive source in x, y, and z dimensions in millimeters. x represents the source width, y represents the source height, and z the source length. - ActivityConversionFactor (float): The activity-kerma conversion factor is used for converting activity (in mCi) to air-kerma strength (in U = cGy cm^2 / h). The unit of the factor is [U / mCi]. - CalculationModel (str): The dose calculation type used with this source model. Possible values are "Point source" and "Linear source". - DoseRateConstant (float): A conversion factor from the air-kerma strength to the dose rate in tissue. The unit of the dose rate constant is cGy / (h U). - HalfLife (float): The half life of the isotope in seconds. - LiteratureReference (str): The reference to the scientific publications on which the source model is based. - Manufacturer (str): The manufacturer of the modeled radioactive source. - SourceType (str): The DICOM source type. Possible values are "Point", "Line", "Cylinder", and "Sphere". - Status (str): The status of this source model. The status can be either "Unapproved", "Commissioning", "Approved", or "Retired". - StatusDate (Optional[datetime]): The time when the status of the source model was set. - StatusUserName (str): The name of the user who last set the status of the source model. - """ - def __init__(self) -> None: ... - - ActiveSize: VVector - - ActivityConversionFactor: float - - CalculationModel: str - - DoseRateConstant: float - - HalfLife: float - - LiteratureReference: str - - Manufacturer: str - - SourceType: str - - Status: str - - StatusDate: Optional[datetime] - - StatusUserName: str - - ActiveSize: VVector - - ActivityConversionFactor: float - - CalculationModel: str - - DoseRateConstant: float - - HalfLife: float - - LiteratureReference: str - - Manufacturer: str - - SourceType: str - - Status: str - - StatusDate: Optional[datetime] - - StatusUserName: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RangeModulator: - """ - The range modulator device. - - Attributes: - Type (RangeModulatorType): The type of the device. - Type (RangeModulatorType): The type of the device. - """ - def __init__(self) -> None: ... - - Type: RangeModulatorType - - Type: RangeModulatorType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RangeModulatorSettings: - """ - Range modulator settings. - - Attributes: - IsocenterToRangeModulatorDistance (float): Distance from the isocenter to the downstream edge of the range modulator (mm) at the current control point. - RangeModulatorGatingStartValue (float): Start position defines the range modulator position at which the beam is switched on. - RangeModulatorGatingStarWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Start Value. - RangeModulatorGatingStopValue (float): Stop position defines the range modulator position at which the beam is switched off. - RangeModulatorGatingStopWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Stop Value. - ReferencedRangeModulator (RangeModulator): The referenced range modulator. - IsocenterToRangeModulatorDistance (float): Distance from the isocenter to the downstream edge of the range modulator (mm) at the current control point. - RangeModulatorGatingStartValue (float): Start position defines the range modulator position at which the beam is switched on. - RangeModulatorGatingStarWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Start Value. - RangeModulatorGatingStopValue (float): Stop position defines the range modulator position at which the beam is switched off. - RangeModulatorGatingStopWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Stop Value. - ReferencedRangeModulator (RangeModulator): The referenced range modulator. - """ - def __init__(self) -> None: ... - - IsocenterToRangeModulatorDistance: float - - RangeModulatorGatingStartValue: float - - RangeModulatorGatingStarWaterEquivalentThickness: float - - RangeModulatorGatingStopValue: float - - RangeModulatorGatingStopWaterEquivalentThickness: float - - ReferencedRangeModulator: RangeModulator - - IsocenterToRangeModulatorDistance: float - - RangeModulatorGatingStartValue: float - - RangeModulatorGatingStarWaterEquivalentThickness: float - - RangeModulatorGatingStopValue: float - - RangeModulatorGatingStopWaterEquivalentThickness: float - - ReferencedRangeModulator: RangeModulator - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RangeShifter: - """ - The range shifter device. - - Attributes: - Type (RangeShifterType): The type of the device. - Type (RangeShifterType): The type of the device. - """ - def __init__(self) -> None: ... - - Type: RangeShifterType - - Type: RangeShifterType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RangeShifterSettings: - """ - Range shifter settings. - - Attributes: - IsocenterToRangeShifterDistance (float): Distance from the isocenter to the downstream edge of the range shifter (mm) at the current control point. - RangeShifterSetting (str): Machine-specific setting. - RangeShifterWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range shifter at the central axis for the beam energy incident upon the device. - ReferencedRangeShifter (RangeShifter): The referenced range shifter. - IsocenterToRangeShifterDistance (float): Distance from the isocenter to the downstream edge of the range shifter (mm) at the current control point. - RangeShifterSetting (str): Machine-specific setting. - RangeShifterWaterEquivalentThickness (float): Water equivalent thickness (in mm) of the range shifter at the central axis for the beam energy incident upon the device. - ReferencedRangeShifter (RangeShifter): The referenced range shifter. - """ - def __init__(self) -> None: ... - - IsocenterToRangeShifterDistance: float - - RangeShifterSetting: str - - RangeShifterWaterEquivalentThickness: float - - ReferencedRangeShifter: RangeShifter - - IsocenterToRangeShifterDistance: float - - RangeShifterSetting: str - - RangeShifterWaterEquivalentThickness: float - - ReferencedRangeShifter: RangeShifter - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RTPrescription: - """ - Represents a prescription. - - Attributes: - BolusFrequency (str): Bolus frequency (how often the bolus is present in the field). For example, daily. - BolusThickness (str): Thickness of the bolus to be used. - Energies (List[str]): The energies in the prescription. - EnergyModes (List[str]): The energy modes in the prescription. - Gating (str): Gating information. - LatestRevision (RTPrescription): Gets the latest revision of the current RT prescription. - Notes (str): Additional notes. - NumberOfFractions (Optional[int]): Number of fractions, optional. - OrgansAtRisk (List[RTPrescriptionOrganAtRisk]): Gets the organs at risk of the current RT prescription. - PhaseType (str): Type of the phase (primary/boost). - PredecessorPrescription (RTPrescription): Gets the previous version of the RT prescription if it exists. - RevisionNumber (int): Revision number of the prescription. - SimulationNeeded (Optional[bool]): Indicates if simulations need to be done before treatment planning. - Site (str): The treatment site in the prescription. - Status (str): Prescription status. - TargetConstraintsWithoutTargetLevel (List[RTPrescriptionTargetConstraints]): Coverage constraints for targets with no prescribed dose. - Targets (List[RTPrescriptionTarget]): Gets the targets of the current prescription. - Technique (str): Treatment technique to be used. - BolusFrequency (str): Bolus frequency (how often the bolus is present in the field). For example, daily. - BolusThickness (str): Thickness of the bolus to be used. - Energies (List[str]): The energies in the prescription. - EnergyModes (List[str]): The energy modes in the prescription. - Gating (str): Gating information. - LatestRevision (RTPrescription): Gets the latest revision of the current RT prescription. - Notes (str): Additional notes. - NumberOfFractions (Optional[int]): Number of fractions, optional. - OrgansAtRisk (List[RTPrescriptionOrganAtRisk]): Gets the organs at risk of the current RT prescription. - PhaseType (str): Type of the phase (primary/boost). - PredecessorPrescription (RTPrescription): Gets the previous version of the RT prescription if it exists. - RevisionNumber (int): Revision number of the prescription. - SimulationNeeded (Optional[bool]): Indicates if simulations need to be done before treatment planning. - Site (str): The treatment site in the prescription. - Status (str): Prescription status. - TargetConstraintsWithoutTargetLevel (List[RTPrescriptionTargetConstraints]): Coverage constraints for targets with no prescribed dose. - Targets (List[RTPrescriptionTarget]): Gets the targets of the current prescription. - Technique (str): Treatment technique to be used. - """ - def __init__(self) -> None: ... - - BolusFrequency: str - - BolusThickness: str - - Energies: List[str] - - EnergyModes: List[str] - - Gating: str - - LatestRevision: RTPrescription - - Notes: str - - NumberOfFractions: Optional[int] - - OrgansAtRisk: List[RTPrescriptionOrganAtRisk] - - PhaseType: str - - PredecessorPrescription: RTPrescription - - RevisionNumber: int - - SimulationNeeded: Optional[bool] - - Site: str - - Status: str - - TargetConstraintsWithoutTargetLevel: List[RTPrescriptionTargetConstraints] - - Targets: List[RTPrescriptionTarget] - - Technique: str - - BolusFrequency: str - - BolusThickness: str - - Energies: List[str] - - EnergyModes: List[str] - - Gating: str - - LatestRevision: RTPrescription - - Notes: str - - NumberOfFractions: Optional[int] - - OrgansAtRisk: List[RTPrescriptionOrganAtRisk] - - PhaseType: str - - PredecessorPrescription: RTPrescription - - RevisionNumber: int - - SimulationNeeded: Optional[bool] - - Site: str - - Status: str - - TargetConstraintsWithoutTargetLevel: List[RTPrescriptionTargetConstraints] - - Targets: List[RTPrescriptionTarget] - - Technique: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RTPrescriptionConstraint: - """ - Represents a coverage constraint for an RT prescription. - - Attributes: - ConstraintType (RTPrescriptionConstraintType): Type of the constraint. - Unit1 (str): Gy, %, or null - Unit2 (str): Gy, %, or null - Value1 (str): First numerical (or free text) part of the constraint. - Value2 (str): Second numerical (or free text) part of the constraint. - ConstraintType (RTPrescriptionConstraintType): Type of the constraint. - Unit1 (str): Gy, %, or null - Unit2 (str): Gy, %, or null - Value1 (str): First numerical (or free text) part of the constraint. - Value2 (str): Second numerical (or free text) part of the constraint. - """ - def __init__(self) -> None: ... - - ConstraintType: RTPrescriptionConstraintType - - Unit1: str - - Unit2: str - - Value1: str - - Value2: str - - ConstraintType: RTPrescriptionConstraintType - - Unit1: str - - Unit2: str - - Value1: str - - Value2: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RTPrescriptionOrganAtRisk: - """ - Represents an organ at risk structure. - - Attributes: - Constraints (List[RTPrescriptionConstraint]): Constraints. - OrganAtRiskId (str): Structure identifier of the organ at risk. - Constraints (List[RTPrescriptionConstraint]): Constraints. - OrganAtRiskId (str): Structure identifier of the organ at risk. - """ - def __init__(self) -> None: ... - - Constraints: List[RTPrescriptionConstraint] - - OrganAtRiskId: str - - Constraints: List[RTPrescriptionConstraint] - - OrganAtRiskId: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RTPrescriptionTarget: - """ - Represents a prescription target. - - Attributes: - Constraints (List[RTPrescriptionConstraint]): Coverage constraints. - DosePerFraction (DoseValue): Dose per fraction for this target. - NumberOfFractions (int): The number of fractions in the prescription. - TargetId (str): The ID of the target volume. - Type (RTPrescriptionTargetType): Type of the prescription target. It can be Isocenter, IsodoseLine, Volume or Depth. - Value (float): Defined when the target type is IsodoseLine or Depth. Unit is % for IsodoseLine or mm for Depth. Not defined for other prescription types. - Constraints (List[RTPrescriptionConstraint]): Coverage constraints. - DosePerFraction (DoseValue): Dose per fraction for this target. - NumberOfFractions (int): The number of fractions in the prescription. - TargetId (str): The ID of the target volume. - Type (RTPrescriptionTargetType): Type of the prescription target. It can be Isocenter, IsodoseLine, Volume or Depth. - Value (float): Defined when the target type is IsodoseLine or Depth. Unit is % for IsodoseLine or mm for Depth. Not defined for other prescription types. - """ - def __init__(self) -> None: ... - - Constraints: List[RTPrescriptionConstraint] - - DosePerFraction: DoseValue - - NumberOfFractions: int - - TargetId: str - - Type: RTPrescriptionTargetType - - Value: float - - Constraints: List[RTPrescriptionConstraint] - - DosePerFraction: DoseValue - - NumberOfFractions: int - - TargetId: str - - Type: RTPrescriptionTargetType - - Value: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class RTPrescriptionTargetConstraints: - """ - Represents target structure constraints. - - Attributes: - Constraints (List[RTPrescriptionConstraint]): Constraints. - TargetId (str): Identifier of the target structure. - Constraints (List[RTPrescriptionConstraint]): Constraints. - TargetId (str): Identifier of the target structure. - """ - def __init__(self) -> None: ... - - Constraints: List[RTPrescriptionConstraint] - - TargetId: str - - Constraints: List[RTPrescriptionConstraint] - - TargetId: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class SearchBodyParameters: - """ - Parameters for the Search Body feature. - - Attributes: - FillAllCavities (bool): Defines whether all cavities are filled. - KeepLargestParts (bool): Defines whether the largest part(s) of the Body structure are kept. - LowerHUThreshold (int): The lower threshold of the Hounsfield Unit value in the CT for the Search Body feature. - MREdgeThresholdHigh (int): Higher edge threshold for MR images. - MREdgeThresholdLow (int): Lower edge threshold for MR images. - NumberOfLargestPartsToKeep (int): The number of the largest parts in the Body structure that are kept. - PreCloseOpenings (bool): Defines whether to connect structure parts before extraction. - PreCloseOpeningsRadius (float): Radius setting for PreCloseOpenings. - PreDisconnect (bool): Defines whether to disconnect structure parts before extraction. - PreDisconnectRadius (float): Radius setting for PreDisconnect. - Smoothing (bool): Whether to do smoothing. - SmoothingLevel (int): Smoothing levels. - FillAllCavities (bool): Defines whether all cavities are filled. - KeepLargestParts (bool): Defines whether the largest part(s) of the Body structure are kept. - LowerHUThreshold (int): The lower threshold of the Hounsfield Unit value in the CT for the Search Body feature. - MREdgeThresholdHigh (int): Higher edge threshold for MR images. - MREdgeThresholdLow (int): Lower edge threshold for MR images. - NumberOfLargestPartsToKeep (int): The number of the largest parts in the Body structure that are kept. - PreCloseOpenings (bool): Defines whether to connect structure parts before extraction. - PreCloseOpeningsRadius (float): Radius setting for PreCloseOpenings. - PreDisconnect (bool): Defines whether to disconnect structure parts before extraction. - PreDisconnectRadius (float): Radius setting for PreDisconnect. - Smoothing (bool): Whether to do smoothing. - SmoothingLevel (int): Smoothing levels. - """ - def __init__(self) -> None: ... - - FillAllCavities: bool - - KeepLargestParts: bool - - LowerHUThreshold: int - - MREdgeThresholdHigh: int - - MREdgeThresholdLow: int - - NumberOfLargestPartsToKeep: int - - PreCloseOpenings: bool - - PreCloseOpeningsRadius: float - - PreDisconnect: bool - - PreDisconnectRadius: float - - Smoothing: bool - - SmoothingLevel: int - - FillAllCavities: bool - - KeepLargestParts: bool - - LowerHUThreshold: int - - MREdgeThresholdHigh: int - - MREdgeThresholdLow: int - - NumberOfLargestPartsToKeep: int - - PreCloseOpenings: bool - - PreCloseOpeningsRadius: float - - PreDisconnect: bool - - PreDisconnectRadius: float - - Smoothing: bool - - SmoothingLevel: int - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Loads the default values of the Search Body parameters. - def LoadDefaults(self) -> None: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Loads the default values of the Search Body parameters. - def LoadDefaults(self) -> None: - ... - - - -class SegmentVolume: - """ - The volumetric representation of a structure. This object is used when defining margins for structures, or when performing Boolean operations on structures. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to both this segment volume and another segment volume, that is, the intersection of this and the other segment volume. - def And(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this segment volume. - """ - ... - - - # Expands or shrinks this segment volume with the specified margins, aligned to the axes of the image coordinate system. - def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: - """ - Args: - margins: The margins in millimeters. The maximum is 50. - """ - ... - - - # Creates a new segment volume by expanding or shrinking this segment volume with the specified margin (in millimeters). A positive value creates an outer margin. A negative value creates an inner margin. - def Margin(self, marginInMM: float) -> SegmentVolume: - """ - Args: - marginInMM: The used margin in millimeters. The maximum is 50. - """ - ... - - - # Creates a combination of segment volumes. Does not modify this segment volume. The combination includes the area that covers everything else but this segment volume. - def Not(self) -> SegmentVolume: - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to this segment volume, to another segment volume, or both, that is, the union of this and the other segment volume. - def Or(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the area that belongs to this segment volume, but not to the other segment volume. - def Sub(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is subtracted from this segment volume. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong either to this segment volume or to another segment volume, but not to both of them. - def Xor(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to both this segment volume and another segment volume, that is, the intersection of this and the other segment volume. - def And(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this segment volume. - """ - ... - - - # Expands or shrinks this segment volume with the specified margins, aligned to the axes of the image coordinate system. - def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: - """ - Args: - margins: The margins in millimeters. The maximum is 50. - """ - ... - - - # Creates a new segment volume by expanding or shrinking this segment volume with the specified margin (in millimeters). A positive value creates an outer margin. A negative value creates an inner margin. - def Margin(self, marginInMM: float) -> SegmentVolume: - """ - Args: - marginInMM: The used margin in millimeters. The maximum is 50. - """ - ... - - - # Creates a combination of segment volumes. Does not modify this segment volume. The combination includes the area that covers everything else but this segment volume. - def Not(self) -> SegmentVolume: - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to this segment volume, to another segment volume, or both, that is, the union of this and the other segment volume. - def Or(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the area that belongs to this segment volume, but not to the other segment volume. - def Sub(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is subtracted from this segment volume. - """ - ... - - - # Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong either to this segment volume or to another segment volume, but not to both of them. - def Xor(self, other: SegmentVolume) -> SegmentVolume: - """ - Args: - other: The segment volume that is combined with this volume. - """ - ... - - - -class StandardWedge: - """ - A standard wedge is a physical piece of material with an angle that is static during treatment. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class BeamCalculationLog: - """ - Represents a beam calculation log. - - Attributes: - Beam (Beam): Used for navigating to parent Beam - Category (str): The log category, for example, "Dose", or "Optimization". - MessageLines (List[str]): The log as an array of lines. - Beam (Beam): Used for navigating to parent Beam - Category (str): The log category, for example, "Dose", or "Optimization". - MessageLines (List[str]): The log as an array of lines. - """ - def __init__(self) -> None: ... - - Beam: Beam - - Category: str - - MessageLines: List[str] - - Beam: Beam - - Category: str - - MessageLines: List[str] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Block: - """ - Represents a block add-on, a custom-made beam collimating material fixed to a tray, used to shape the beam. - - Attributes: - AddOnMaterial (AddOnMaterial): The dosimetric material of the block. - IsDiverging (bool): Checks if the block cut is diverging. - Outline (Array[Array[Windows.Point]]): The block outline points in field coordinates. - TransmissionFactor (float): The transmission factor of the selected material. - Tray (Tray): The tray on which the block is installed. - TrayTransmissionFactor (float): The transmission factor of the selected tray. - Type (BlockType): The type of the block: shielding or aperture. - AddOnMaterial (AddOnMaterial): The dosimetric material of the block. - IsDiverging (bool): Checks if the block cut is diverging. - Outline (Array[Array[Windows.Point]]): The block outline points in field coordinates. - TransmissionFactor (float): The transmission factor of the selected material. - Tray (Tray): The tray on which the block is installed. - TrayTransmissionFactor (float): The transmission factor of the selected tray. - Type (BlockType): The type of the block: shielding or aperture. - """ - def __init__(self) -> None: ... - - AddOnMaterial: AddOnMaterial - - IsDiverging: bool - - Outline: Array[Array[Windows.Point]] - - TransmissionFactor: float - - Tray: Tray - - TrayTransmissionFactor: float - - Type: BlockType - - AddOnMaterial: AddOnMaterial - - IsDiverging: bool - - Outline: Array[Array[Windows.Point]] - - TransmissionFactor: float - - Tray: Tray - - TrayTransmissionFactor: float - - Type: BlockType - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Bolus: - """ - Represents a bolus, which is custom-made material that is usually fixed to the patient's skin for treatment. The bolus is used to modulate the depth dose profile of a beam. - - Attributes: - Id (str): The identifier of the bolus. - MaterialCTValue (float): The CT value of the bolus material (HU). - Name (str): The name of the bolus. - Id (str): The identifier of the bolus. - MaterialCTValue (float): The CT value of the bolus material (HU). - Name (str): The name of the bolus. - """ - def __init__(self) -> None: ... - - Id: str - - MaterialCTValue: float - - Name: str - - Id: str - - MaterialCTValue: float - - Name: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Compensator: - """ - Represents a beam compensator add-on, a custom-made beam modulating material fixed to a tray, used to modulate the beam's intensity. - - Attributes: - Material (AddOnMaterial): The dosimetric material used in the compensator. - Slot (Slot): The slot into which the tray is inserted. - Tray (Tray): The tray to which the compensator is connected. - Material (AddOnMaterial): The dosimetric material used in the compensator. - Slot (Slot): The slot into which the tray is inserted. - Tray (Tray): The tray to which the compensator is connected. - """ - def __init__(self) -> None: ... - - Material: AddOnMaterial - - Slot: Slot - - Tray: Tray - - Material: AddOnMaterial - - Slot: Slot - - Tray: Tray - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ControlPoint: - """ - Represents a point in a planned sequence of treatment beam parameters. See the definition of control points in a DICOM RT Beam. - - Attributes: - Beam (Beam): Used for navigating to parent beam - CollimatorAngle (float): The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - GantryAngle (float): The gantry angle of the radiation source. In other words, the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. - JawPositions (VRect[float]): The positions of the beam collimator jaws (in mm) in the IEC BEAM LIMITING DEVICE coordinates. - LeafPositions (Array[float]): The positions of the beam collimator leaf pairs (in mm) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If there is no MLC, a (0,0)-length array is returned. - MetersetWeight (float): The cumulative meterset weight to this control point. The cumulative meterset weight for the first item in a control point sequence is zero. - PatientSupportAngle (float): The patient support angle. In other words, the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. - Beam (Beam): Used for navigating to parent beam - CollimatorAngle (float): The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees). - GantryAngle (float): The gantry angle of the radiation source. In other words, the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - Index (int): Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points. - JawPositions (VRect[float]): The positions of the beam collimator jaws (in mm) in the IEC BEAM LIMITING DEVICE coordinates. - LeafPositions (Array[float]): The positions of the beam collimator leaf pairs (in mm) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If there is no MLC, a (0,0)-length array is returned. - MetersetWeight (float): The cumulative meterset weight to this control point. The cumulative meterset weight for the first item in a control point sequence is zero. - PatientSupportAngle (float): The patient support angle. In other words, the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees). - TableTopLateralPosition (float): Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopLongitudinalPosition (float): Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system. - TableTopVerticalPosition (float): Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system. - - Note: - Control points are discussed in DICOM PS 3.3 C.8.8.14. All beams have at least two control points. Note that some values may be NaN if they are not applicable to the treatment plan in question. - """ - def __init__(self) -> None: ... - - Beam: Beam - - CollimatorAngle: float - - GantryAngle: float - - Index: int - - JawPositions: VRect[float] - - LeafPositions: Array[float] - - MetersetWeight: float - - PatientSupportAngle: float - - TableTopLateralPosition: float - - TableTopLongitudinalPosition: float - - TableTopVerticalPosition: float - - Beam: Beam - - CollimatorAngle: float - - GantryAngle: float - - Index: int - - JawPositions: VRect[float] - - LeafPositions: Array[float] - - MetersetWeight: float - - PatientSupportAngle: float - - TableTopLateralPosition: float - - TableTopLongitudinalPosition: float - - TableTopVerticalPosition: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ControlPointCollection: - """ - Represents a collection of machine parameters that describe the planned treatment beam. - - Attributes: - Count (int): The number of control points in the collection. - Count (int): The number of control points in the collection. - """ - def __init__(self) -> None: ... - - Count: int - - Count: int - - # Retrieves enumerator for ControlPoints in the collection. - def GetEnumerator(self) -> Iterable[ControlPoint]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Retrieves enumerator for ControlPoints in the collection. - def GetEnumerator(self) -> Iterable[ControlPoint]: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ApiDataObject: - """ - The base class of objects in the Eclipse Scripting API. - - Attributes: - Id (str): The identifier of the object. - Name (str): The name of the object. - Comment (str): A comment about the object. - HistoryUserName (str): The identifier of the last user who modified this object. - HistoryUserDisplayName (str): The name of the last user who modified this object. - HistoryDateTime (datetime): The date when this object was last modified. - Id (str): The identifier of the object. - Name (str): The name of the object. - Comment (str): A comment about the object. - HistoryUserName (str): The identifier of the last user who modified this object. - HistoryUserDisplayName (str): The name of the last user who modified this object. - HistoryDateTime (datetime): The date when this object was last modified. - """ - def __init__(self) -> None: ... - - Id: str - - Name: str - - Comment: str - - HistoryUserName: str - - HistoryUserDisplayName: str - - HistoryDateTime: datetime - - Id: str - - Name: str - - Comment: str - - HistoryUserName: str - - HistoryUserDisplayName: str - - HistoryDateTime: datetime - - # Returns a string that represents the current object. - def ToString(self) -> str: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream to which the object is serialized. - """ - ... - - - # Determines whether the specified Object is equal to the current Object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: Object to compare with the current object - """ - ... - - - # Serves as a hash function for this type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: ApiDataObject, b: ApiDataObject) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: ApiDataObject, b: ApiDataObject) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPIClinicalModifyingMethodGuard(self, param1: str) -> Any: - ... - - - # Throws an exception if the caller tries to add more scripting objects of certain types than a preset maximum limit allows. - def EnforceObjectLimits(self, callerMemberName: str) -> Any: - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPINonClinicalModifyingMethodGuard(self, param1: str) -> Any: - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPIClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: - """ - Args: - dataObj: The data object that is modified. - explicitCallerName: The API member that calls. - callerMemberName: The member that calls. - """ - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPINonClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: - """ - Args: - dataObj: The data object that is modified. - explicitCallerName: The API member that calls. - callerMemberName: The member that calls. - """ - ... - - - # Returns a string that represents the current object. - def ToString(self) -> str: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream to which the object is serialized. - """ - ... - - - # Determines whether the specified Object is equal to the current Object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: Object to compare with the current object - """ - ... - - - # Serves as a hash function for this type. - def GetHashCode(self) -> int: - ... - - - # The equality operator. - def op_Equality(self, a: ApiDataObject, b: ApiDataObject) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # The inequality operator. - def op_Inequality(self, a: ApiDataObject, b: ApiDataObject) -> bool: - """ - Args: - a: First operand. - b: Second operand. - """ - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPIClinicalModifyingMethodGuard(self, param1: str) -> Any: - ... - - - # Throws an exception if the caller tries to add more scripting objects of certain types than a preset maximum limit allows. - def EnforceObjectLimits(self, callerMemberName: str) -> Any: - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPINonClinicalModifyingMethodGuard(self, param1: str) -> Any: - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPIClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: - """ - Args: - dataObj: The data object that is modified. - explicitCallerName: The API member that calls. - callerMemberName: The member that calls. - """ - ... - - - # Throws an exception if the system is in the read-only state. - def GetESAPINonClinicalModifyingMethodGuard(self, dataObj: IDataObject, explicitCallerName: str, callerMemberName: str) -> Any: - """ - Args: - dataObj: The data object that is modified. - explicitCallerName: The API member that calls. - callerMemberName: The member that calls. - """ - ... - - - -class Application: - """ - The main application interface. - - Attributes: - CurrentUser (User): The user who is currently logged on. - PatientSummaries (List[PatientSummary]): Fetches patient summaries from the database. - Calculation (Calculation): Calculation related functions - StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. - Equipment (Equipment): Provides access to clinical devices and accessories. - ScriptEnvironment (ScriptEnvironment): Gets the script environment. - CurrentUser (User): The user who is currently logged on. - PatientSummaries (List[PatientSummary]): Fetches patient summaries from the database. - Calculation (Calculation): Calculation related functions - StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. - Equipment (Equipment): Provides access to clinical devices and accessories. - ScriptEnvironment (ScriptEnvironment): Gets the script environment. - """ - def __init__(self) -> None: ... - - CurrentUser: User - - PatientSummaries: List[PatientSummary] - - Calculation: Calculation - - StructureCodes: ActiveStructureCodeDictionaries - - Equipment: Equipment - - ScriptEnvironment: ScriptEnvironment - - CurrentUser: User - - PatientSummaries: List[PatientSummary] - - Calculation: Calculation - - StructureCodes: ActiveStructureCodeDictionaries - - Equipment: Equipment - - ScriptEnvironment: ScriptEnvironment - - # Releases all unmanaged resources of this object. - def Dispose(self) -> None: - ... - - - # Called only if user forgot to call Dispose() - def Finalize(self) -> Any: - ... - - - # Creates an application instance and logs into the system. - def CreateApplication(self, username: str, password: str) -> Application: - """ - Args: - username: Username for logging in or null value to invoke an interactive login dialog. - password: Password for logging in or null value to invoke an interactive login dialog. - """ - ... - - - # Creates an application instance for a standalone script and logs into the system. - def CreateApplication(self) -> Application: - ... - - - # Opens a patient. - def OpenPatient(self, patientSummary: PatientSummary) -> Patient: - """ - Args: - patientSummary: Patient summary. - """ - ... - - - # Opens a patient by using a patient identifier. - def OpenPatientById(self, id: str) -> Patient: - """ - Args: - id: Patient ID - """ - ... - - - # Closes the current patient. If the script tries to access the data of a closed patient, an access violation exception occurs. - def ClosePatient(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Saves data modifications to the database if saving is allowed. Note: Calling this method can cause a multi-user warning dialog box to appear if the same patient is modified by other parties. - def SaveModifications(self) -> None: - ... - - - # Add HIPAA log record if HIPAA is enabled - def LogExportToHipaa(self, patientId: str) -> Any: - ... - - - # CTRL+BREAK handler, stops script execution - def ConsoleEventHandler(self, eventCode: ConsoleHandlerEventCode) -> Any: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Releases all unmanaged resources of this object. - def Dispose(self) -> None: - ... - - - # Called only if user forgot to call Dispose() - def Finalize(self) -> Any: - ... - - - # Creates an application instance and logs into the system. - def CreateApplication(self, username: str, password: str) -> Application: - """ - Args: - username: Username for logging in or null value to invoke an interactive login dialog. - password: Password for logging in or null value to invoke an interactive login dialog. - """ - ... - - - # Creates an application instance for a standalone script and logs into the system. - def CreateApplication(self) -> Application: - ... - - - # Opens a patient. - def OpenPatient(self, patientSummary: PatientSummary) -> Patient: - """ - Args: - patientSummary: Patient summary. - """ - ... - - - # Opens a patient by using a patient identifier. - def OpenPatientById(self, id: str) -> Patient: - """ - Args: - id: Patient ID - """ - ... - - - # Closes the current patient. If the script tries to access the data of a closed patient, an access violation exception occurs. - def ClosePatient(self) -> None: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Saves data modifications to the database if saving is allowed. Note: Calling this method can cause a multi-user warning dialog box to appear if the same patient is modified by other parties. - def SaveModifications(self) -> None: - ... - - - # Add HIPAA log record if HIPAA is enabled - def LogExportToHipaa(self, patientId: str) -> Any: - ... - - - # CTRL+BREAK handler, stops script execution - def ConsoleEventHandler(self, eventCode: ConsoleHandlerEventCode) -> Any: - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Globals: - """ - This class is internal to the Eclipse Scripting API. - - Attributes: - AbortNow (bool): The flag that aborts script execution the next time any property or method of the Eclipse Scripting API is accessed. - DefaultMaximumNumberOfLoggedApiCalls (int): The default maximum number of API calls that are saved in the script execution log. - AbortNow (bool): The flag that aborts script execution the next time any property or method of the Eclipse Scripting API is accessed. - DefaultMaximumNumberOfLoggedApiCalls (int): The default maximum number of API calls that are saved in the script execution log. - """ - # Constructor - @overload - def __init__(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: - ... - - - # Constructor - @overload - def __init__(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: - ... - - - AbortNow: bool - - DefaultMaximumNumberOfLoggedApiCalls: int - - AbortNow: bool - - DefaultMaximumNumberOfLoggedApiCalls: int - - # Initialize custom log - def Initialize(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: - ... - - - # Checks if abort is needed and stops execution. - def CheckAbort(self) -> Any: - ... - - - # Uses System.Diagnostics.Trace with re-entrancy check for the Scripting API. - def Trace(self, message: str) -> Any: - ... - - - # Sets the maximum number of the API calls that are saved in the script execution log. This will clear the existing log entries. - def SetMaximumNumberOfLoggedApiCalls(self, apiLogCacheSize: int) -> None: - """ - Args: - apiLogCacheSize: The cache size for API call logs. Setting the value to zero disables logging. - """ - ... - - - # Returns the last called properties and methods. The oldest cached call is the first. The maximum number of logged calls is set by calling SetMaximumNumberOfLoggedApiCalls. - def GetLoggedApiCalls(self) -> List[str]: - ... - - - # Enables the getting of access information for API members through .NET trace listener. - def EnableApiAccessTrace(self) -> None: - ... - - - # Disables the getting of access information for API members through .NET trace listener. - def DisableApiAccessTrace(self) -> None: - ... - - - # Adds a log entry to custom script log file. - def AddCustomLogEntry(self, message: str, logSeverity: LogSeverity) -> None: - ... - - - # Initialize custom log - def Initialize(self, logger: ILogger, executingAssemblyName: Reflection.AssemblyName) -> None: - ... - - - # Checks if abort is needed and stops execution. - def CheckAbort(self) -> Any: - ... - - - # Uses System.Diagnostics.Trace with re-entrancy check for the Scripting API. - def Trace(self, message: str) -> Any: - ... - - - # Sets the maximum number of the API calls that are saved in the script execution log. This will clear the existing log entries. - def SetMaximumNumberOfLoggedApiCalls(self, apiLogCacheSize: int) -> None: - """ - Args: - apiLogCacheSize: The cache size for API call logs. Setting the value to zero disables logging. - """ - ... - - - # Returns the last called properties and methods. The oldest cached call is the first. The maximum number of logged calls is set by calling SetMaximumNumberOfLoggedApiCalls. - def GetLoggedApiCalls(self) -> List[str]: - ... - - - # Enables the getting of access information for API members through .NET trace listener. - def EnableApiAccessTrace(self) -> None: - ... - - - # Disables the getting of access information for API members through .NET trace listener. - def DisableApiAccessTrace(self) -> None: - ... - - - # Adds a log entry to custom script log file. - def AddCustomLogEntry(self, message: str, logSeverity: LogSeverity) -> None: - ... - - - -class DVHData: - """ - Represents Dose Volume Histogram (DVH) data. - - Attributes: - Coverage (float): The dose coverage of the target, normalized to 0.0 .. 1.0. - CurveData (Array[DVHPoint]): The points of the Dose Volume Histogram (DVH) curve. - MaxDose (DoseValue): The maximum dose. - MaxDosePosition (VVector): The position of the maximum dose. - MeanDose (DoseValue): The mean dose. - MedianDose (DoseValue): The median dose. - MinDose (DoseValue): The minimum dose. - MinDosePosition (VVector): The position of the minimum dose. - SamplingCoverage (float): The sampling coverage. - StdDev (float): The standard deviation. - Volume (float): The volume of the structure in cubic centimeters. - Coverage (float): The dose coverage of the target, normalized to 0.0 .. 1.0. - CurveData (Array[DVHPoint]): The points of the Dose Volume Histogram (DVH) curve. - MaxDose (DoseValue): The maximum dose. - MaxDosePosition (VVector): The position of the maximum dose. - MeanDose (DoseValue): The mean dose. - MedianDose (DoseValue): The median dose. - MinDose (DoseValue): The minimum dose. - MinDosePosition (VVector): The position of the minimum dose. - SamplingCoverage (float): The sampling coverage. - StdDev (float): The standard deviation. - Volume (float): The volume of the structure in cubic centimeters. - """ - def __init__(self) -> None: ... - - Coverage: float - - CurveData: Array[DVHPoint] - - MaxDose: DoseValue - - MaxDosePosition: VVector - - MeanDose: DoseValue - - MedianDose: DoseValue - - MinDose: DoseValue - - MinDosePosition: VVector - - SamplingCoverage: float - - StdDev: float - - Volume: float - - Coverage: float - - CurveData: Array[DVHPoint] - - MaxDose: DoseValue - - MaxDosePosition: VVector - - MeanDose: DoseValue - - MedianDose: DoseValue - - MinDose: DoseValue - - MinDosePosition: VVector - - SamplingCoverage: float - - StdDev: float - - Volume: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class DynamicWedge: - """ - A Dynamic Wedge is formed by a moving jaw of a standard collimator during irradiation. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class EnhancedDynamicWedge: - """ - An Enhanced Dynamic Wedge is similar to a Dynamic Wedge, but it features more wedge angles than a simple Dynamic Wedge. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class FieldReferencePoint: - """ - This object links a treatment beam to a reference point. - - Attributes: - EffectiveDepth (float): The effective depth of the field reference point. For arc fields this is the average value over the span of the arc. - FieldDose (DoseValue): The field dose. - IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. - IsPrimaryReferencePoint (bool): Checks if the reference point is primary. - ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. - RefPointLocation (VVector): The location of the reference point. - SSD (float): The Source-to-Skin Distance (SSD) of the reference point. For arc fields this is the average value over the span of the arc. - EffectiveDepth (float): The effective depth of the field reference point. For arc fields this is the average value over the span of the arc. - FieldDose (DoseValue): The field dose. - IsFieldDoseNominal (bool): Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation. - IsPrimaryReferencePoint (bool): Checks if the reference point is primary. - ReferencePoint (ReferencePoint): Used for navigating to an underlying reference point. - RefPointLocation (VVector): The location of the reference point. - SSD (float): The Source-to-Skin Distance (SSD) of the reference point. For arc fields this is the average value over the span of the arc. - """ - def __init__(self) -> None: ... - - EffectiveDepth: float - - FieldDose: DoseValue - - IsFieldDoseNominal: bool - - IsPrimaryReferencePoint: bool - - ReferencePoint: ReferencePoint - - RefPointLocation: VVector - - SSD: float - - EffectiveDepth: float - - FieldDose: DoseValue - - IsFieldDoseNominal: bool - - IsPrimaryReferencePoint: bool - - ReferencePoint: ReferencePoint - - RefPointLocation: VVector - - SSD: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Hospital: - """ - Represents a hospital. - - Attributes: - CreationDateTime (Optional[datetime]): The date when this object was created. - Location (str): The location of the hospital. - CreationDateTime (Optional[datetime]): The date when this object was created. - Location (str): The location of the hospital. - """ - def __init__(self) -> None: ... - - CreationDateTime: Optional[datetime] - - Location: str - - CreationDateTime: Optional[datetime] - - Location: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class ScriptContext: - """ - Contains the runtime context information of the active application for the script. - - Attributes: - CurrentUser (User): The current user of the application. - Course (Course): The course. The value may be null if the context has no course. - Image (Image): The 3D image. The value may be null if the context has no image. - StructureSet (StructureSet): The structure set. The value may be null if the context has no structure set. - Calculation (Calculation): Calculation related functions - StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. - Equipment (Equipment): Provides access to clinical devices and accessories. - Patient (Patient): The patient. The value may be null if the context has no patient. - PlanSetup (PlanSetup): The plan setup. The value may be null if the context has no plan setup. - ExternalPlanSetup (ExternalPlanSetup): The active external beam plan setup. The value is null if the active object is not an external beam plan setup. - BrachyPlanSetup (BrachyPlanSetup): The active brachytherapy plan setup. The value is null if the active object is not a brachytherapy plan setup. - IonPlanSetup (IonPlanSetup): The active proton plan setup. The value is null if the active object is not a proton plan setup. - PlansInScope (List[PlanSetup]): Retrieves a list of all plans in the Scope window. - ExternalPlansInScope (List[ExternalPlanSetup]): Retrieves a list of all external beam plans in the Scope window. - BrachyPlansInScope (List[BrachyPlanSetup]): Retrieves a list of all brachytherapy plans in the Scope window. - IonPlansInScope (List[IonPlanSetup]): Retrieves a list of all proton plans in the Scope window. - PlanSumsInScope (List[PlanSum]): Retrieves a list of all plan sums in the Scope window. - PlanSum (PlanSum): Retrieves the active plan sum. - ActiveStructure (Any): Retrieves the active structure. - ApplicationName (str): The name of the active application. - VersionInfo (str): The version number of Eclipse. - CurrentUser (User): The current user of the application. - Course (Course): The course. The value may be null if the context has no course. - Image (Image): The 3D image. The value may be null if the context has no image. - StructureSet (StructureSet): The structure set. The value may be null if the context has no structure set. - Calculation (Calculation): Calculation related functions - StructureCodes (ActiveStructureCodeDictionaries): Provides access to the structure code dictionaries with the active structure codes. - Equipment (Equipment): Provides access to clinical devices and accessories. - Patient (Patient): The patient. The value may be null if the context has no patient. - PlanSetup (PlanSetup): The plan setup. The value may be null if the context has no plan setup. - ExternalPlanSetup (ExternalPlanSetup): The active external beam plan setup. The value is null if the active object is not an external beam plan setup. - BrachyPlanSetup (BrachyPlanSetup): The active brachytherapy plan setup. The value is null if the active object is not a brachytherapy plan setup. - IonPlanSetup (IonPlanSetup): The active proton plan setup. The value is null if the active object is not a proton plan setup. - PlansInScope (List[PlanSetup]): Retrieves a list of all plans in the Scope window. - ExternalPlansInScope (List[ExternalPlanSetup]): Retrieves a list of all external beam plans in the Scope window. - BrachyPlansInScope (List[BrachyPlanSetup]): Retrieves a list of all brachytherapy plans in the Scope window. - IonPlansInScope (List[IonPlanSetup]): Retrieves a list of all proton plans in the Scope window. - PlanSumsInScope (List[PlanSum]): Retrieves a list of all plan sums in the Scope window. - PlanSum (PlanSum): Retrieves the active plan sum. - ActiveStructure (Any): Retrieves the active structure. - ApplicationName (str): The name of the active application. - VersionInfo (str): The version number of Eclipse. - """ - # Provides scripts an access to the current data context. A context instance is given as a parameter in the Execute function of the script. The script itself does not instantiate the context. - @overload - def __init__(self, context: Any, user: Any, dvhEstimation: Any, appName: str) -> None: - """ - Args: - context: The internal data context. - user: The internal user object. - dvhEstimation: The internal dvh estimation model library object. - appName: The application name. - """ - ... - - - # Provides scripts an access to the current data context. A context instance is given as a parameter in the Execute function of the script. The script itself does not instantiate the context. - @overload - def __init__(self, context: Any, user: Any, dvhEstimation: Any, appName: str) -> None: - """ - Args: - context: The internal data context. - user: The internal user object. - dvhEstimation: The internal dvh estimation model library object. - appName: The application name. - """ - ... - - - CurrentUser: User - - Course: Course - - Image: Image - - StructureSet: StructureSet - - Calculation: Calculation - - StructureCodes: ActiveStructureCodeDictionaries - - Equipment: Equipment - - Patient: Patient - - PlanSetup: PlanSetup - - ExternalPlanSetup: ExternalPlanSetup - - BrachyPlanSetup: BrachyPlanSetup - - IonPlanSetup: IonPlanSetup - - PlansInScope: List[PlanSetup] - - ExternalPlansInScope: List[ExternalPlanSetup] - - BrachyPlansInScope: List[BrachyPlanSetup] - - IonPlansInScope: List[IonPlanSetup] - - PlanSumsInScope: List[PlanSum] - - PlanSum: PlanSum - - ActiveStructure: Any - - ApplicationName: str - - VersionInfo: str - - CurrentUser: User - - Course: Course - - Image: Image - - StructureSet: StructureSet - - Calculation: Calculation - - StructureCodes: ActiveStructureCodeDictionaries - - Equipment: Equipment - - Patient: Patient - - PlanSetup: PlanSetup - - ExternalPlanSetup: ExternalPlanSetup - - BrachyPlanSetup: BrachyPlanSetup - - IonPlanSetup: IonPlanSetup - - PlansInScope: List[PlanSetup] - - ExternalPlansInScope: List[ExternalPlanSetup] - - BrachyPlansInScope: List[BrachyPlanSetup] - - IonPlansInScope: List[IonPlanSetup] - - PlanSumsInScope: List[PlanSum] - - PlanSum: PlanSum - - ActiveStructure: Any - - ApplicationName: str - - VersionInfo: str - - -class Isodose: - """ - Represents an isodose level for a fixed absolute or relative dose value. - - Attributes: - Color (Windows.Media.Color): The color of the isodose. - Level (DoseValue): The dose value of the isodose level. - MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The triangle mesh of the isodose. Returned for those isodose levels that are rendered in 3D in Eclipse. - Color (Windows.Media.Color): The color of the isodose. - Level (DoseValue): The dose value of the isodose level. - MeshGeometry (Windows.Media.Media3D.MeshGeometry3D): The triangle mesh of the isodose. Returned for those isodose levels that are rendered in 3D in Eclipse. - """ - def __init__(self) -> None: ... - - Color: Windows.Media.Color - - Level: DoseValue - - MeshGeometry: Windows.Media.Media3D.MeshGeometry3D - - Color: Windows.Media.Color - - Level: DoseValue - - MeshGeometry: Windows.Media.Media3D.MeshGeometry3D - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class MLC: - """ - Represents a Multileaf Collimator (MLC) add-on. - - Attributes: - ManufacturerName (str): The name of the manufacturer of the Multileaf Collimator (MLC). - MinDoseDynamicLeafGap (float): For dose-dynamic treatments, the minimum gap (mm) between moving, open leaf pairs that the Multileaf Collimator (MLC) hardware can handle. - Model (str): The number or name of the Multileaf Collimator (MLC) model. - SerialNumber (str): The serial number given to the Multileaf Collimator (MLC) by the factory. - ManufacturerName (str): The name of the manufacturer of the Multileaf Collimator (MLC). - MinDoseDynamicLeafGap (float): For dose-dynamic treatments, the minimum gap (mm) between moving, open leaf pairs that the Multileaf Collimator (MLC) hardware can handle. - Model (str): The number or name of the Multileaf Collimator (MLC) model. - SerialNumber (str): The serial number given to the Multileaf Collimator (MLC) by the factory. - """ - def __init__(self) -> None: ... - - ManufacturerName: str - - MinDoseDynamicLeafGap: float - - Model: str - - SerialNumber: str - - ManufacturerName: str - - MinDoseDynamicLeafGap: float - - Model: str - - SerialNumber: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class MotorizedWedge: - """ - A motorized wedge is a standard wedge placed in the beam for a user-defined fraction of the total treatment time. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class OmniWedge: - """ - An OmniWedge is a special type of wedge that combines an open field, a motorized wedge, and a virtual wedge to create the desired wedge effect. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Patient: - """ - Represents a patient. - - Attributes: - Courses (List[Course]): A collection of the patient's courses. - CreationDateTime (Optional[datetime]): The date when this object was created. - DateOfBirth (Optional[datetime]): The date of birth of the patient. - DefaultDepartment (str): The default department name. - FirstName (str): The first name of the patient. - HasModifiedData (bool): Returns true if the patient object tree has been modified. - Hospital (Hospital): The hospital. - Id2 (str): The patient ID2. - LastName (str): The last name of the patient. - MiddleName (str): The middle name of the patient. - PrimaryOncologistId (str): The identifier of the primary oncologist. - PrimaryOncologistName (str): The primary oncologist name. - ReferencePoints (List[ReferencePoint]): Collection of all reference points for the patient. - Registrations (List[Registration]): A collection of registrations. - Sex (str): The gender of the patient. - SSN (str): The Social Security Account Number (SSN) of the patient. - StructureSets (List[StructureSet]): A collection of structure sets. - Studies (List[Study]): A collection of studies. - Courses (List[Course]): A collection of the patient's courses. - CreationDateTime (Optional[datetime]): The date when this object was created. - DateOfBirth (Optional[datetime]): The date of birth of the patient. - DefaultDepartment (str): The default department name. - FirstName (str): The first name of the patient. - HasModifiedData (bool): Returns true if the patient object tree has been modified. - Hospital (Hospital): The hospital. - Id2 (str): The patient ID2. - LastName (str): The last name of the patient. - MiddleName (str): The middle name of the patient. - PrimaryOncologistId (str): The identifier of the primary oncologist. - PrimaryOncologistName (str): The primary oncologist name. - ReferencePoints (List[ReferencePoint]): Collection of all reference points for the patient. - Registrations (List[Registration]): A collection of registrations. - Sex (str): The gender of the patient. - SSN (str): The Social Security Account Number (SSN) of the patient. - StructureSets (List[StructureSet]): A collection of structure sets. - Studies (List[Study]): A collection of studies. - """ - def __init__(self) -> None: ... - - Courses: List[Course] - - CreationDateTime: Optional[datetime] - - DateOfBirth: Optional[datetime] - - DefaultDepartment: str - - FirstName: str - - HasModifiedData: bool - - Hospital: Hospital - - Id2: str - - LastName: str - - MiddleName: str - - PrimaryOncologistId: str - - PrimaryOncologistName: str - - ReferencePoints: List[ReferencePoint] - - Registrations: List[Registration] - - Sex: str - - SSN: str - - StructureSets: List[StructureSet] - - Studies: List[Study] - - Courses: List[Course] - - CreationDateTime: Optional[datetime] - - DateOfBirth: Optional[datetime] - - DefaultDepartment: str - - FirstName: str - - HasModifiedData: bool - - Hospital: Hospital - - Id2: str - - LastName: str - - MiddleName: str - - PrimaryOncologistId: str - - PrimaryOncologistName: str - - ReferencePoints: List[ReferencePoint] - - Registrations: List[Registration] - - Sex: str - - SSN: str - - StructureSets: List[StructureSet] - - Studies: List[Study] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new course to this patient. - def AddCourse(self) -> Course: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds an empty phantom image to the patient. The empty image is created in a new study. A new structure set is created for the image. - def AddEmptyPhantom(self, imageId: str, orientation: PatientOrientation, xSizePixel: int, ySizePixel: int, widthMM: float, heightMM: float, nrOfPlanes: int, planeSepMM: float) -> StructureSet: - """ - Args: - imageId: The identifier for the empty image to be created. The value must not be empty. - orientation: The patient orientation in the image. - xSizePixel: The x size of the image in pixels. The expected value is from 23 to 2048 pixels. - ySizePixel: The y size of the image in pixels. The expected value is from 23 to 2048 pixels. - widthMM: The height of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. - heightMM: The width of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. - nrOfPlanes: The number of planes in the image. The expected value is from 1 to 10000. - planeSepMM: The distance between the planes in millimeters. The expected value is from 0.1 to 200.0 millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add reference point to a patient - def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: - """ - Args: - target: True if point being added is for target volume - id: Identifier for the new reference point - """ - ... - - - # Enables write-access to the data model from the Scripting API. This function must be called for each patient the script modifies. If this function is not called, the data in the database cannot be modified. - def BeginModifications(self) -> None: - ... - - - # Checks if a new course can be added to the patient. - def CanAddCourse(self) -> bool: - ... - - - # Checks if an empty phantom can be added to the patient. The user should have the appropriate permissions to perform the operation. - def CanAddEmptyPhantom(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If phantom adding is not permitted, contains the error message. - """ - ... - - - # Checks if the image can be copied from the other patient. - def CanCopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str, errorMessage: str) -> bool: - """ - Args: - targetStudy: The target study for the new image series, or null. - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - errorMessage: If copying the image is not permitted, contains the error message. - """ - ... - - - # Returns true if the script can modify patient data in the database. - def CanModifyData(self) -> bool: - ... - - - # Checks if the course can be removed from the patient. - def CanRemoveCourse(self, course: Course) -> bool: - """ - Args: - course: The course to be removed. - """ - ... - - - # Checks if the image can be removed. The image to be removed and the associated structure set should be empty. - def CanRemoveEmptyPhantom(self, structureset: StructureSet, errorMessage: str) -> bool: - """ - Args: - structureset: The structure set to be removed. - errorMessage: If the image and associated structure set cannot be removed, contains the error message. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to this patient. A new study and series is created for the image. The method - def CopyImageFromOtherPatient(self, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: - """ - Args: - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to the given study. A new series is created for the image. The method - def CopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: - """ - Args: - targetStudy: The target study for the new image series. - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the course from the patient and deletes it. - def RemoveCourse(self, course: Course) -> None: - """ - Args: - course: The course that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes an empty image from the patient. The associated structure set is also removed. The image to be removed and the associated structure set should be empty. - def RemoveEmptyPhantom(self, structureset: StructureSet) -> None: - """ - Args: - structureset: The structure set to be removed. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Attaches a new course to this patient. - def AddCourse(self) -> Course: - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Adds an empty phantom image to the patient. The empty image is created in a new study. A new structure set is created for the image. - def AddEmptyPhantom(self, imageId: str, orientation: PatientOrientation, xSizePixel: int, ySizePixel: int, widthMM: float, heightMM: float, nrOfPlanes: int, planeSepMM: float) -> StructureSet: - """ - Args: - imageId: The identifier for the empty image to be created. The value must not be empty. - orientation: The patient orientation in the image. - xSizePixel: The x size of the image in pixels. The expected value is from 23 to 2048 pixels. - ySizePixel: The y size of the image in pixels. The expected value is from 23 to 2048 pixels. - widthMM: The height of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. - heightMM: The width of the image in millimeters. The expected value is from 10.0 to 2000.0 millimeters. - nrOfPlanes: The number of planes in the image. The expected value is from 1 to 10000. - planeSepMM: The distance between the planes in millimeters. The expected value is from 0.1 to 200.0 millimeters. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add reference point to a patient - def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: - """ - Args: - target: True if point being added is for target volume - id: Identifier for the new reference point - """ - ... - - - # Enables write-access to the data model from the Scripting API. This function must be called for each patient the script modifies. If this function is not called, the data in the database cannot be modified. - def BeginModifications(self) -> None: - ... - - - # Checks if a new course can be added to the patient. - def CanAddCourse(self) -> bool: - ... - - - # Checks if an empty phantom can be added to the patient. The user should have the appropriate permissions to perform the operation. - def CanAddEmptyPhantom(self, errorMessage: str) -> bool: - """ - Args: - errorMessage: If phantom adding is not permitted, contains the error message. - """ - ... - - - # Checks if the image can be copied from the other patient. - def CanCopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str, errorMessage: str) -> bool: - """ - Args: - targetStudy: The target study for the new image series, or null. - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - errorMessage: If copying the image is not permitted, contains the error message. - """ - ... - - - # Returns true if the script can modify patient data in the database. - def CanModifyData(self) -> bool: - ... - - - # Checks if the course can be removed from the patient. - def CanRemoveCourse(self, course: Course) -> bool: - """ - Args: - course: The course to be removed. - """ - ... - - - # Checks if the image can be removed. The image to be removed and the associated structure set should be empty. - def CanRemoveEmptyPhantom(self, structureset: StructureSet, errorMessage: str) -> bool: - """ - Args: - structureset: The structure set to be removed. - errorMessage: If the image and associated structure set cannot be removed, contains the error message. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to this patient. A new study and series is created for the image. The method - def CopyImageFromOtherPatient(self, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: - """ - Args: - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Copies an image from an other patient to the given study. A new series is created for the image. The method - def CopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: - """ - Args: - targetStudy: The target study for the new image series. - otherPatientId: The identifier of the other patient. - otherPatientStudyId: The identifier of the other patient's study. If null or empty, the system tries to find the image using only the 3D image identifier. - otherPatient3DImageId: The identifier of the other patient's 3D image. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes the course from the patient and deletes it. - def RemoveCourse(self, course: Course) -> None: - """ - Args: - course: The course that is removed. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Removes an empty image from the patient. The associated structure set is also removed. The image to be removed and the associated structure set should be empty. - def RemoveEmptyPhantom(self, structureset: StructureSet) -> None: - """ - Args: - structureset: The structure set to be removed. - """ - ... - - - -class PatientSummary: - """ - Basic information about the patient. - - Attributes: - CreationDateTime (Optional[datetime]): The date when the patient object was created. - DateOfBirth (Optional[datetime]): The date of birth of the patient. - FirstName (str): The first name of the patient. - Id (str): The patient ID. - Id2 (str): The patient ID2. - LastName (str): The last name of the patient. - MiddleName (str): The middle name of the patient. - Sex (str): The gender of the patient. - SSN (str): The Social Security Account Number (SSN) of the patient. - CreationDateTime (Optional[datetime]): The date when the patient object was created. - DateOfBirth (Optional[datetime]): The date of birth of the patient. - FirstName (str): The first name of the patient. - Id (str): The patient ID. - Id2 (str): The patient ID2. - LastName (str): The last name of the patient. - MiddleName (str): The middle name of the patient. - Sex (str): The gender of the patient. - SSN (str): The Social Security Account Number (SSN) of the patient. - """ - def __init__(self) -> None: ... - - CreationDateTime: Optional[datetime] - - DateOfBirth: Optional[datetime] - - FirstName: str - - Id: str - - Id2: str - - LastName: str - - MiddleName: str - - Sex: str - - SSN: str - - CreationDateTime: Optional[datetime] - - DateOfBirth: Optional[datetime] - - FirstName: str - - Id: str - - Id2: str - - LastName: str - - MiddleName: str - - Sex: str - - SSN: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class PlanningItem: - """ - Common properties of a treatment plan and a plan sum. - - Attributes: - Course (Course): Used for navigating to parent course. - CreationDateTime (Optional[datetime]): The date when this object was created. - Dose (PlanningItemDose): The total dose. The total dose is the dose of all planned fractions together. - DoseValuePresentation (DoseValuePresentation): The presentation of the dose as absolute or relative. - StructureSet (StructureSet): The structure set. - StructuresSelectedForDvh (List[Structure]): The collection of the structures that have been selected for DVH evaluation in Eclipse. - Course (Course): Used for navigating to parent course. - CreationDateTime (Optional[datetime]): The date when this object was created. - Dose (PlanningItemDose): The total dose. The total dose is the dose of all planned fractions together. - DoseValuePresentation (DoseValuePresentation): The presentation of the dose as absolute or relative. - StructureSet (StructureSet): The structure set. - StructuresSelectedForDvh (List[Structure]): The collection of the structures that have been selected for DVH evaluation in Eclipse. - """ - def __init__(self) -> None: ... - - Course: Course - - CreationDateTime: Optional[datetime] - - Dose: PlanningItemDose - - DoseValuePresentation: DoseValuePresentation - - StructureSet: StructureSet - - StructuresSelectedForDvh: List[Structure] - - Course: Course - - CreationDateTime: Optional[datetime] - - Dose: PlanningItemDose - - DoseValuePresentation: DoseValuePresentation - - StructureSet: StructureSet - - StructuresSelectedForDvh: List[Structure] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Get the list of clinical goals assigned to a planning item. - def GetClinicalGoals(self) -> List[ClinicalGoal]: - ... - - - # Returns cumulative Dose Volume Histogram (DVH) data. - def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: - """ - Args: - structure: Structure for which the DVH data is requested. - dosePresentation: Requested dose presentation mode (absolute or relative). Note, that only absolute dose is supported for PlanSums. - volumePresentation: Requested volume presentation mode. - binWidth: Requested width of the bin. - """ - ... - - - # Gets the dose at a volume. - def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: - """ - Args: - structure: Structure for which the value is requested. - volume: Volume at which the dose is requested. - volumePresentation: Presentation mode of the volume parameter. - requestedDosePresentation: Requested dose presentation mode (absolute or relative). - """ - ... - - - # Gets the volume at the dose. - def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: - """ - Args: - structure: Structure for which the value is requested. - dose: Dose at which the volume is requested. - requestedVolumePresentation: Requested volume presentation mode. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Get the list of clinical goals assigned to a planning item. - def GetClinicalGoals(self) -> List[ClinicalGoal]: - ... - - - # Returns cumulative Dose Volume Histogram (DVH) data. - def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: - """ - Args: - structure: Structure for which the DVH data is requested. - dosePresentation: Requested dose presentation mode (absolute or relative). Note, that only absolute dose is supported for PlanSums. - volumePresentation: Requested volume presentation mode. - binWidth: Requested width of the bin. - """ - ... - - - # Gets the dose at a volume. - def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: - """ - Args: - structure: Structure for which the value is requested. - volume: Volume at which the dose is requested. - volumePresentation: Presentation mode of the volume parameter. - requestedDosePresentation: Requested dose presentation mode (absolute or relative). - """ - ... - - - # Gets the volume at the dose. - def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: - """ - Args: - structure: Structure for which the value is requested. - dose: Dose at which the volume is requested. - requestedVolumePresentation: Requested volume presentation mode. - """ - ... - - - -class PlanSum: - """ - A plan sum describes the cumulative dose summation of several treatment plans. It can be used, for example, to evaluate the dose the patient received from a treatment plan and boost plan together. - - Attributes: - PlanSumComponents (List[PlanSumComponent]): A collection of plans in a plan sum. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSum. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the PlanSum. - PlanSetups (List[PlanSetup]): A collection of plan setups. - PlanSumComponents (List[PlanSumComponent]): A collection of plans in a plan sum. - Id (str): [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSum. - Name (str): [Availability of this property depends on your Eclipse Scripting API license] The name of the PlanSum. - PlanSetups (List[PlanSetup]): A collection of plan setups. - """ - def __init__(self) -> None: ... - - PlanSumComponents: List[PlanSumComponent] - - Id: str - - Name: str - - PlanSetups: List[PlanSetup] - - PlanSumComponents: List[PlanSumComponent] - - Id: str - - Name: str - - PlanSetups: List[PlanSetup] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum with default parameters ( - def AddItem(self, pi: PlanningItem) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum. If item to be added is a plan sum, all plans of the plan sum will be added. - def AddItem(self, pi: PlanningItem, operation: PlanSumOperation, planWeight: float) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - operation: The summing operation of the plan in the plan sum. - planWeight: Plan weight - """ - ... - - - # Returns the summing operation of the plan in the plan sum. - def GetPlanSumOperation(self, planSetupInPlanSum: PlanSetup) -> PlanSumOperation: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - """ - ... - - - # Returns the weight of the plan included in the sum. - def GetPlanWeight(self, planSetupInPlanSum: PlanSetup) -> float: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove a planning item from the plan sum. If item to be removed is a plan sum, all plans of the plan sum will be removed. - def RemoveItem(self, pi: PlanningItem) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the summing operation for the plan in the plan sum. - def SetPlanSumOperation(self, planSetupInPlanSum: PlanSetup, operation: PlanSumOperation) -> None: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - operation: The summing operation of the plan in the plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the weight of the plan included in the sum. - def SetPlanWeight(self, planSetupInPlanSum: PlanSetup, weight: float) -> None: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - weight: Plan weight - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum with default parameters ( - def AddItem(self, pi: PlanningItem) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Add a plan to the plan sum. If item to be added is a plan sum, all plans of the plan sum will be added. - def AddItem(self, pi: PlanningItem, operation: PlanSumOperation, planWeight: float) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - operation: The summing operation of the plan in the plan sum. - planWeight: Plan weight - """ - ... - - - # Returns the summing operation of the plan in the plan sum. - def GetPlanSumOperation(self, planSetupInPlanSum: PlanSetup) -> PlanSumOperation: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - """ - ... - - - # Returns the weight of the plan included in the sum. - def GetPlanWeight(self, planSetupInPlanSum: PlanSetup) -> float: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Remove a planning item from the plan sum. If item to be removed is a plan sum, all plans of the plan sum will be removed. - def RemoveItem(self, pi: PlanningItem) -> None: - """ - Args: - pi: Planning item, can be plan setup or plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the summing operation for the plan in the plan sum. - def SetPlanSumOperation(self, planSetupInPlanSum: PlanSetup, operation: PlanSumOperation) -> None: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - operation: The summing operation of the plan in the plan sum. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the weight of the plan included in the sum. - def SetPlanWeight(self, planSetupInPlanSum: PlanSetup, weight: float) -> None: - """ - Args: - planSetupInPlanSum: A plan that belongs to this plan sum, included in collection - weight: Plan weight - """ - ... - - - -class SerializableObject: - """ - Base class for objects that can be serialized. - """ - def __init__(self) -> None: ... - - # This member is internal to the Eclipse Scripting API. - def GetSchema(self) -> Xml.Schema.XmlSchema: - ... - - - # This member is internal to the Eclipse Scripting API. - def ReadXml(self, reader: Xml.XmlReader) -> None: - """ - Args: - reader: XmlReader - """ - ... - - - # Serializes this object to the given XmlWriter. - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: XmlWriter where this object is serialized. - """ - ... - - - # Serializes everything except IEnumerable. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Any) -> None: - """ - Args: - writer: XmlWriter - name: Name. - obj: Object. - """ - ... - - - # Serializes a string. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: str) -> None: - """ - Args: - writer: XmlWriter. - name: Name. - obj: String. - """ - ... - - - # Serializes IEnumerable. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: IEnumerable[T]) -> None: - ... - - - # Serializes IDictionary. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Dict[T, T2]) -> None: - ... - - - # Must be called at the beginning of serialization - def StartSerialization(self, typeName: str, typeId: str) -> Any: - """ - Args: - typeName: Name of the type to serialize. - typeId: Id of the object. - """ - ... - - - # Must be called at the end of serialization. Clear history records and type names. - def EndSerialization(self) -> Any: - ... - - - # Check if history contains information about class - def IsTypeSerialized(self) -> Any: - ... - - - # Add history record - def AddTypeToHistory(self) -> Any: - ... - - - # This member is internal to the Eclipse Scripting API. - def ClearSerializationHistory(self) -> None: - ... - - - # This member is internal to the Eclipse Scripting API. - def GetSchema(self) -> Xml.Schema.XmlSchema: - ... - - - # This member is internal to the Eclipse Scripting API. - def ReadXml(self, reader: Xml.XmlReader) -> None: - """ - Args: - reader: XmlReader - """ - ... - - - # Serializes this object to the given XmlWriter. - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: XmlWriter where this object is serialized. - """ - ... - - - # Serializes everything except IEnumerable. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Any) -> None: - """ - Args: - writer: XmlWriter - name: Name. - obj: Object. - """ - ... - - - # Serializes a string. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: str) -> None: - """ - Args: - writer: XmlWriter. - name: Name. - obj: String. - """ - ... - - - # Serializes IEnumerable. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: IEnumerable[T]) -> None: - ... - - - # Serializes IDictionary. - def WriteXml(self, writer: Xml.XmlWriter, name: str, obj: Dict[T, T2]) -> None: - ... - - - # Must be called at the beginning of serialization - def StartSerialization(self, typeName: str, typeId: str) -> Any: - """ - Args: - typeName: Name of the type to serialize. - typeId: Id of the object. - """ - ... - - - # Must be called at the end of serialization. Clear history records and type names. - def EndSerialization(self) -> Any: - ... - - - # Check if history contains information about class - def IsTypeSerialized(self) -> Any: - ... - - - # Add history record - def AddTypeToHistory(self) -> Any: - ... - - - # This member is internal to the Eclipse Scripting API. - def ClearSerializationHistory(self) -> None: - ... - - - -class Registration: - """ - Represents the spatial registration matrix between two frames of reference. - - Attributes: - CreationDateTime (Optional[datetime]): The date when this object was created. - RegisteredFOR (str): The frame of reference UID of the registered coordinate system. - SourceFOR (str): The frame of reference UID of the source coordinate system. - Status (RegistrationApprovalStatus): The current approval status of the registration. - StatusDateTime (Optional[datetime]): The approval status date and time. - StatusUserDisplayName (str): Full user name of user who changed the approval status. - StatusUserName (str): User ID of the user who changed the approval status. - TransformationMatrix (Array[float]): The elements of the 4x4 transformation matrix. - UID (str): The SOP Instance UID of this registration object. - CreationDateTime (Optional[datetime]): The date when this object was created. - RegisteredFOR (str): The frame of reference UID of the registered coordinate system. - SourceFOR (str): The frame of reference UID of the source coordinate system. - Status (RegistrationApprovalStatus): The current approval status of the registration. - StatusDateTime (Optional[datetime]): The approval status date and time. - StatusUserDisplayName (str): Full user name of user who changed the approval status. - StatusUserName (str): User ID of the user who changed the approval status. - TransformationMatrix (Array[float]): The elements of the 4x4 transformation matrix. - UID (str): The SOP Instance UID of this registration object. - """ - def __init__(self) -> None: ... - - CreationDateTime: Optional[datetime] - - RegisteredFOR: str - - SourceFOR: str - - Status: RegistrationApprovalStatus - - StatusDateTime: Optional[datetime] - - StatusUserDisplayName: str - - StatusUserName: str - - TransformationMatrix: Array[float] - - UID: str - - CreationDateTime: Optional[datetime] - - RegisteredFOR: str - - SourceFOR: str - - Status: RegistrationApprovalStatus - - StatusDateTime: Optional[datetime] - - StatusUserDisplayName: str - - StatusUserName: str - - TransformationMatrix: Array[float] - - UID: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Transforms a point in the inverse direction, that is, from the coordinate system of the RegisteredFOR to the coordinate system of the SourceFOR. - def InverseTransformPoint(self, pt: VVector) -> VVector: - """ - Args: - pt: Point in the RegisteredFOR coordinate system. - """ - ... - - - # Transforms a point from the SourceFOR coordinate system to the RegisteredFOR coordinate system. - def TransformPoint(self, pt: VVector) -> VVector: - """ - Args: - pt: Point in the SourceFOR coordinate system. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Transforms a point in the inverse direction, that is, from the coordinate system of the RegisteredFOR to the coordinate system of the SourceFOR. - def InverseTransformPoint(self, pt: VVector) -> VVector: - """ - Args: - pt: Point in the RegisteredFOR coordinate system. - """ - ... - - - # Transforms a point from the SourceFOR coordinate system to the RegisteredFOR coordinate system. - def TransformPoint(self, pt: VVector) -> VVector: - """ - Args: - pt: Point in the SourceFOR coordinate system. - """ - ... - - - -class Series: - """ - A series is a collection of radiation therapy objects of a patient. The series is part of a study. See the definition of a DICOM Series for more information. - - Attributes: - FOR (str): The UID of the frame of reference. - Images (List[Image]): A collection of images that belong to the series. - ImagingDeviceDepartment (str): The assigned department of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device department is not defined. - ImagingDeviceId (str): The identifier of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device identifier is not defined. - ImagingDeviceManufacturer (str): The manufacturer of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device manufacturer is not defined. - ImagingDeviceModel (str): The model of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device model is not defined. - ImagingDeviceSerialNo (str): The serial number of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device serial number is not defined. - Modality (SeriesModality): The modality of the series. - Study (Study): Used for navigating to parent study. - UID (str): The DICOM UID. - FOR (str): The UID of the frame of reference. - Images (List[Image]): A collection of images that belong to the series. - ImagingDeviceDepartment (str): The assigned department of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device department is not defined. - ImagingDeviceId (str): The identifier of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device identifier is not defined. - ImagingDeviceManufacturer (str): The manufacturer of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device manufacturer is not defined. - ImagingDeviceModel (str): The model of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device model is not defined. - ImagingDeviceSerialNo (str): The serial number of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device serial number is not defined. - Modality (SeriesModality): The modality of the series. - Study (Study): Used for navigating to parent study. - UID (str): The DICOM UID. - """ - def __init__(self) -> None: ... - - FOR: str - - Images: List[Image] - - ImagingDeviceDepartment: str - - ImagingDeviceId: str - - ImagingDeviceManufacturer: str - - ImagingDeviceModel: str - - ImagingDeviceSerialNo: str - - Modality: SeriesModality - - Study: Study - - UID: str - - FOR: str - - Images: List[Image] - - ImagingDeviceDepartment: str - - ImagingDeviceId: str - - ImagingDeviceManufacturer: str - - ImagingDeviceModel: str - - ImagingDeviceSerialNo: str - - Modality: SeriesModality - - Study: Study - - UID: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the imaging device for the image series based on the identifier of the imaging device. If the imaging device identifier is not found, an exception is thrown. - def SetImagingDevice(self, imagingDeviceId: str) -> None: - """ - Args: - imagingDeviceId: Identifier of the imaging device. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # [Availability of this method depends on your Eclipse Scripting API license] Sets the imaging device for the image series based on the identifier of the imaging device. If the imaging device identifier is not found, an exception is thrown. - def SetImagingDevice(self, imagingDeviceId: str) -> None: - """ - Args: - imagingDeviceId: Identifier of the imaging device. - """ - ... - - - -class Slot: - """ - A slot is the location (typically on the collimator head of the gantry) where an add-on, such as a wedge or block, is mounted. - - Attributes: - Number (int): The slot number is unique within an instance of a treatment machine. - Number (int): The slot number is unique within an instance of a treatment machine. - """ - def __init__(self) -> None: ... - - Number: int - - Number: int - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Study: - """ - A study is a collection of series. - - Attributes: - CreationDateTime (Optional[datetime]): The date when this object was created. - Images3D (List[Image]): A collection of 3D images in a study. - Series (List[Series]): A collection of series. - UID (str): The DICOM UID. - CreationDateTime (Optional[datetime]): The date when this object was created. - Images3D (List[Image]): A collection of 3D images in a study. - Series (List[Series]): A collection of series. - UID (str): The DICOM UID. - """ - def __init__(self) -> None: ... - - CreationDateTime: Optional[datetime] - - Images3D: List[Image] - - Series: List[Series] - - UID: str - - CreationDateTime: Optional[datetime] - - Images3D: List[Image] - - Series: List[Series] - - UID: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Technique: - """ - Treatment technique used for a beam. Can be, for example, static or arc, or (for proton beams) modulated scanning. - - Attributes: - IsArc (bool): Returns the value true if the beam technique is 'ARC' or 'SRS ARC'. - IsModulatedScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING'. - IsProton (bool): Returns the value true if it is a proton beam. - IsScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING' or 'UNIFORM_SCANNING'. - IsStatic (bool): Returns the value true if the beam technique is 'STATIC' or 'SRS STATIC'. - IsArc (bool): Returns the value true if the beam technique is 'ARC' or 'SRS ARC'. - IsModulatedScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING'. - IsProton (bool): Returns the value true if it is a proton beam. - IsScanning (bool): Returns the value true if the beam technique is 'MODULAT_SCANNING' or 'UNIFORM_SCANNING'. - IsStatic (bool): Returns the value true if the beam technique is 'STATIC' or 'SRS STATIC'. - """ - def __init__(self) -> None: ... - - IsArc: bool - - IsModulatedScanning: bool - - IsProton: bool - - IsScanning: bool - - IsStatic: bool - - IsArc: bool - - IsModulatedScanning: bool - - IsProton: bool - - IsScanning: bool - - IsStatic: bool - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class TradeoffObjective: - """ - Trade-off objective interface that consists of a set of optimization objectives. - - Attributes: - Id (int): Identifier of the trade-off objective. - OptimizationObjectives (List[OptimizationObjective]): The collection of objectives that this trade-off objective represents. - Structure (Structure): Structure that this trade-off objective represents. - Id (int): Identifier of the trade-off objective. - OptimizationObjectives (List[OptimizationObjective]): The collection of objectives that this trade-off objective represents. - Structure (Structure): Structure that this trade-off objective represents. - """ - def __init__(self) -> None: ... - - Id: int - - OptimizationObjectives: List[OptimizationObjective] - - Structure: Structure - - Id: int - - OptimizationObjectives: List[OptimizationObjective] - - Structure: Structure - - -class Tray: - """ - A tray add-on is a plate where blocks, compensators, and other beam modifying materials can be fixed to. The tray is inserted into a slot during the treatment of a beam. - """ - def __init__(self) -> None: ... - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class TreatmentPhase: - """ - Treatment phase. - - Attributes: - OtherInfo (str): Other info (notes). - PhaseGapNumberOfDays (int): Number of days between phases. - Prescriptions (List[RTPrescription]): A collection of RT prescriptions in the course. - TimeGapType (str): Type of the time gap. - OtherInfo (str): Other info (notes). - PhaseGapNumberOfDays (int): Number of days between phases. - Prescriptions (List[RTPrescription]): A collection of RT prescriptions in the course. - TimeGapType (str): Type of the time gap. - """ - def __init__(self) -> None: ... - - OtherInfo: str - - PhaseGapNumberOfDays: int - - Prescriptions: List[RTPrescription] - - TimeGapType: str - - OtherInfo: str - - PhaseGapNumberOfDays: int - - Prescriptions: List[RTPrescription] - - TimeGapType: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class TreatmentSession: - """ - Treatment session. - - Attributes: - SessionNumber (int): Treatment session number. - SessionPlans (List[PlanTreatmentSession]): Plans in this treatment session. - SessionNumber (int): Treatment session number. - SessionPlans (List[PlanTreatmentSession]): Plans in this treatment session. - """ - def __init__(self) -> None: ... - - SessionNumber: int - - SessionPlans: List[PlanTreatmentSession] - - SessionNumber: int - - SessionPlans: List[PlanTreatmentSession] - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class TreatmentUnitOperatingLimit: - """ - Describes the limits of a treatment unit parameter and provides descriptive information related to it. - - Attributes: - Label (str): Gets the descriptive name of the operating limit parameter. - MaxValue (float): Gets the maximum allowed value for the operating limit parameter. - MinValue (float): Gets the minimum allowed value for the operating limit parameter. - Precision (Optional[int]): Gets the number of decimal places to display for the operating limit parameter. - UnitString (str): Gets the string that describes the unit of the operating limit parameter. - Label (str): Gets the descriptive name of the operating limit parameter. - MaxValue (float): Gets the maximum allowed value for the operating limit parameter. - MinValue (float): Gets the minimum allowed value for the operating limit parameter. - Precision (Optional[int]): Gets the number of decimal places to display for the operating limit parameter. - UnitString (str): Gets the string that describes the unit of the operating limit parameter. - """ - def __init__(self) -> None: ... - - Label: str - - MaxValue: float - - MinValue: float - - Precision: Optional[int] - - UnitString: str - - Label: str - - MaxValue: float - - MinValue: float - - Precision: Optional[int] - - UnitString: str - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class TreatmentUnitOperatingLimits: - """ - Provides operating limit information for treatment unit parameters. - - Attributes: - CollimatorAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the collimator angle parameter. - GantryAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the gantry angle parameter. - MU (TreatmentUnitOperatingLimit): Gets the operating limit information for the monitor unit (MU) parameter. - PatientSupportAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the patient support angle parameter. - CollimatorAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the collimator angle parameter. - GantryAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the gantry angle parameter. - MU (TreatmentUnitOperatingLimit): Gets the operating limit information for the monitor unit (MU) parameter. - PatientSupportAngle (TreatmentUnitOperatingLimit): Gets the operating limit information for the patient support angle parameter. - """ - def __init__(self) -> None: ... - - CollimatorAngle: TreatmentUnitOperatingLimit - - GantryAngle: TreatmentUnitOperatingLimit - - MU: TreatmentUnitOperatingLimit - - PatientSupportAngle: TreatmentUnitOperatingLimit - - CollimatorAngle: TreatmentUnitOperatingLimit - - GantryAngle: TreatmentUnitOperatingLimit - - MU: TreatmentUnitOperatingLimit - - PatientSupportAngle: TreatmentUnitOperatingLimit - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - -class Wedge: - """ - A wedge is a beam modulating add-on that modifies the dose intensity over all or a part of a treatment beam. - - Attributes: - Direction (float): The wedge orientation with respect to the beam orientation, in degrees. - WedgeAngle (float): The wedge angle. - Direction (float): The wedge orientation with respect to the beam orientation, in degrees. - WedgeAngle (float): The wedge angle. - - Note: - Use run-time type information via operator - """ - def __init__(self) -> None: ... - - Direction: float - - WedgeAngle: float - - Direction: float - - WedgeAngle: float - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - # Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream, to which the object is serialized. - """ - ... - - - diff --git a/pyesapi/VMS/TPS/Common/Model/API/AsyncPump/AsyncPump.pyi b/pyesapi/VMS/TPS/Common/Model/API/AsyncPump/AsyncPump.pyi deleted file mode 100644 index 1cdb928..0000000 --- a/pyesapi/VMS/TPS/Common/Model/API/AsyncPump/AsyncPump.pyi +++ /dev/null @@ -1,211 +0,0 @@ -""" -Type stubs for VMS.TPS.Common.Model.API.AsyncPump -Generated from .NET XML documentation -""" - -from typing import Any, List, Optional, Union, Dict, Iterable, overload -from datetime import datetime -from System import Array, Double, Single, Int32, Boolean, String -from System.Collections.Generic import KeyValuePair -from System import Collections - -class SingleThreadSynchronizationContext: - """ - Provides a SynchronizationContext object that is single-threaded. - """ - def __init__(self) -> None: ... - - # Dispatches an asynchronous message to the synchronization context. - def Post(self, d: Threading.SendOrPostCallback, state: Any) -> Any: - """ - Args: - d: The System.Threading.SendOrPostCallback delegate to call. - state: The object passed to the delegate. - """ - ... - - - # Not supported. - def Send(self, param1: Threading.SendOrPostCallback, param2: Any) -> Any: - ... - - - # Runs an loop to process all queued work items. - def RunOnCurrentThread(self) -> Any: - ... - - - # Notifies the context that no more work will arrive. - def Complete(self) -> Any: - ... - - - # Dispatches an asynchronous message to the synchronization context. - def Post(self, d: Threading.SendOrPostCallback, state: Any) -> Any: - """ - Args: - d: The System.Threading.SendOrPostCallback delegate to call. - state: The object passed to the delegate. - """ - ... - - - # Not supported. - def Send(self, param1: Threading.SendOrPostCallback, param2: Any) -> Any: - ... - - - # Runs an loop to process all queued work items. - def RunOnCurrentThread(self) -> Any: - ... - - - # Notifies the context that no more work will arrive. - def Complete(self) -> Any: - ... - - - -class SingleThreadSynchronizationContextSetter: - """ - Provides a temporary single-threaded environment until the diposal of this object ( - """ - # Sets SynchronizationContext to a - @overload - def __init__(self) -> None: - ... - - - # Sets SynchronizationContext to a - @overload - def __init__(self) -> None: - ... - - - # Resets the SynchronizationContext. - def Dispose(self) -> Any: - ... - - - def Complete(self) -> Any: - ... - - - def Run(self) -> Any: - ... - - - # Resets the SynchronizationContext. - def Dispose(self) -> Any: - ... - - - def Complete(self) -> Any: - ... - - - def Run(self) -> Any: - ... - - - -class SingleThreadSynchronizationContext: - """ - Provides a SynchronizationContext object that is single-threaded. - """ - def __init__(self) -> None: ... - - # Dispatches an asynchronous message to the synchronization context. - def Post(self, d: Threading.SendOrPostCallback, state: Any) -> Any: - """ - Args: - d: The System.Threading.SendOrPostCallback delegate to call. - state: The object passed to the delegate. - """ - ... - - - # Not supported. - def Send(self, param1: Threading.SendOrPostCallback, param2: Any) -> Any: - ... - - - # Runs an loop to process all queued work items. - def RunOnCurrentThread(self) -> Any: - ... - - - # Notifies the context that no more work will arrive. - def Complete(self) -> Any: - ... - - - # Dispatches an asynchronous message to the synchronization context. - def Post(self, d: Threading.SendOrPostCallback, state: Any) -> Any: - """ - Args: - d: The System.Threading.SendOrPostCallback delegate to call. - state: The object passed to the delegate. - """ - ... - - - # Not supported. - def Send(self, param1: Threading.SendOrPostCallback, param2: Any) -> Any: - ... - - - # Runs an loop to process all queued work items. - def RunOnCurrentThread(self) -> Any: - ... - - - # Notifies the context that no more work will arrive. - def Complete(self) -> Any: - ... - - - -class SingleThreadSynchronizationContextSetter: - """ - Provides a temporary single-threaded environment until the diposal of this object ( - """ - # Sets SynchronizationContext to a - @overload - def __init__(self) -> None: - ... - - - # Sets SynchronizationContext to a - @overload - def __init__(self) -> None: - ... - - - # Resets the SynchronizationContext. - def Dispose(self) -> Any: - ... - - - def Complete(self) -> Any: - ... - - - def Run(self) -> Any: - ... - - - # Resets the SynchronizationContext. - def Dispose(self) -> Any: - ... - - - def Complete(self) -> Any: - ... - - - def Run(self) -> Any: - ... - - - diff --git a/pyesapi/VMS/TPS/Common/Model/API/Calculation/Calculation.pyi b/pyesapi/VMS/TPS/Common/Model/API/Calculation/Calculation.pyi deleted file mode 100644 index 7bd1f31..0000000 --- a/pyesapi/VMS/TPS/Common/Model/API/Calculation/Calculation.pyi +++ /dev/null @@ -1,39 +0,0 @@ -""" -Type stubs for VMS.TPS.Common.Model.API.Calculation -Generated from .NET XML documentation -""" - -from typing import Any, List, Optional, Union, Dict, Iterable -from datetime import datetime -from System import Array, Double, Single, Int32, Boolean, String -from System.Collections.Generic import KeyValuePair -from System import Collections - -class Algorithm: - """ - Algorithm - """ - def __init__(self) -> None: ... - - -class CalculationModel: - """ - Calculation Model - """ - def __init__(self) -> None: ... - - -class Algorithm: - """ - Algorithm - """ - def __init__(self) -> None: ... - - -class CalculationModel: - """ - Calculation Model - """ - def __init__(self) -> None: ... - - diff --git a/pyesapi/VMS/TPS/Common/Model/Types/DoseValue/DoseValue.pyi b/pyesapi/VMS/TPS/Common/Model/Types/DoseValue/DoseValue.pyi deleted file mode 100644 index 001ed79..0000000 --- a/pyesapi/VMS/TPS/Common/Model/Types/DoseValue/DoseValue.pyi +++ /dev/null @@ -1,18 +0,0 @@ -""" -Type stubs for VMS.TPS.Common.Model.Types.DoseValue -Generated from .NET XML documentation -""" - -from typing import Any, List, Optional, Union, Dict, Iterable -from datetime import datetime -from System import Array, Double, Single, Int32, Boolean, String -from System.Collections.Generic import KeyValuePair -from System import Collections - -class DoseUnit: - """ - The unit of the dose value. - """ - def __init__(self) -> None: ... - - diff --git a/pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/PlanValidationResultDetail.pyi b/pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/PlanValidationResultDetail.pyi deleted file mode 100644 index 6fb7b64..0000000 --- a/pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/PlanValidationResultDetail.pyi +++ /dev/null @@ -1,18 +0,0 @@ -""" -Type stubs for VMS.TPS.Common.Model.Types.PlanValidationResultDetail -Generated from .NET XML documentation -""" - -from typing import Any, List, Optional, Union, Dict, Iterable -from datetime import datetime -from System import Array, Double, Single, Int32, Boolean, String -from System.Collections.Generic import KeyValuePair -from System import Collections - -class ResultClassification: - """ - Classification of plan validation detail. - """ - def __init__(self) -> None: ... - - diff --git a/pyesapi/VMS/TPS/Common/Model/Types/Types.pyi b/pyesapi/VMS/TPS/Common/Model/Types/Types.pyi deleted file mode 100644 index 0b804cb..0000000 --- a/pyesapi/VMS/TPS/Common/Model/Types/Types.pyi +++ /dev/null @@ -1,2468 +0,0 @@ -""" -Type stubs for VMS.TPS.Common.Model.Types -Generated from .NET XML documentation -""" - -from typing import Any, List, Optional, Union, Dict, Iterable, TypeVar, Generic, overload -from datetime import datetime -from System import Array, Double, Single, Int32, Boolean, String -from System.Collections.Generic import KeyValuePair -from System import Collections - -# Generic type variables -T = TypeVar('T') -T1 = TypeVar('T1') -T2 = TypeVar('T2') -T3 = TypeVar('T3') - -class BeamNumber: - """ - Represents a unique identifier for a beam of a plan. The identifier is unique within the scope of the plan. - - Attributes: - Number (int): The beam number. - IsValid (bool): Returns true if the given BeamNumber is valid. Otherwise false. - """ - # Constructs a new beam number from a numeric beam number. - @overload - def __init__(self, number: int) -> None: - """ - Args: - number: Make sure that the beam number corresponds to the real beam number, otherwise use NotABeamNumber. - """ - ... - - - # Constructs a new beam number from another BeamNumber. - @overload - def __init__(self, other: BeamNumber) -> None: - """ - Args: - other: Another BeamNumber. - """ - ... - - - Number: int - - IsValid: bool - - # Compares two beam numbers for equality. - def op_Equality(self, a: BeamNumber, b: BeamNumber) -> bool: - """ - Args: - a: The first object to compare. - b: The second object to compare. - """ - ... - - - # Compares two BeamNumbers for inequality. - def op_Inequality(self, a: BeamNumber, b: BeamNumber) -> bool: - """ - Args: - a: The first object to compare. - b: The second object to compare. - """ - ... - - - # Compares two BeamNumbers, a and b, to determine if a is greater than b. - def op_GreaterThan(self, a: BeamNumber, b: BeamNumber) -> bool: - """ - Args: - a: The first object to compare. - b: The second object to compare. - """ - ... - - - # Compares two BeamNumbers, a and b, to determine if a is smaller than b. - def op_LessThan(self, a: BeamNumber, b: BeamNumber) -> bool: - """ - Args: - a: The first object to compare. - b: The second object to compare. - """ - ... - - - # Compares two BeamNumbers, a and b, to determine if a is greater than or equal to b. - def op_GreaterThanOrEqual(self, a: BeamNumber, b: BeamNumber) -> bool: - """ - Args: - a: The first object to compare. - b: The second object to compare. - """ - ... - - - # Compares two BeamNumbers, a and b, to determine if a is smaller than or equal to b. - def op_LessThanOrEqual(self, a: BeamNumber, b: BeamNumber) -> bool: - """ - Args: - a: The first object to compare. - b: The second object to compare. - """ - ... - - - # Converts a BeamNumber to an int. - def op_Implicit(self, bn: Int32) -> int: - """ - Args: - bn: The converted BeamNumber object. - """ - ... - - - # Provides a hash code for the item, see - def GetHashCode(self) -> int: - ... - - - # Determines whether the specified object is equal to the current object. - def Equals(self, other: Any) -> bool: - """ - Args: - other: The other object to compare. - """ - ... - - - # Indicates whether the current object is equal to another object of the same type. - def Equals(self, other: BeamNumber) -> bool: - """ - Args: - other: An object to compare with this object. - """ - ... - - - # This member is internal to the Eclipse Scripting API. - def GetSchema(self) -> Xml.Schema.XmlSchema: - ... - - - # This member is internal to the Eclipse Scripting API. - def ReadXml(self, reader: Xml.XmlReader) -> None: - """ - Args: - reader: The XmlReader stream from which the object is deserialized. - """ - ... - - - # Serialization support. - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream to which the object is serialized. - """ - ... - - - -class StructureMarginGeometry: - """ - Specifies whether a margin operation expands (outer margin) or shrinks (inner margin) the volume. - """ - def __init__(self) -> None: ... - - -class AxisAlignedMargins: - """ - Represents margins aligned to the axes of the image coordinate system, in mm. Negative margins are not allowed, but it is possible to specify whether the margins represent an inner or outer margin. - """ - # Constructs a new AxisAlignedMargins instance. The given margins are aligned to the axes of the image coordinate system, in mm. - def __init__(self, geometry: StructureMarginGeometry, x1: float, y1: float, z1: float, x2: float, y2: float, z2: float) -> None: - """ - Args: - geometry: Specifies whether the margin operation expands (outer margin) or shrinks (inner margin) the volume. - x1: A non-negative value defining the margin towards the negative X axis, in mm. - y1: A non-negative value defining the margin towards the negative Y axis, in mm. - z1: A non-negative value defining the margin towards the negative Z axis, in mm. - x2: A non-negative value defining the margin towards the positive X axis, in mm. - y2: A non-negative value defining the margin towards the positive Y axis, in mm. - z2: A non-negative value defining the margin towards the positive Z axis, in mm. - """ - ... - - - # A string that represents the current object. - def ToString(self) -> str: - ... - - - -class ChangeBrachyTreatmentUnitResult: - """ - Return value for - """ - def __init__(self) -> None: ... - - -class ObjectiveGoalType: - """ - Clinical goal Objective type - """ - def __init__(self) -> None: ... - - -class ObjectiveOperator: - """ - Clinical goal Objective operator - """ - def __init__(self) -> None: ... - - -class ObjectiveUnit: - """ - Clinical goal Objective Unit - """ - def __init__(self) -> None: ... - - -class Objective: - """ - Represents a clinical goal objective. - - Attributes: - Type (ObjectiveGoalType): Objective type - Value (float): Objective value - ValueUnit (ObjectiveUnit): Objective value - Operator (ObjectiveOperator): Objective operator - Limit (float): Objective limit - LimitUnit (ObjectiveUnit): Objective limit unit - """ - # Clinical Goal Objective constructor - def __init__(self, type: ObjectiveGoalType, value: float, valueUnit: ObjectiveUnit, oper: ObjectiveOperator, limit: float, limitUnit: ObjectiveUnit) -> None: - """ - Args: - type: Objective type. - value: Objective value. - valueUnit: Value unit. - oper: Operator. - limit: Limit. - limitUnit: Limit unit. - """ - ... - - - Type: ObjectiveGoalType - - Value: float - - ValueUnit: ObjectiveUnit - - Operator: ObjectiveOperator - - Limit: float - - LimitUnit: ObjectiveUnit - - # This member is internal to the Eclipse Scripting API. - def GetSchema(self) -> Xml.Schema.XmlSchema: - ... - - - # This member is internal to the Eclipse Scripting API. - def ReadXml(self, reader: Xml.XmlReader) -> None: - """ - Args: - reader: XmlReader. - """ - ... - - - # Serialization support. TODO: Convert unit and operator to human form. - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream to which the object is serialized. - """ - ... - - - -class ClinicalGoal: - """ - Represents a clinical goal. - - Attributes: - MeasureType (MeasureType): Clinical goal measure type - StructureId (str): Clinical goal structure Id - Objective (Objective): Clinical goal objective - ObjectiveAsString (str): String representation of clinical goal objective - Priority (GoalPriority): Goal priority (0-4), where 0 is Most Important - VariationAcceptable (float): Clinical goal Variation Acceptable (tolerance) - VariationAcceptableAsString (str): String representation of clinical goal Variation Acceptable (tolerance) - ActualValue (float): Clinical goal actual value - ActualValueAsString (str): String representation of clinical goal actual value - EvaluationResult (GoalEvalResult): Evaluation result. - """ - # Construct a ClinicalGoal - def __init__(self, measureType: MeasureType, structureId: str, objective: Objective, objAsString: str, priority: GoalPriority, tolerance: float, toleranceAsString: str, actual: float, actualAsString: str, evalResult: GoalEvalResult) -> None: - """ - Args: - measureType: Measure Type. - structureId: Structure ID. - objective: Objective. - objAsString: Objective as a string. - priority: Priority. - tolerance: Tolerance. - toleranceAsString: Tolerance as a string. - actual: Actual value. - actualAsString: Actual value as a string. - evalResult: Goal evaluation result. - """ - ... - - - MeasureType: MeasureType - - StructureId: str - - Objective: Objective - - ObjectiveAsString: str - - Priority: GoalPriority - - VariationAcceptable: float - - VariationAcceptableAsString: str - - ActualValue: float - - ActualValueAsString: str - - EvaluationResult: GoalEvalResult - - # This member is internal to the Eclipse Scripting API. - def GetSchema(self) -> Xml.Schema.XmlSchema: - ... - - - # This member is internal to the Eclipse Scripting API. - def ReadXml(self, reader: Xml.XmlReader) -> None: - """ - Args: - reader: XmlReader. - """ - ... - - - # Serialization support. - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream to which the object is serialized. - """ - ... - - - -class IDoseValueDisplaySettings: - """ - Application specific dose value display settings. - """ - def __init__(self) -> None: ... - - # Determines how many decimals to use to display a dosevalue with specified unit. - def Decimals(self, unit: DoseUnit) -> int: - """ - Args: - unit: DoseUnit for which the number of decimals is requested. - """ - ... - - - -class DoseValueDisplayConfig: - """ - Configure the settings related to the dose value display for the application. Defaults to the same settings as Eclipse. - - Attributes: - DisplaySettings (IDoseValueDisplaySettings): Get and set current dosevalue display settings. Set settings controller to null reverts to default display settings. - """ - def __init__(self) -> None: ... - - DisplaySettings: IDoseValueDisplaySettings - - # Get number of decimals to user for dosevalue of the defined dose unit - def Decimals(self, unit: DoseUnit) -> int: - """ - Args: - unit: DoseUnit for which the number of decimals is requested. - """ - ... - - - -class DoseValue: - """ - Represents a dose value. DoseValue semantics follows the semantics of System.Double, with DoseValue.Undefined corresponding to Double.NaN. - - Attributes: - Dose (float): The value of this instance. - Unit (DoseValue+DoseUnit): The unit of this instance. - UnitAsString (str): The unit of this instance as a string. - ValueAsString (str): The value of this instance as a string. - IsAbsoluteDoseValue (bool): Returns true if the unit of the dose value is absolute (Gy or cGy). - IsRelativeDoseValue (bool): Returns true if the unit of the dose value is relative (%). - Decimals (int): The display precision of this value - """ - # Constructs a DoseValue. - @overload - def __init__(self, value: float, unitName: str) -> None: - """ - Args: - value: Value for this instance. - unitName: String that corresponds to one of the enumeration values of DoseUnit. - """ - ... - - - # Constructs a DoseValue. - @overload - def __init__(self, value: float, unit: DoseUnit) -> None: - """ - Args: - value: Value for this instance - unit: Unit of this instance. - """ - ... - - - Dose: float - - Unit: DoseValue+DoseUnit - - UnitAsString: str - - ValueAsString: str - - IsAbsoluteDoseValue: bool - - IsRelativeDoseValue: bool - - Decimals: int - - # Equality comparison of DoseValue and Object. This method considers two instances of DoseValue.Undefined to be equal to each other. Otherwise, a dose value is equal to an object only if the object is a DoseValue and the units and the values are equal. For epsilon-equal comparison, use - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: Object to compare this to. - """ - ... - - - # A hash code for the current object. - def GetHashCode(self) -> int: - ... - - - # Equality comparison of dose values. This method considers two instances of DoseValue.Undefined to be equal to each other. Otherwise, two dose values are equal only if the units and the values are equal. For epsilon-equal comparison, use - def Equals(self, other: DoseValue) -> bool: - """ - Args: - other: Dose value to compare this to. - """ - ... - - - # Epsilon-equality comparison of dose values. This method considers two instances of DoseValue.Undefined to be equal to each other. Otherwise, two dose values are equal only if the units are equal and the values are within epsilon. - def Equals(self, other: DoseValue, epsilon: float) -> bool: - """ - Args: - other: Dose value to compare this to. - epsilon: Epsilon to use for the dose value comparison. - """ - ... - - - # Equality operator for dose values. This operator considers two instances of DoseValue.Undefined to be inequal. For epsilon-equal comparison, use - def op_Equality(self, dv1: DoseValue, dv2: DoseValue) -> bool: - """ - Args: - dv1: First operand. - dv2: Second operand. - """ - ... - - - # Inequality operator for dose values. This operator considers two instances of DoseValue.Undefined to be inequal. For epsilon-equal comparison, use - def op_Inequality(self, dv1: DoseValue, dv2: DoseValue) -> bool: - """ - Args: - dv1: First operand. - dv2: Second operand. - """ - ... - - - # Comparison of dose values. DoseValue.Undefined preceeds other values. Otherwise, different units cause an exception to be thrown. The values are compared using Double.CompareTo(Double). - def CompareTo(self, other: DoseValue) -> int: - """ - Args: - other: Dose value to compare this to. - """ - ... - - - # Less-than comparison of dose values. Comparison with DoseValue.Undefined is false. - def op_LessThan(self, dv1: DoseValue, dv2: DoseValue) -> bool: - """ - Args: - dv1: First operand. - dv2: Second operand. - """ - ... - - - # Less-than-or-equal comparison of dose values. Comparison with DoseValue.Undefined is false. - def op_LessThanOrEqual(self, dv1: DoseValue, dv2: DoseValue) -> bool: - """ - Args: - dv1: First operand. - dv2: Second operand. - """ - ... - - - # Greater-than comparison of dose values. Comparison with DoseValue.Undefined is false. - def op_GreaterThan(self, dv1: DoseValue, dv2: DoseValue) -> bool: - """ - Args: - dv1: First operand. - dv2: Second operand. - """ - ... - - - # Greater-than comparison of dose values. Comparison with DoseValue.Undefined is false. - def op_GreaterThanOrEqual(self, dv1: DoseValue, dv2: DoseValue) -> bool: - """ - Args: - dv1: First operand. - dv2: Second operand. - """ - ... - - - # Subtraction of dose values. If either of the operands is DoseValue.Undefined, the result will be DoseValue.Undefined. - def op_Subtraction(self, dv1: DoseValue, dv2: DoseValue) -> DoseValue: - """ - Args: - dv1: First operand. - dv2: Second operand. - """ - ... - - - # Addition of dose values. If either of the operands is DoseValue.Undefined, the result will be DoseValue.Undefined. - def op_Addition(self, dv1: DoseValue, dv2: DoseValue) -> DoseValue: - """ - Args: - dv1: First operand. - dv2: Second operand. - """ - ... - - - # Multiplication of a dose value and a double. If the dose value is DoseValue.Undefined, the result will be DoseValue.Undefined. - def op_Multiply(self, dv: DoseValue, dbl: float) -> DoseValue: - """ - Args: - dv: DoseValue to multiply. - dbl: Multiplier. - """ - ... - - - # Multiplication of a dose value and a double. If the dose value is DoseValue.Undefined, the result will be DoseValue.Undefined. - def op_Multiply(self, dbl: float, dv: DoseValue) -> DoseValue: - """ - Args: - dbl: Multiplier. - dv: DoseValue to multiply. - """ - ... - - - # Division of a dose value by a double. If the dose value is DoseValue.Undefined, the result will be DoseValue.Undefined. - def op_Division(self, dv: DoseValue, dbl: float) -> DoseValue: - """ - Args: - dv: Dividend. - dbl: Divisor. - """ - ... - - - # Division of two dose values. If either of the operands is DoseValue.Undefined, the result will be Double.NaN. - def op_Division(self, dv1: DoseValue, dv2: DoseValue) -> DoseValue: - """ - Args: - dv1: Dividend. - dv2: Divisor. - """ - ... - - - # Returns true if the dose unit is absolute (Gy or cGy). - def IsAbsoluteDoseUnit(self, doseUnit: DoseUnit) -> bool: - """ - Args: - doseUnit: The dose unit that is evaluated. - """ - ... - - - # Returns true if the dose unit is relative (%). - def IsRelativeDoseUnit(self, doseUnit: DoseUnit) -> bool: - """ - Args: - doseUnit: The dose unit that is evaluated. - """ - ... - - - # A string that represents the current object. - def ToString(self) -> str: - ... - - - # A dose value, for which the value is Double.NaN and the unit is unknown. - def UndefinedDose(self) -> DoseValue: - ... - - - # Returns true if this dose value is equal to DoseValue.Undefined, false otherwise. - def IsUndefined(self) -> bool: - ... - - - # This member is internal to the Eclipse Scripting API. - def GetSchema(self) -> Xml.Schema.XmlSchema: - ... - - - # This member is internal to the Eclipse Scripting API. - def ReadXml(self, reader: Xml.XmlReader) -> None: - """ - Args: - reader: XmlReader. - """ - ... - - - # Serialization support. - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream to which the object is serialized. - """ - ... - - - -class SingleLayerParameters: - """ - One layer or group of DRR calculation parameters. - - Attributes: - LayerOn (bool): Defines whether the layer of parameters are selected. - Weight (float): Weight factor of the DRR layer. Value must be between -100.0 and 100.0. - CTFrom (float): Lower end of the CT window. Value must be between -1024.0 and 6000.0. - CTTo (float): Upper end of the CT window. Value must be between -1024.0 and 6000.0. - GeoClipping (bool): Image volume type on which the DRR calculation is based. If calculation is based on partial image volume as specified by - GeoFrom (float): Starting distance from the isocenter. Value must be between -10000 and 10000 mm. - GeoTo (float): Ending distance from the isocenter. Value must be between -10000 and 10000 mm. - """ - def __init__(self) -> None: ... - - LayerOn: bool - - Weight: float - - CTFrom: float - - CTTo: float - - GeoClipping: bool - - GeoFrom: float - - GeoTo: float - - -class DRRCalculationParameters: - """ - Parameters for DRR calculation. - - Attributes: - DRRSize (float): DRR size. Decreasing the size of the DRR effectively increases the resolution of the DRR. Value must be between 5 and 5120 mm. - StructureOutlines (bool): Defines if structure outlines are added as layers in the DRR. - FieldOutlines (bool): Defines if field outlines (MLC, CIAO etc.) are added as layers in the DRR. - """ - # Creates a new set of DRR calculation parameters with default values. - @overload - def __init__(self) -> None: - ... - - - # Creates a new set of DRR calculation parameters with a specified DRR size. - @overload - def __init__(self, drrSize: float) -> None: - """ - Args: - drrSize: DRR size in mm. - """ - ... - - - # Creates a new set of DRR calculation parameters. - @overload - def __init__(self, drrSize: float, weight: float, ctFrom: float, ctTo: float) -> None: - """ - Args: - drrSize: DRR size in mm. Value must be between 5 and 5120 mm. - weight: DRR layer weight. Value must be between -100.0 and 100.0. - ctFrom: Lower end of the CT window. Value must be between -1024.0 and 6000.0. - ctTo: Upper end of the CT window. Value must be between -1024.0 and 6000.0. - """ - ... - - - # Creates a new set of DRR calculation parameters. - @overload - def __init__(self, drrSize: float, weight: float, ctFrom: float, ctTo: float, geoFrom: float, geoTo: float) -> None: - """ - Args: - drrSize: DRR size in mm. Value must be between 5 and 5120 mm. - weight: DRR layer weight. Value must be between -100.0 and 100.0. - ctFrom: Lower end of the CT window. Value must be between -1024.0 and 6000.0. - ctTo: Upper end of the CT window. Value must be between -1024.0 and 6000.0. - geoFrom: Starting distance from the isocenter. Value must be between -10000 and 10000 mm. - geoTo: Ending distance from the isocenter. Value must be between -10000 and 10000 mm. - """ - ... - - - DRRSize: float - - StructureOutlines: bool - - FieldOutlines: bool - - # Gets a single layer of editable DRR calculation parameters. - def GetLayerParameters(self, index: int) -> SingleLayerParameters: - """ - Args: - index: Layer index. Value must be between 0 and 2. - """ - ... - - - # Sets parameters for - def SetLayerParameters(self, index: int, weight: float, ctFrom: float, ctTo: float) -> None: - """ - Args: - index: Layer index. - weight: DRR layer weight. Value must be between -100.0 and 100.0. - ctFrom: Lower end of the CT window. Value must be between -1024.0 and 6000.0. - ctTo: Upper end of the CT window. Value must be between -1024.0 and 6000.0. - """ - ... - - - # Sets parameters for - def SetLayerParameters(self, index: int, weight: float, ctFrom: float, ctTo: float, geoFrom: float, geoTo: float) -> None: - """ - Args: - index: Layer index. - weight: DRR layer weight. Value must be between -100.0 and 100.0. - ctFrom: Lower end of the CT window. Value must be between -1024.0 and 6000.0. - ctTo: Upper end of the CT window. Value must be between -1024.0 and 6000.0. - geoFrom: Starting distance from the isocenter. Value must be between -10000 and 10000 mm. - geoTo: Ending distance from the isocenter. Value must be between -10000 and 10000 mm. - """ - ... - - - -class DVHPoint: - """ - Represents a value on a Dose Volume Histogram (DVH) curve. - - Attributes: - DoseValue (DoseValue): The dose value of the point. - Volume (float): The volume value of the point. - VolumeUnit (str): The volume unit of the point. - """ - # Constructs a DVHPoint. - def __init__(self, dose: DoseValue, volume: float, volumeUnit: str) -> None: - """ - Args: - dose: Dose value of the point. - volume: Volume value of the point. - volumeUnit: Unit of volume. - """ - ... - - - DoseValue: DoseValue - - Volume: float - - VolumeUnit: str - - # This member is internal to the Eclipse Scripting API. - def GetSchema(self) -> Xml.Schema.XmlSchema: - ... - - - # This member is internal to the Eclipse Scripting API. - def ReadXml(self, reader: Xml.XmlReader) -> None: - """ - Args: - reader: XmlReader. - """ - ... - - - # Serialization support. - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream to which the object is serialized. - """ - ... - - - -class ExternalBeamMachineParameters: - """ - The parameters for the external beam treatment unit. - - Attributes: - MachineId (str): The treatment unit identifier. - EnergyModeId (str): The energy mode identifier. For example, "6X", or "18X". - DoseRate (int): Dose rate value. - PrimaryFluenceModeId (str): Primary Fluence Mode identifier. Acceptable values are: null, empty string, "SRS","FFF". - TechniqueId (str): Technique identifier. Typically "STATIC" or "ARC". - MLCId (str): Optional MLC identifier. If null (which is the default) then the single MLC of the treatment unit is selected. - """ - # Assigns the parameters to the properties for external beams. - @overload - def __init__(self, doseRate: str, energyModeId: str, machineId: int, primaryFluenceModeId: str, techniqueId: str) -> None: - """ - Args: - doseRate: Dose rate value. - energyModeId: The energy mode identifier. For example, "6X", or "18X". - machineId: The treatment unit identifier. - primaryFluenceModeId: Primary Fluence Mode ID. Acceptable values are: null, empty string, "SRS","FFF". - techniqueId: Technique identifier. Typically "STATIC" or "ARC". - """ - ... - - - # Assigns the Treatment Unit ID to the properties. Rest of the properties are left empty. These parameters will work for Halcyon machine when adding imaging setup or Fixed Sequence beam. For other types of beams, define all properties. - @overload - def __init__(self, machineId: str) -> None: - """ - Args: - machineId: The treatment unit identifier. - """ - ... - - - MachineId: str - - EnergyModeId: str - - DoseRate: int - - PrimaryFluenceModeId: str - - TechniqueId: str - - MLCId: str - - -class FitToStructureMarginType: - """ - Margin type - """ - def __init__(self) -> None: ... - - -class FitToStructureMargins: - """ - Margins that are used when fitting a field device to a structure from the BEV perspective - """ - # Constructs a new FitToStructureMargins instance with elliptical margin type. - @overload - def __init__(self, x1: float, y1: float, x2: float, y2: float) -> None: - """ - Args: - x1: Margin x1 in mm - y1: Margin y1 in mm - x2: Margin x2 in mm - y2: Margin y2 in mm - """ - ... - - - # Constructs a new FitToStructureMargins instance with circular margin type. - @overload - def __init__(self, margin: float) -> None: - """ - Args: - margin: Uniform margin for all directions in mm - """ - ... - - - # A string that represents the current object. - def ToString(self) -> str: - ... - - - -class Fluence: - """ - Represents the fluence for a beam. The resolution in the fluence matrix is 2.5 mm in x and y directions. In the fluence matrix, x dimension is the number of columns, and y dimension is the number of rows. - - Attributes: - MaxSizePixel (int): The maximum size of pixels for x or y dimension in the fluence. - XSizePixel (int): The size of x dimension in pixels for the fluence. This corresponds to the number of columns in the pixels matrix. - YSizePixel (int): The size of y dimension in pixels for the fluence. This corresponds to the number of rows in the pixels matrix. - XSizeMM (float): The size of x dimension in mm for the fluence. The resolution is 2.5 mm in x and y directions. - YSizeMM (float): The size of y dimension in mm for the fluence. The resolution is 2.5 mm in x and y directions. - XOrigin (float): The x coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. - YOrigin (float): The y coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. - MLCId (str): The identifier of the MLC that is related to the fluence. The value can be empty or null. - """ - # Constructor. - @overload - def __init__(self, fluenceMatrix: Array[float], xOrigin: float, yOrigin: float) -> None: - """ - Args: - fluenceMatrix: Contains the pixel values for the fluence. x dimension is the number of columns, and y dimension is the number of rows in the matrix. The minimum number of rows and columns is 2, and the maximum is 1024. For the optimal fluence of a beam, the values in the fluence matrix are floats, 4 bytes per pixel. The pixel values are determined as follows: fluence value 1 produces a dose of 1 Gy at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Correspondingly, fluence value 2 produces 2 Gy, fluence value 3 produces 3 Gy, etc. at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Pixel values are positive. - xOrigin: The x coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. - yOrigin: The y coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. - """ - ... - - - # Constructor. - @overload - def __init__(self, fluenceMatrix: Array[float], xOrigin: float, yOrigin: float, mlcId: str) -> None: - """ - Args: - fluenceMatrix: Contains the pixel values for the fluence. x dimension is the number of columns, and y dimension is the number of rows in the matrix. The minimum number of rows and columns is 2, and the maximum is 1024. The pixel values are determined as follows: fluence value 1 produces a dose of 1 Gy at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Correspondingly, fluence value 2 produces 2 Gy, fluence value 3 produces 3 Gy, etc. at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Pixel values are positive. - xOrigin: The x coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. - yOrigin: The y coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system. - mlcId: The identifier of the MLC that is related to the fluence. This parameter is optional. If the identifier is empty, the system tries to find the MLC from the treatment unit configuration. This happens when you call one of the - """ - ... - - - MaxSizePixel: int - - XSizePixel: int - - YSizePixel: int - - XSizeMM: float - - YSizeMM: float - - XOrigin: float - - YOrigin: float - - MLCId: str - - # Returns the fluence matrix. - def GetPixels(self) -> Array[float]: - ... - - - -class ImagingBeamSetupParameters: - """ - Setup parameters for imaging fields. - - Attributes: - ImagingSetup (ImagingSetup): Identifier for the imaging setup. - FitMarginX1 (float): Fit margin in x-direction in mm. - FitMarginX2 (float): Fit margin in x-direction in mm. - FitMarginY1 (float): Fit margin in y-direction in mm. - FitMarginY2 (float): Fit margin in y-direction in mm. - FieldSizeX (float): Field size in x-direction in mm. - FieldSizeY (float): Field size in y-direction in mm. - """ - # Constructor for imaging beam setup parameters. - def __init__(self, imagingSetup: ImagingSetup, fitMarginX1_mm: float, fitMarginX2_mm: float, fitMarginY1_mm: float, fitMarginY2_mm: float, fieldSizeX_mm: float, fieldSizeY_mm: float) -> None: - """ - Args: - imagingSetup: Setup technique - fitMarginX1_mm: Fit margin left side (in mm) - fitMarginX2_mm: Fit margin right side (in mm) - fitMarginY1_mm: Fit margin top (in mm) - fitMarginY2_mm: Fit margin bottom (in mm) - fieldSizeX_mm: Field size in x direction (in mm) - fieldSizeY_mm: Field size in y direction (in mm) - """ - ... - - - ImagingSetup: ImagingSetup - - FitMarginX1: float - - FitMarginX2: float - - FitMarginY1: float - - FitMarginY2: float - - FieldSizeX: float - - FieldSizeY: float - - -class ProfilePoint: - """ - Represents a point of a line profile. - - Attributes: - Position (VVector): The position of the point. - Value (float): The value of the point. - """ - # Constructs a ProfilePoint. - def __init__(self, position: VVector, value: float) -> None: - """ - Args: - position: Position of the point. - value: Value of the point. - """ - ... - - - Position: VVector - - Value: float - - -class LineProfile: - """ - Represents values along a line segment. - - Attributes: - Count (int): The number of points in the profile. - """ - # Constructs a LineProfile. - def __init__(self, origin: VVector, step: VVector, data: Array[Double]) -> None: - """ - Args: - origin: Origin, i.e. position of first point of the profile. - step: Step length and direction between points on the profile. - data: Array of values of the profile. - """ - ... - - - Count: int - - # An enumerator for the points in the profile. - def GetEnumerator(self) -> Iterable[ProfilePoint]: - ... - - - # A non-generic version of the enumerator for the points in the profile. - def GetEnumerator(self) -> Iterable[ProfilePoint]: - ... - - - -class ImageProfile: - """ - Represents an image line profile. - - Attributes: - Unit (str): The unit of the points on the image profile. - """ - # Constructs an ImageProfile. - def __init__(self, origin: VVector, step: VVector, data: Array[Double], unit: str) -> None: - """ - Args: - origin: Origin, i.e. position of first point of the profile. - step: Step length and direction between points on the profile. - data: Array of values of the profile. - unit: Unit of values in the profile. - """ - ... - - - Unit: str - - -class DoseProfile: - """ - Represents a dose profile. - - Attributes: - Unit (DoseValue+DoseUnit): The unit of the points on this dose profile. - """ - # Constructs a DoseProfile. - def __init__(self, origin: VVector, step: VVector, data: Array[Double], unit: DoseUnit) -> None: - """ - Args: - origin: Origin, i.e. position of first point of the profile. - step: Step length and direction between points on the profile. - data: Array of values of the profile. - unit: Unit of values in the profile. - """ - ... - - - Unit: DoseValue+DoseUnit - - -class LMCVOptions: - """ - Options for calculating leaf motions using the Varian Leaf Motion Calculator (LMCV) algorithm. - - Attributes: - FixedJaws (bool): Use the Fixed jaws option. - """ - # Constructor. - def __init__(self, fixedJaws: bool) -> None: - """ - Args: - fixedJaws: Use the Fixed jaws option. - """ - ... - - - FixedJaws: bool - - -class SmartLMCOptions: - """ - Options for calculating leaf motions using the Varian Smart LMC algorithm. - - Attributes: - FixedFieldBorders (bool): Use the Fixed field borders option. See details in Eclipse Photon and Electron Algorithms Reference Guide. - JawTracking (bool): Use the Jaw tracking option. See details in Eclipse Photon and Electron Algorithms Reference Guide. - """ - # Constructor. - def __init__(self, fixedFieldBorders: bool, jawTracking: bool) -> None: - """ - Args: - fixedFieldBorders: Use the Fixed field borders option. See details in Eclipse Photon and Electron Algorithms Reference Guide. - jawTracking: Use the Jaw tracking option. See details in Eclipse Photon and Electron Algorithms Reference Guide. - """ - ... - - - FixedFieldBorders: bool - - JawTracking: bool - - -class LMCMSSOptions: - """ - Options for calculating leaf motions using the non-Varian MSS Leaf Motion Calculator (LMCMSS) algorithm. - - Attributes: - NumberOfIterations (int): The number of calculation iterations. - """ - # Constructor. - def __init__(self, numberOfIterations: int) -> None: - """ - Args: - numberOfIterations: The number of calculation iterations. - """ - ... - - - NumberOfIterations: int - - -class DosimeterUnit: - """ - The dosimeter unit. - """ - def __init__(self) -> None: ... - - -class MetersetValue: - """ - Represents a meterset value. - - Attributes: - Value (float): The value of this instance. - Unit (DosimeterUnit): The unit of this instance. - """ - # Constructs a MetersetValue. - def __init__(self, value: float, unit: DosimeterUnit) -> None: - """ - Args: - value: Value for this instance. - unit: Unit for this instance. - """ - ... - - - Value: float - - Unit: DosimeterUnit - - # This member is internal to the Eclipse Scripting API. - def GetSchema(self) -> Xml.Schema.XmlSchema: - ... - - - # This member is internal to the Eclipse Scripting API. - def ReadXml(self, reader: Xml.XmlReader) -> None: - """ - Args: - reader: XmlReader. - """ - ... - - - # Serialization support. - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream to which the object is serialized. - """ - ... - - - -class OptimizationAvoidanceSector: - """ - Avoidance sector details. - - Attributes: - StartAngle (float): Start angle. - StopAngle (float): Stop angle. - Valid (bool): Is Avoidance Sector valid. - ValidationError (str): Validation error. - IsDefined (bool): Is Avoidance Sector defined. True if either startAngle or stopAngle is defined. - """ - # OptimizationAvoidanceSector constructor. - @overload - def __init__(self, startAngle: float, stopAngle: float) -> None: - ... - - - # OptimizationAvoidanceSector constructor. - @overload - def __init__(self, startAngle: float, stopAngle: float, isValid: bool, validationError: str) -> None: - ... - - - StartAngle: float - - StopAngle: float - - Valid: bool - - ValidationError: str - - IsDefined: bool - - -class OptimizationOptionsBase: - """ - Abstract base class for IMRT and VMAT optimization options. - - Attributes: - MLC (str): Identifier for the Multileaf Collimator (MLC). This can be left empty if there is exactly one MLC configured. - StartOption (OptimizationOption): The state at the beginning of the optimization. - IntermediateDoseOption (OptimizationIntermediateDoseOption): Use of intermediate dose in optimization. - """ - def __init__(self) -> None: ... - - MLC: str - - StartOption: OptimizationOption - - IntermediateDoseOption: OptimizationIntermediateDoseOption - - -class OptimizationOptionsIMPT: - """ - Options for IMPT optimization. - - Attributes: - MaximumNumberOfIterations (int): Maximum number of iterations for the IMPT optimizer. - """ - # Specify the initial state at the beginning of optimization. The calculation terminates upon convergence before the maximum number of iterations is reached or the maximum time has elapsed. - def __init__(self, maxIterations: int, initialState: OptimizationOption) -> None: - """ - Args: - maxIterations: Maximum number of iterations for IMRT optimization. - initialState: Initial state at the beginning of optimization. - """ - ... - - - MaximumNumberOfIterations: int - - -class OptimizationOptionsIMRT: - """ - Options for IMRT optimization. - - Attributes: - ConvergenceOption (OptimizationConvergenceOption): Terminate the optimization early if it is converged. - NumberOfStepsBeforeIntermediateDose (int): Number of steps before the intermediate dose is calculated. - MaximumNumberOfIterations (int): Maximum number of iterations for the IMRT optimizer. - """ - # Specify the initial state at the beginning of optimization and use intermediate dose after a specified number of iterations. The user specifies if the calculation terminates upon convergence before the maximum number of iterations is reached. If the intermediate dose is selected, the intermediate dose is calculated at least once. The subsequent cycles may be terminated early if the iteration has been converged. - @overload - def __init__(self, maxIterations: int, initialState: OptimizationOption, numberOfStepsBeforeIntermediateDose: int, convergenceOption: OptimizationConvergenceOption, mlcId: str) -> None: - """ - Args: - maxIterations: Maximum number of iterations for IMRT optimization. - initialState: Initial state at the beginning of optimization. - numberOfStepsBeforeIntermediateDose: Number of steps before the intermediate dose is calculated. - convergenceOption: Option to terminate optimization early if the iteration is converged. - mlcId: Identifier for the Multileaf Collimator (MLC). - """ - ... - - - # Specify the initial state at the beginning of optimization and use intermediate dose after a specified number of iterations. The user specifies if the calculation terminates upon convergence before the maximum number of iterations is reached. If the intermediate dose is selected, the intermediate dose is calculated once after which the optimization is restarted. This option is the same as the "Automatic Intermediate Dose" option in External Beam Planning. - @overload - def __init__(self, maxIterations: int, initialState: OptimizationOption, convergenceOption: OptimizationConvergenceOption, intermediateDoseOption: OptimizationIntermediateDoseOption, mlcId: str) -> None: - """ - Args: - maxIterations: Maximum number of iterations for IMRT optimization. - initialState: Initial state at the beginning of optimization. - convergenceOption: Option to terminate optimization early if the iteration is converged. - intermediateDoseOption: Specify if intermediate dose is calculated. - mlcId: Identifier for the Multileaf Collimator (MLC). - """ - ... - - - # Specify the initial state before optimization and whether the algorithm can terminate early if the iteration has already been converged. No intermediate dose is used in the optimization. - @overload - def __init__(self, maxIterations: int, initialState: OptimizationOption, convergenceOption: OptimizationConvergenceOption, mlcId: str) -> None: - """ - Args: - maxIterations: Maximum number of iterations for IMRT optimization. - initialState: Initial state at the beginning of optimization. - convergenceOption: Option to terminate optimization early if the iteration is converged. - mlcId: Identifier for the Multileaf Collimator (MLC). - """ - ... - - - ConvergenceOption: OptimizationConvergenceOption - - NumberOfStepsBeforeIntermediateDose: int - - MaximumNumberOfIterations: int - - -class OptimizationOptionsVMAT: - """ - Options for VMAT optimization. - - Attributes: - NumberOfOptimizationCycles (int): Number of VMAT optimization cycles. - """ - # Perform VMAT optimization using a specific starting condition. - @overload - def __init__(self, startOption: OptimizationOption, mlcId: str) -> None: - """ - Args: - startOption: Initial state for the optimizer. - mlcId: Identifier for the Multileaf Collimator (MLC). - """ - ... - - - # Perform a single cycle of VMAT optimization. Intermediate dose is optionally calculated after multi-resolution level 3. - @overload - def __init__(self, intermediateDoseOption: OptimizationIntermediateDoseOption, mlcId: str) -> None: - """ - Args: - intermediateDoseOption: Intermediate dose option. - mlcId: Identifier for the Multileaf Collimator (MLC). - """ - ... - - - # Perform a user-specified number of VMAT optimization cycles. During the first round, the intermediate dose is calculated after multi-resolution level 3, and the optimization re-starts at multi-resolution level 4. The subsequent rounds calculate first the intermediate dose and start the optimization from multi-resolution level 4. - @overload - def __init__(self, numberOfCycles: int, mlcId: str) -> None: - """ - Args: - numberOfCycles: Number of VMAT optimization cycles. - mlcId: Identifier for the Multileaf Collimator (MLC). - """ - ... - - - # For the internal use of the Eclipse Scripting API. - @overload - def __init__(self, startOption: OptimizationOption, mlcId: OptimizationIntermediateDoseOption, param3: int, param4: str) -> None: - ... - - - # Copy Constructor. - @overload - def __init__(self, options: OptimizationOptionsVMAT) -> None: - """ - Args: - options: An options object that is copied. - """ - ... - - - NumberOfOptimizationCycles: int - - -class PlanValidationResult: - """ - Represents plan validatation result - - Attributes: - InfoCount (int): The info count of this instance. - WarningCount (int): The warning count of this instance. - ErrorCount (int): The error count of this instance. - Details (Collections.Generic.ICollection[PlanValidationResultDetail]): The validation details of this instance. - StringPresentation (str): String representation of this instance. - """ - # Constructs empty PlanValidationResult. - @overload - def __init__(self) -> None: - ... - - - # Constructs a PlanValidationResult. - @overload - def __init__(self, details: Collections.Generic.ICollection[PlanValidationResultDetail]) -> None: - """ - Args: - details: Collection of validation details. - """ - ... - - - InfoCount: int - - WarningCount: int - - ErrorCount: int - - Details: Collections.Generic.ICollection[PlanValidationResultDetail] - - StringPresentation: str - - # Add validation detail to this instance. - def Add(self, detail: PlanValidationResultDetail) -> None: - """ - Args: - detail: New validation detail. - """ - ... - - - # Add validation component to this instance. - def Add(self, componentResult: PlanValidationResult) -> None: - """ - Args: - componentResult: Plan validation result component. - """ - ... - - - -class PlanValidationResultDetail: - """ - Represents plan validation detail. - - Attributes: - Plan (str): Identifies the plan of this instance. - MessageForUser (str): Localized message for user of this instance. - Classification (PlanValidationResultDetail+ResultClassification): Result classification of this instance. - Code (str): Unique validation detail code of this instance. - StringPresentation (str): String representation of this instance. - """ - # Constructs PlanValidationDetail. - def __init__(self, plan: str, messageForUser: str, classification: ResultClassification, code: str) -> None: - """ - Args: - plan: Identifies plan. - messageForUser: Localized message for user. - classification: Class of validation detail. - code: Unique validation detail code. - """ - ... - - - Plan: str - - MessageForUser: str - - Classification: PlanValidationResultDetail+ResultClassification - - Code: str - - StringPresentation: str - - # Result classification (static). - def GetClassification(self, detail: PlanValidationResultDetail) -> PlanValidationResultDetail+ResultClassification: - ... - - - -class PlanValidationResultEsapiDetail: - """ - A class for detailed plan validation result - - Attributes: - MessageForUser (str): Message for the user about the validation result detail. - Code (str): Detail code. - IsError (bool): Check if the result is a error (true) or a warning (false). - """ - # Constructor for PlanValidationResultEsapiDetail class. - def __init__(self, messageForUser: str, isError: bool, code: str) -> None: - """ - Args: - messageForUser: Message for the user. - isError: Is this reported as a error or as a warning. - code: Result code. - """ - ... - - - MessageForUser: str - - Code: str - - IsError: bool - - -class ProtonBeamMachineParameters: - """ - The parameters for the proton beam treatment unit. - - Attributes: - MachineId (str): The treatment unit identifier. - TechniqueId (str): Technique identifier. For example, "MODULAT_SCANNING", or "UNIFORM_SCANNING". - ToleranceId (str): Tolerance identifier. - """ - # Assigns the parameters to the properties for proton beams. - def __init__(self, machineId: str, techniqueId: str, toleranceId: str) -> None: - """ - Args: - machineId: The treatment unit identifier. - techniqueId: Technique identifier. "MODULAT_SCANNING" or "UNIFORM_SCANNING" for proton beams. - toleranceId: Tolerance identifier. - """ - ... - - - MachineId: str - - TechniqueId: str - - ToleranceId: str - - -class IonPlanNormalizationParameters: - """ - The parameters for proton plan normalization. - - Attributes: - NormalizationMode (PlanNormalizationMode): Normalization mode. - NormalizationValue (float): The treatment unit identifier. - VolumePercentage (float): Volume percentage factor. - """ - # Plan normalization parameters for user-defined target volume percentage and plan normalization value. For more information refer to the plan normalization options in the Eclipse Proton Reference Guide. - @overload - def __init__(self, normalizationMode: PlanNormalizationMode, normalizationValue: float, volumePercentage: float) -> None: - ... - - - # Plan normalization parameters user-defined plan normalization value. For more information refer to the plan normalization options in the Eclipse Proton Reference Guide. - @overload - def __init__(self, normalizationMode: PlanNormalizationMode, normalizationValue: float) -> None: - ... - - - # Plan normalization parameters for normalizing the maximum, mean, minimum dose of the target volume to 100%, or to no normalization. For more information refer to the plan normalization options in the Eclipse Proton Reference Guide. - @overload - def __init__(self, normalizationMode: PlanNormalizationMode) -> None: - ... - - - NormalizationMode: PlanNormalizationMode - - NormalizationValue: float - - VolumePercentage: float - - -class RailPosition: - """ - Setting for the moveable rail position (in or out) used for couch modeling in Eclipse. - """ - def __init__(self) -> None: ... - - -class SegmentProfilePoint: - """ - Represents a point of a segment profile. - - Attributes: - Position (VVector): The position of the point. - Value (bool): The value of the point: true if the point is inside the segment, false otherwise. - """ - # Constructs a SegmentProfilePoint. - def __init__(self, position: VVector, value: bool) -> None: - """ - Args: - position: Position of the point. - value: Value of the point. - """ - ... - - - Position: VVector - - Value: bool - - -class SegmentProfile: - """ - Represents the segment values along a line segment. - - Attributes: - Count (int): The number of points in the profile. - EdgeCoordinates (List[VVector]): Returns the coordinates of the edges of the segment along the segment profile. - """ - # Constructs a SegmentProfile. - def __init__(self, origin: VVector, step: VVector, data: Collections.BitArray) -> None: - """ - Args: - origin: Origin, i.e. position of first point of the profile. - step: Step length and direction between points on the profile. - data: Array of values of the profile. - """ - ... - - - Count: int - - EdgeCoordinates: List[VVector] - - # An enumerator for points in the profile. - def GetEnumerator(self) -> Iterable[SegmentProfilePoint]: - ... - - - # A non-generic version of the enumerator for points in the profile. - def GetEnumerator(self) -> Iterable[SegmentProfilePoint]: - ... - - - -class LogSeverity: - """ - The enumeration of log severities. - """ - def __init__(self) -> None: ... - - -class PlanType: - """ - The enumeration of plan types. - """ - def __init__(self) -> None: ... - - -class MLCPlanType: - """ - The enumeration of Multileaf Collimator (MLC) techniques. - """ - def __init__(self) -> None: ... - - -class PlanSetupApprovalStatus: - """ - The enumeration of plan approval statuses. - """ - def __init__(self) -> None: ... - - -class StructureApprovalStatus: - """ - The enumeration of structure approval statuses. - """ - def __init__(self) -> None: ... - - -class ProtonDeliveryTimeStatus: - """ - The enumeration of proton delivery time statuses. - """ - def __init__(self) -> None: ... - - -class ImageApprovalStatus: - """ - The enumeration of image approval statuses. - """ - def __init__(self) -> None: ... - - -class PlanSumOperation: - """ - PlanSum operation for PlanSetups in PlanSum. Indicates whether the plan is summed with (“+”) or subtracted from (“-”) the other plans in the sum. - """ - def __init__(self) -> None: ... - - -class DoseValuePresentation: - """ - Types of presentation for dose values. - """ - def __init__(self) -> None: ... - - -class VolumePresentation: - """ - Types of presentation for volume values. - """ - def __init__(self) -> None: ... - - -class PatientOrientation: - """ - The enumeration of patient orientations. - """ - def __init__(self) -> None: ... - - -class SeriesModality: - """ - The enumeration of series modalities. - """ - def __init__(self) -> None: ... - - -class BeamTechnique: - """ - An enumeration of beam techniques. - """ - def __init__(self) -> None: ... - - -class SetupTechnique: - """ - The enumeration of setup techniques for a beam. - """ - def __init__(self) -> None: ... - - -class GantryDirection: - """ - The enumeration of gantry rotation directions. - """ - def __init__(self) -> None: ... - - -class ImagingSetup: - """ - Set of available imaging setups. - """ - def __init__(self) -> None: ... - - -class BlockType: - """ - A type flag that tells whether a block is an aperture block or a shielding block. An aperture block is used to limit the radiated area while a shielding block is made to protect a sensitive organ. - """ - def __init__(self) -> None: ... - - -class CalculationType: - """ - Calculation type. - """ - def __init__(self) -> None: ... - - -class OptimizationObjectiveOperator: - """ - Optimization Objective Operator, which is used for setting the upper and lower optimization objectives. - """ - def __init__(self) -> None: ... - - -class OptimizationOption: - """ - Options for Optimization. - """ - def __init__(self) -> None: ... - - -class OptimizationIntermediateDoseOption: - """ - Options for using intermediate dose in optimization. - """ - def __init__(self) -> None: ... - - -class OptimizationConvergenceOption: - """ - Options for terminating optimization upon convergence. - """ - def __init__(self) -> None: ... - - -class DVHEstimateType: - """ - Represents the type of a DVH estimate curve - """ - def __init__(self) -> None: ... - - -class PlanUncertaintyType: - """ - Plan uncertainty type indicates the usage of associated uncertainty parameters, see - """ - def __init__(self) -> None: ... - - -class IonBeamScanMode: - """ - The method of beam scanning to be used during treatment. Used with IonBeams. - """ - def __init__(self) -> None: ... - - -class RangeShifterType: - """ - Type of the range shifter. - """ - def __init__(self) -> None: ... - - -class LateralSpreadingDeviceType: - """ - Type of the lateral spreading device. - """ - def __init__(self) -> None: ... - - -class PlanNormalizationMode: - """ - Plan normalization options for SetPlanNormalization - """ - def __init__(self) -> None: ... - - -class IonPlanOptimizationMode: - """ - Proton plan optimization mode. - """ - def __init__(self) -> None: ... - - -class RangeModulatorType: - """ - Type of the range modulator. - """ - def __init__(self) -> None: ... - - -class PatientSupportType: - """ - Patient support type. - """ - def __init__(self) -> None: ... - - -class ApplicationScriptType: - """ - The type of the application script. - """ - def __init__(self) -> None: ... - - -class ApplicationScriptApprovalStatus: - """ - The approval statuses of the application script. - """ - def __init__(self) -> None: ... - - -class RTPrescriptionTargetType: - """ - The type of the prescription target definition - """ - def __init__(self) -> None: ... - - -class RTPrescriptionConstraintType: - """ - Type of the RT prescription constraint. - """ - def __init__(self) -> None: ... - - -class PrescriptionType: - """ - Enumeration of prescription types. - """ - def __init__(self) -> None: ... - - -class PrescriptionModifier: - """ - Prescription modifier. - """ - def __init__(self) -> None: ... - - -class MeasureType: - """ - Enumeration of plan measure types. - """ - def __init__(self) -> None: ... - - -class MeasureModifier: - """ - Measure modifier - """ - def __init__(self) -> None: ... - - -class RegistrationApprovalStatus: - """ - The enumeration of registration approval statuses. - """ - def __init__(self) -> None: ... - - -class ApprovalHistoryEntry: - """ - An entry in the plan approval history. - """ - def __init__(self) -> None: ... - - -class StructureApprovalHistoryEntry: - """ - An entry in the structure approval history. - """ - def __init__(self) -> None: ... - - -class ImageApprovalHistoryEntry: - """ - An entry in the image approval history. - """ - def __init__(self) -> None: ... - - -class OpenLeavesMeetingPoint: - """ - Specifies where the open MLC leaves meet the structure outline in an MLC leaf fit operation. - """ - def __init__(self) -> None: ... - - -class ClosedLeavesMeetingPoint: - """ - Specifies where the closed MLC leaf pairs are parked in an MLC leaf fit operation. Bank_One: Varian = B, IEC MLCX = X1, IEC MLCY = Y1; Bank_Two: Varian = A, IEC MLCX = X2, IEC MLCY = Y2 - """ - def __init__(self) -> None: ... - - -class JawFitting: - """ - Specifies where collimator jaws are positioned in an MLC leaf fit operation. - """ - def __init__(self) -> None: ... - - -class RendererStrings: - """ - """ - def __init__(self) -> None: ... - - -class TreatmentSessionStatus: - """ - Status of the treatment session. - """ - def __init__(self) -> None: ... - - -class GoalPriority: - """ - Clinical Goal Priority - """ - def __init__(self) -> None: ... - - -class GoalEvalResult: - """ - Clinical Goal Evaluation Result - """ - def __init__(self) -> None: ... - - -class DVHEstimationStructureType: - """ - Structure type as defined in Planning Model Library: PTV or OAR - """ - def __init__(self) -> None: ... - - -class ParticleType: - """ - Particle types - """ - def __init__(self) -> None: ... - - -class ProtonBeamLineStatus: - """ - Status of proton beam line - """ - def __init__(self) -> None: ... - - -class CourseClinicalStatus: - """ - Clinical Status of Course - """ - def __init__(self) -> None: ... - - -class ResetSourcePositionsResult: - """ - Return value for - """ - def __init__(self) -> None: ... - - -class SetSourcePositionsResult: - """ - Return value for - """ - def __init__(self) -> None: ... - - -class BrachyTreatmentTechniqueType: - """ - The enumeration of Brachytherapy treatment techniques. - """ - def __init__(self) -> None: ... - - -class StructureCodeInfo: - """ - Represents structure code information. - - Attributes: - CodingScheme (str): The coding scheme of the structure code. - Code (str): The structure code as defined in the associated coding scheme. - """ - # Constructs a StructureCodeInfo. - def __init__(self, codingScheme: str, code: str) -> None: - """ - Args: - codingScheme: The coding scheme of the structure code. - code: The structure code as defined in the associated coding scheme. - """ - ... - - - CodingScheme: str - - Code: str - - # A string that represents the current object. - def ToString(self) -> str: - ... - - - # Checks if this object is equal to another object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: The other object to compare. - """ - ... - - - # Returns the hash code for this instance. Overrides Object.GetHashCode. - def GetHashCode(self) -> int: - ... - - - # Equality operator for StructureCodeInfo. - def op_Equality(self, left: StructureCodeInfo, right: StructureCodeInfo) -> bool: - """ - Args: - left: The first object to compare. - right: The second object to compare. - """ - ... - - - # Inequality operator for StructureCodeInfo. - def op_Inequality(self, left: StructureCodeInfo, right: StructureCodeInfo) -> bool: - """ - Args: - left: The first object to compare. - right: The second object to compare. - """ - ... - - - # Indicates whether the current object is equal to another object of the same type. - def Equals(self, other: StructureCodeInfo) -> bool: - """ - Args: - other: An object to compare with this object. - """ - ... - - - # This member is internal to the Eclipse Scripting API. - def GetSchema(self) -> Xml.Schema.XmlSchema: - ... - - - # This member is internal to the Eclipse Scripting API. - def ReadXml(self, reader: Xml.XmlReader) -> None: - """ - Args: - reader: The XmlReader stream from which the object is deserialized. - """ - ... - - - # Serialization support. - def WriteXml(self, writer: Xml.XmlWriter) -> None: - """ - Args: - writer: The System.Xml.XmlWriter stream to which the object is serialized. - """ - ... - - - -class UserIdentity: - """ - Represents the identity of an user, including the identifier (username) and the display name. - """ - # Creates a new UserIdentity value. - def __init__(self, id: str, displayName: str) -> None: - """ - Args: - id: The user identifier including the domain name, such as 'domain\user'. - displayName: The display name of the user. - """ - ... - - - -class ValidationException: - """ - ValidationException. - """ - # Exception thrown when data validation fails. - def __init__(self, reason: str) -> None: - """ - Args: - reason: A message that describes the failure. - """ - ... - - - -class VRect[T](Generic[T]): - """ - Represents a rectangle. - - Attributes: - X1 (T): The X1-coordinate of the rectangle. - Y1 (T): The Y1-coordinate of the rectangle. - X2 (T): The X2-coordinate of the rectangle. - Y2 (T): The Y2-coordinate of the rectangle. - - Note: - Currently limited to value types. - """ - # Constructs a VRect. - def __init__(self, x1: T, y1: T, x2: T, y2: T) -> None: - """ - Args: - x1: X1 coordinate of the rectangle. - y1: Y1 coordinate of the rectangle. - x2: X2 coordinate of the rectangle. - y2: Y2 coordinate of the rectangle. - """ - ... - - - X1: T - - Y1: T - - X2: T - - Y2: T - - # A string that represents the current object. - def ToString(self) -> str: - ... - - - # Checks if this object is equal to another object. - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: The other object to compare. - """ - ... - - - # Checks if this object is equal to another VRect object. - def Equals(self, other: VRect[T]) -> bool: - """ - Args: - other: The other object to compare. - """ - ... - - - # Equality operator for VRect. - def op_Equality(self, a: VRect[T], b: VRect[T]) -> bool: - """ - Args: - a: The first object to compare. - b: The second object to compare. - """ - ... - - - # Inequality operator for VRect. - def op_Inequality(self, a: VRect[T], b: VRect[T]) -> bool: - """ - Args: - a: The first object to compare. - b: The second object to compare. - """ - ... - - - # Returns the hash code for this instance. Overrides Object.GetHashCode. - def GetHashCode(self) -> int: - ... - - - -class VVector: - """ - Represents a displacement in 3D space. - - Attributes: - LengthSquared (float): The square of the length of the VVector. - Length (float): The length of the VVector. - x (float): The X component of the VVector. - y (float): The Y component of the VVector. - z (float): The Z component of the VVector. - """ - # Constructs a VVector. - def __init__(self, xi: float, yi: float, zi: float) -> None: - """ - Args: - xi: X component. - yi: Y component. - zi: Z component. - """ - ... - - - LengthSquared: float - - Length: float - - x: float - - y: float - - z: float - - # Updating VVector component value using VectorComponent indexing. - def Update(self, vc: Component, value: float) -> VVector: - """ - Args: - vc: Component enum that correspond to x,y and z components. - value: Value of 0,1 or 2 that correspond to x,y and z components. - """ - ... - - - # The distance between the locations represented by the given VVectors. - def Distance(self, left: VVector, right: VVector) -> float: - """ - Args: - left: First operand. - right: Second operand - """ - ... - - - # Scales this VVector so that its length becomes equal to unity. - def ScaleToUnitLength(self) -> None: - ... - - - # Scales this VVector so that its length becomes equal to unity. - def GetUnitLengthScaledVector(self) -> VVector: - ... - - - # The scalar product of this VVector and the given VVector. - def ScalarProduct(self, left: VVector) -> float: - """ - Args: - left: VVector that is second operand of the scalar product. - """ - ... - - - # The subtraction of VVectors. - def op_Subtraction(self, left: VVector, right: VVector) -> VVector: - """ - Args: - left: First operand. - right: Second operand. - """ - ... - - - # The addition of VVectors. - def op_Addition(self, left: VVector, right: VVector) -> VVector: - """ - Args: - left: First operand. - right: Second operand. - """ - ... - - - # The multiplication of a VVector and a double. - def op_Multiply(self, val: VVector, mul: float) -> VVector: - """ - Args: - val: VVector to multiply. - mul: Multiplier. - """ - ... - - - # The multiplication of a VVector and a double. - def op_Multiply(self, val: float, mul: VVector) -> VVector: - """ - Args: - val: VVector to multiply. - mul: Multiplier. - """ - ... - - - # The division of a VVector by a double. - def op_Division(self, val: VVector, div: float) -> VVector: - """ - Args: - val: VVector to divide. - div: Divisor. - """ - ... - - - # Equality comparison of VVector and Object. This method considers two instances of VVector.Undefined to be equal to each other. Otherwise, a vector is equal to an object only if the object is a VVector and vectors are equal. For epsilon-equal comparison, use - def Equals(self, obj: Any) -> bool: - """ - Args: - obj: Object to compare this to. - """ - ... - - - # Equality comparison of vectors. This method considers two instances of VVector.Undefined to be equal to each other. Otherwise, two vectors are equal only if the vectors components are equal. a == b, b == c, => a has to be equal to c. Epsilon equality comparison does not fulfill this condition with epsilon > 0.0. For epsilon-equal comparison, use - def Equals(self, other: VVector) -> bool: - """ - Args: - other: vector to compare this to. - """ - ... - - - # Epsilon-equality comparison of vectors. This method considers two instances of VVector.Undefined to be equal to each other. Otherwise, two vectors are equal only if the vectors components are within epsilon. - def EpsilonEqual(self, other: VVector, epsilon: float) -> bool: - """ - Args: - other: Vector to compare this to. - epsilon: Epsilon to use for the vector component comparison. - """ - ... - - - # Returns true if at least one of this vector components are equal to double.IsNaN or double.IsInfinity, false otherwise. - def IsUndefined(self) -> bool: - ... - - - # A hash code for the current object. - def GetHashCode(self) -> int: - ... - - - # Equality operator for vectors. This method considers two instances of VVector.Undefined to be equal to each other. Otherwise, two vectors are equal only if the vectors components are equal. For epsilon-equal comparison, use - def op_Equality(self, vv1: VVector, vv2: VVector) -> bool: - """ - Args: - vv1: First operand. - vv2: Second operand. - """ - ... - - - # Inequality operator for vectors. This method considers two instances of VVector.Undefined to be equal to each other. This operator considers two instances of vectors with undefined components to be inequal. For epsilon-equal comparison, use - def op_Inequality(self, vv1: VVector, vv2: VVector) -> bool: - """ - Args: - vv1: First operand. - vv2: Second operand. - """ - ... - - - diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/VVector.pyi b/pyesapi/VMS/TPS/Common/Model/Types/VVector/VVector.pyi deleted file mode 100644 index 7c0b479..0000000 --- a/pyesapi/VMS/TPS/Common/Model/Types/VVector/VVector.pyi +++ /dev/null @@ -1,18 +0,0 @@ -""" -Type stubs for VMS.TPS.Common.Model.Types.VVector -Generated from .NET XML documentation -""" - -from typing import Any, List, Optional, Union, Dict, Iterable -from datetime import datetime -from System import Array, Double, Single, Int32, Boolean, String -from System.Collections.Generic import KeyValuePair -from System import Collections - -class Component: - """ - VVector component indexing. - """ - def __init__(self) -> None: ... - - diff --git a/pyesapi/VMS/TPS/Version/Version.pyi b/pyesapi/VMS/TPS/Version/Version.pyi deleted file mode 100644 index 9e512b4..0000000 --- a/pyesapi/VMS/TPS/Version/Version.pyi +++ /dev/null @@ -1,29 +0,0 @@ -""" -Type stubs for VMS.TPS.Version -Generated from .NET XML documentation -""" - -from typing import Any, List, Optional, Union, Dict, Iterable -from datetime import datetime -from System import Array, Double, Single, Int32, Boolean, String -from System.Collections.Generic import KeyValuePair -from System import Collections - -class VersionInfo: - """ - This class is a set of constants that specify build version information. Generated automatically from TpsNetVersion.in - do not edit by hand. The logic is copied from the VFC equivalents in TpsVersion.in. Names and identifiers are kept exactly the same as in the original VFC version to help in maintenance. - """ - def __init__(self) -> None: ... - -class VersionInfo: - """ - This class is a set of constants that specify build version information. Generated automatically from TpsNetVersion.in - do not edit by hand. The logic is copied from the VFC equivalents in TpsVersion.in. Names and identifiers are kept exactly the same as in the original VFC version to help in maintenance. - """ - def __init__(self) -> None: ... - -class VersionInfo: - """ - This class is a set of constants that specify build version information. Generated automatically from TpsNetVersion.in - do not edit by hand. The logic is copied from the VFC equivalents in TpsVersion.in. Names and identifiers are kept exactly the same as in the original VFC version to help in maintenance. - """ - def __init__(self) -> None: ... - diff --git a/pyesapi/__init__.py b/pyesapi/__init__.py index 589491e..55f9be7 100644 --- a/pyesapi/__init__.py +++ b/pyesapi/__init__.py @@ -57,12 +57,10 @@ from .stubs.VMS.TPS.Common.Model.API import * from .stubs import System - from .stubs.System.Collections.Generic import Dictionary + from .stubs.System import Array, Int32, Double # for numpy array interfacing - # from .stubs.System.Windows import Point - from .stubs.System import Array, Int32, Double - # from .stubs.System.Runtime.InteropServices import GCHandle, GCHandleType # TODO: these are missing from type stubs + from .stubs.System.Runtime.InteropServices import GCHandle, GCHandleType else: # enforce single thread apartment mode: diff --git a/pyesapi/VMS/TPS/Common/Model/API/AsyncPump/__init__.pyi b/pyesapi/stubs/Microsoft/Win32/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/API/AsyncPump/__init__.pyi rename to pyesapi/stubs/Microsoft/Win32/__init__.py diff --git a/pyesapi/stubs/Microsoft/Win32/__init__.pyi b/pyesapi/stubs/Microsoft/Win32/__init__.pyi new file mode 100644 index 0000000..208c888 --- /dev/null +++ b/pyesapi/stubs/Microsoft/Win32/__init__.pyi @@ -0,0 +1,267 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Array, Enum, Type +from System import TypeCode +from System.Globalization import CultureInfo + +class Color: + """Class docstring.""" + + BackgroundBlue: Color + BackgroundGreen: Color + BackgroundIntensity: Color + BackgroundMask: Color + BackgroundRed: Color + BackgroundYellow: Color + Black: Color + ColorMask: Color + ForegroundBlue: Color + ForegroundGreen: Color + ForegroundIntensity: Color + ForegroundMask: Color + ForegroundRed: Color + ForegroundYellow: Color + +class RegistryHive: + """Class docstring.""" + + ClassesRoot: RegistryHive + CurrentConfig: RegistryHive + CurrentUser: RegistryHive + DynData: RegistryHive + LocalMachine: RegistryHive + PerformanceData: RegistryHive + Users: RegistryHive + +class RegistryKey(MarshalByRefObject): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Handle(self) -> SafeRegistryHandle: + """SafeRegistryHandle: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def SubKeyCount(self) -> int: + """int: Property docstring.""" + ... + + @property + def ValueCount(self) -> int: + """int: Property docstring.""" + ... + + @property + def View(self) -> RegistryView: + """RegistryView: Property docstring.""" + ... + + def Close(self) -> None: + """Method docstring.""" + ... + + def CreateObjRef(self, requestedType: Type) -> ObjRef: + """Method docstring.""" + ... + + def CreateSubKey(self, subkey: str) -> RegistryKey: + """Method docstring.""" + ... + + @overload + def CreateSubKey(self, subkey: str, permissionCheck: RegistryKeyPermissionCheck) -> RegistryKey: + """Method docstring.""" + ... + + @overload + def CreateSubKey(self, subkey: str, permissionCheck: RegistryKeyPermissionCheck, options: RegistryOptions) -> RegistryKey: + """Method docstring.""" + ... + + @overload + def CreateSubKey(self, subkey: str, writable: bool) -> RegistryKey: + """Method docstring.""" + ... + + @overload + def CreateSubKey(self, subkey: str, writable: bool, options: RegistryOptions) -> RegistryKey: + """Method docstring.""" + ... + + @overload + def CreateSubKey(self, subkey: str, permissionCheck: RegistryKeyPermissionCheck, registrySecurity: RegistrySecurity) -> RegistryKey: + """Method docstring.""" + ... + + @overload + def CreateSubKey(self, subkey: str, permissionCheck: RegistryKeyPermissionCheck, registryOptions: RegistryOptions, registrySecurity: RegistrySecurity) -> RegistryKey: + """Method docstring.""" + ... + + def DeleteSubKey(self, subkey: str) -> None: + """Method docstring.""" + ... + + @overload + def DeleteSubKey(self, subkey: str, throwOnMissingSubKey: bool) -> None: + """Method docstring.""" + ... + + def DeleteSubKeyTree(self, subkey: str) -> None: + """Method docstring.""" + ... + + @overload + def DeleteSubKeyTree(self, subkey: str, throwOnMissingSubKey: bool) -> None: + """Method docstring.""" + ... + + def DeleteValue(self, name: str) -> None: + """Method docstring.""" + ... + + @overload + def DeleteValue(self, name: str, throwOnMissingValue: bool) -> None: + """Method docstring.""" + ... + + def Dispose(self) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def Flush(self) -> None: + """Method docstring.""" + ... + + @staticmethod + def FromHandle(handle: SafeRegistryHandle) -> RegistryKey: + """Method docstring.""" + ... + + @overload + @staticmethod + def FromHandle(handle: SafeRegistryHandle, view: RegistryView) -> RegistryKey: + """Method docstring.""" + ... + + def GetAccessControl(self) -> RegistrySecurity: + """Method docstring.""" + ... + + @overload + def GetAccessControl(self, includeSections: AccessControlSections) -> RegistrySecurity: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetLifetimeService(self) -> Any: + """Method docstring.""" + ... + + def GetSubKeyNames(self) -> Array[str]: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetValue(self, name: str) -> Any: + """Method docstring.""" + ... + + @overload + def GetValue(self, name: str, defaultValue: Any) -> Any: + """Method docstring.""" + ... + + @overload + def GetValue(self, name: str, defaultValue: Any, options: RegistryValueOptions) -> Any: + """Method docstring.""" + ... + + def GetValueKind(self, name: str) -> RegistryValueKind: + """Method docstring.""" + ... + + def GetValueNames(self) -> Array[str]: + """Method docstring.""" + ... + + def InitializeLifetimeService(self) -> Any: + """Method docstring.""" + ... + + @staticmethod + def OpenBaseKey(hKey: RegistryHive, view: RegistryView) -> RegistryKey: + """Method docstring.""" + ... + + @staticmethod + def OpenRemoteBaseKey(hKey: RegistryHive, machineName: str) -> RegistryKey: + """Method docstring.""" + ... + + @overload + @staticmethod + def OpenRemoteBaseKey(hKey: RegistryHive, machineName: str, view: RegistryView) -> RegistryKey: + """Method docstring.""" + ... + + def OpenSubKey(self, name: str, writable: bool) -> RegistryKey: + """Method docstring.""" + ... + + @overload + def OpenSubKey(self, name: str, permissionCheck: RegistryKeyPermissionCheck) -> RegistryKey: + """Method docstring.""" + ... + + @overload + def OpenSubKey(self, name: str, rights: RegistryRights) -> RegistryKey: + """Method docstring.""" + ... + + @overload + def OpenSubKey(self, name: str, permissionCheck: RegistryKeyPermissionCheck, rights: RegistryRights) -> RegistryKey: + """Method docstring.""" + ... + + @overload + def OpenSubKey(self, name: str) -> RegistryKey: + """Method docstring.""" + ... + + def SetAccessControl(self, registrySecurity: RegistrySecurity) -> None: + """Method docstring.""" + ... + + def SetValue(self, name: str, value: Any) -> None: + """Method docstring.""" + ... + + @overload + def SetValue(self, name: str, value: Any, valueKind: RegistryValueKind) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/API/Calculation/__init__.pyi b/pyesapi/stubs/Microsoft/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/API/Calculation/__init__.pyi rename to pyesapi/stubs/Microsoft/__init__.py diff --git a/pyesapi/VMS/TPS/Common/Model/API/ControlPointCollection/__init__.pyi b/pyesapi/stubs/Python/Runtime/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/API/ControlPointCollection/__init__.pyi rename to pyesapi/stubs/Python/Runtime/__init__.py diff --git a/pyesapi/stubs/Python/Runtime/__init__.pyi b/pyesapi/stubs/Python/Runtime/__init__.pyi new file mode 100644 index 0000000..bf8c60b --- /dev/null +++ b/pyesapi/stubs/Python/Runtime/__init__.pyi @@ -0,0 +1,38 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Type, ValueType +from System import IntPtr + +class Slot(ValueType): + """Class docstring.""" + + def __init__(self, id: TypeSlotID, value: IntPtr) -> None: + """Initialize instance.""" + ... + + @property + def ID(self) -> TypeSlotID: + """TypeSlotID: Property docstring.""" + ... + + @property + def Value(self) -> IntPtr: + """IntPtr: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/API/IonControlPointCollection/__init__.pyi b/pyesapi/stubs/Python/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/API/IonControlPointCollection/__init__.pyi rename to pyesapi/stubs/Python/__init__.py diff --git a/pyesapi/VMS/TPS/Common/Model/API/IonControlPointPairCollection/__init__.pyi b/pyesapi/stubs/System/Collections/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/API/IonControlPointPairCollection/__init__.pyi rename to pyesapi/stubs/System/Collections/__init__.py diff --git a/pyesapi/stubs/System/Collections/__init__.pyi b/pyesapi/stubs/System/Collections/__init__.pyi new file mode 100644 index 0000000..662bec9 --- /dev/null +++ b/pyesapi/stubs/System/Collections/__init__.pyi @@ -0,0 +1,289 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Array, Type + +class BitArray: + """Class docstring.""" + + def __init__(self, length: int) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, length: int, defaultValue: bool) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, bytes: Array[int]) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, values: Array[bool]) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, values: Array[int]) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, bits: BitArray) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: Property docstring.""" + ... + + @property + def IsReadOnly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSynchronized(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def Item(self) -> bool: + """bool: Property docstring.""" + ... + + @Item.setter + def Item(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def Length(self) -> int: + """int: Property docstring.""" + ... + + @Length.setter + def Length(self, value: int) -> None: + """Set property value.""" + ... + + @property + def SyncRoot(self) -> Any: + """Any: Property docstring.""" + ... + + def And(self, value: BitArray) -> BitArray: + """Method docstring.""" + ... + + def Clone(self) -> Any: + """Method docstring.""" + ... + + def CopyTo(self, array: Array, index: int) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def Get(self, index: int) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Not(self) -> BitArray: + """Method docstring.""" + ... + + def Or(self, value: BitArray) -> BitArray: + """Method docstring.""" + ... + + def Set(self, index: int, value: bool) -> None: + """Method docstring.""" + ... + + def SetAll(self, value: bool) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def Xor(self, value: BitArray) -> BitArray: + """Method docstring.""" + ... + + +class DictionaryBase: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: Property docstring.""" + ... + + def Clear(self) -> None: + """Method docstring.""" + ... + + def CopyTo(self, array: Array, index: int) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> DictionaryEnumeratorByKeys: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class IEnumerator: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Current(self) -> Any: + """Any: Property docstring.""" + ... + + def MoveNext(self) -> bool: + """Method docstring.""" + ... + + def Reset(self) -> None: + """Method docstring.""" + ... + + +class ReadOnlyList: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: Property docstring.""" + ... + + @property + def IsFixedSize(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsReadOnly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSynchronized(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def Item(self) -> Any: + """Any: Property docstring.""" + ... + + @Item.setter + def Item(self, value: Any) -> None: + """Set property value.""" + ... + + @property + def SyncRoot(self) -> Any: + """Any: Property docstring.""" + ... + + def Add(self, obj: Any) -> int: + """Method docstring.""" + ... + + def Clear(self) -> None: + """Method docstring.""" + ... + + def Contains(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def CopyTo(self, array: Array, index: int) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def IndexOf(self, value: Any) -> int: + """Method docstring.""" + ... + + def Insert(self, index: int, obj: Any) -> None: + """Method docstring.""" + ... + + def Remove(self, value: Any) -> None: + """Method docstring.""" + ... + + def RemoveAt(self, index: int) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/API/IonSpotCollection/__init__.pyi b/pyesapi/stubs/System/ComponentModel/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/API/IonSpotCollection/__init__.pyi rename to pyesapi/stubs/System/ComponentModel/__init__.py diff --git a/pyesapi/stubs/System/ComponentModel/__init__.pyi b/pyesapi/stubs/System/ComponentModel/__init__.pyi new file mode 100644 index 0000000..91123c6 --- /dev/null +++ b/pyesapi/stubs/System/ComponentModel/__init__.pyi @@ -0,0 +1,59 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Type +from Microsoft.Win32 import RegistryKey + +class Component(MarshalByRefObject): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Container(self) -> Container: + """Container: Property docstring.""" + ... + + @property + def Site(self) -> Site: + """Site: Property docstring.""" + ... + + @Site.setter + def Site(self, value: Site) -> None: + """Set property value.""" + ... + + def CreateObjRef(self, requestedType: Type) -> ObjRef: + """Method docstring.""" + ... + + def Dispose(self) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetLifetimeService(self) -> Any: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def InitializeLifetimeService(self) -> Any: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/API/IonSpotParametersCollection/__init__.pyi b/pyesapi/stubs/System/Globalization/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/API/IonSpotParametersCollection/__init__.pyi rename to pyesapi/stubs/System/Globalization/__init__.py diff --git a/pyesapi/stubs/System/Globalization/__init__.pyi b/pyesapi/stubs/System/Globalization/__init__.pyi new file mode 100644 index 0000000..21645cf --- /dev/null +++ b/pyesapi/stubs/System/Globalization/__init__.pyi @@ -0,0 +1,270 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Array, Type + +class CultureInfo: + """Class docstring.""" + + def __init__(self, name: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, name: str, useUserOverride: bool) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, culture: int) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, culture: int, useUserOverride: bool) -> None: + """Initialize instance.""" + ... + + @property + def Calendar(self) -> Calendar: + """Calendar: Property docstring.""" + ... + + @property + def CompareInfo(self) -> CompareInfo: + """CompareInfo: Property docstring.""" + ... + + @property + def CultureTypes(self) -> CultureTypes: + """CultureTypes: Property docstring.""" + ... + + @classmethod + @property + def CurrentCulture(cls) -> CultureInfo: + """CultureInfo: Property docstring.""" + ... + + @classmethod + @CurrentCulture.setter + def CurrentCulture(cls, value: CultureInfo) -> None: + """Set property value.""" + ... + + @classmethod + @property + def CurrentUICulture(cls) -> CultureInfo: + """CultureInfo: Property docstring.""" + ... + + @classmethod + @CurrentUICulture.setter + def CurrentUICulture(cls, value: CultureInfo) -> None: + """Set property value.""" + ... + + @property + def DateTimeFormat(self) -> DateTimeFormatInfo: + """DateTimeFormatInfo: Property docstring.""" + ... + + @DateTimeFormat.setter + def DateTimeFormat(self, value: DateTimeFormatInfo) -> None: + """Set property value.""" + ... + + @classmethod + @property + def DefaultThreadCurrentCulture(cls) -> CultureInfo: + """CultureInfo: Property docstring.""" + ... + + @classmethod + @DefaultThreadCurrentCulture.setter + def DefaultThreadCurrentCulture(cls, value: CultureInfo) -> None: + """Set property value.""" + ... + + @classmethod + @property + def DefaultThreadCurrentUICulture(cls) -> CultureInfo: + """CultureInfo: Property docstring.""" + ... + + @classmethod + @DefaultThreadCurrentUICulture.setter + def DefaultThreadCurrentUICulture(cls, value: CultureInfo) -> None: + """Set property value.""" + ... + + @property + def DisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def EnglishName(self) -> str: + """str: Property docstring.""" + ... + + @property + def IetfLanguageTag(self) -> str: + """str: Property docstring.""" + ... + + @classmethod + @property + def InstalledUICulture(cls) -> CultureInfo: + """CultureInfo: Property docstring.""" + ... + + @classmethod + @property + def InvariantCulture(cls) -> CultureInfo: + """CultureInfo: Property docstring.""" + ... + + @property + def IsNeutralCulture(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsReadOnly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def KeyboardLayoutId(self) -> int: + """int: Property docstring.""" + ... + + @property + def LCID(self) -> int: + """int: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def NativeName(self) -> str: + """str: Property docstring.""" + ... + + @property + def NumberFormat(self) -> NumberFormatInfo: + """NumberFormatInfo: Property docstring.""" + ... + + @NumberFormat.setter + def NumberFormat(self, value: NumberFormatInfo) -> None: + """Set property value.""" + ... + + @property + def OptionalCalendars(self) -> Array[Calendar]: + """Array[Calendar]: Property docstring.""" + ... + + @property + def Parent(self) -> CultureInfo: + """CultureInfo: Property docstring.""" + ... + + @property + def TextInfo(self) -> TextInfo: + """TextInfo: Property docstring.""" + ... + + @property + def ThreeLetterISOLanguageName(self) -> str: + """str: Property docstring.""" + ... + + @property + def ThreeLetterWindowsLanguageName(self) -> str: + """str: Property docstring.""" + ... + + @property + def TwoLetterISOLanguageName(self) -> str: + """str: Property docstring.""" + ... + + @property + def UseUserOverride(self) -> bool: + """bool: Property docstring.""" + ... + + def ClearCachedData(self) -> None: + """Method docstring.""" + ... + + def Clone(self) -> Any: + """Method docstring.""" + ... + + @staticmethod + def CreateSpecificCulture(name: str) -> CultureInfo: + """Method docstring.""" + ... + + def Equals(self, value: Any) -> bool: + """Method docstring.""" + ... + + def GetConsoleFallbackUICulture(self) -> CultureInfo: + """Method docstring.""" + ... + + @staticmethod + def GetCultureInfo(culture: int) -> CultureInfo: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCultureInfo(name: str) -> CultureInfo: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCultureInfo(name: str, altName: str) -> CultureInfo: + """Method docstring.""" + ... + + @staticmethod + def GetCultureInfoByIetfLanguageTag(name: str) -> CultureInfo: + """Method docstring.""" + ... + + @staticmethod + def GetCultures(types: CultureTypes) -> Array[CultureInfo]: + """Method docstring.""" + ... + + def GetFormat(self, formatType: Type) -> Any: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + @staticmethod + def ReadOnly(ci: CultureInfo) -> CultureInfo: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/API/StructureCodeDictionary/__init__.pyi b/pyesapi/stubs/System/IO/Compression/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/API/StructureCodeDictionary/__init__.pyi rename to pyesapi/stubs/System/IO/Compression/__init__.py diff --git a/pyesapi/stubs/System/IO/Compression/__init__.pyi b/pyesapi/stubs/System/IO/Compression/__init__.pyi new file mode 100644 index 0000000..a1cb612 --- /dev/null +++ b/pyesapi/stubs/System/IO/Compression/__init__.pyi @@ -0,0 +1,14 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Enum, Type +from Microsoft.Win32 import RegistryHive +from System import TypeCode +from System.Globalization import CultureInfo +from VMS.TPS.Common.Model.Types import BlockType + +class BlockType: + """Class docstring.""" + + Dynamic: BlockType + Static: BlockType + Uncompressed: BlockType diff --git a/pyesapi/VMS/TPS/Common/Model/API/__init__.pyi b/pyesapi/stubs/System/IO/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/API/__init__.pyi rename to pyesapi/stubs/System/IO/__init__.py diff --git a/pyesapi/stubs/System/IO/__init__.pyi b/pyesapi/stubs/System/IO/__init__.pyi new file mode 100644 index 0000000..9b259c9 --- /dev/null +++ b/pyesapi/stubs/System/IO/__init__.pyi @@ -0,0 +1,47 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Type + +class FileStreamAsyncResult: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def AsyncState(self) -> Any: + """Any: Property docstring.""" + ... + + @property + def AsyncWaitHandle(self) -> WaitHandle: + """WaitHandle: Property docstring.""" + ... + + @property + def CompletedSynchronously(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsCompleted(self) -> bool: + """bool: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/DoseValue/__init__.pyi b/pyesapi/stubs/System/Net/Mime/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/DoseValue/__init__.pyi rename to pyesapi/stubs/System/Net/Mime/__init__.py diff --git a/pyesapi/stubs/System/Net/Mime/__init__.pyi b/pyesapi/stubs/System/Net/Mime/__init__.pyi new file mode 100644 index 0000000..bf88486 --- /dev/null +++ b/pyesapi/stubs/System/Net/Mime/__init__.pyi @@ -0,0 +1,59 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Type + +class Application: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + Octet: str + Pdf: str + Rtf: str + Soap: str + Zip: str + +class Image: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + Gif: str + Jpeg: str + Tiff: str diff --git a/pyesapi/VMS/TPS/Common/Model/Types/DoseValueDisplayConfig/__init__.pyi b/pyesapi/stubs/System/Net/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/DoseValueDisplayConfig/__init__.pyi rename to pyesapi/stubs/System/Net/__init__.py diff --git a/pyesapi/VMS/TPS/Common/Model/Types/LineProfile/__init__.pyi b/pyesapi/stubs/System/Reflection/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/LineProfile/__init__.pyi rename to pyesapi/stubs/System/Reflection/__init__.py diff --git a/pyesapi/stubs/System/Reflection/__init__.pyi b/pyesapi/stubs/System/Reflection/__init__.pyi new file mode 100644 index 0000000..6de318d --- /dev/null +++ b/pyesapi/stubs/System/Reflection/__init__.pyi @@ -0,0 +1,1075 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Array, Type +from System import AggregateException, Delegate +from System.Globalization import CultureInfo +from System.Runtime.Serialization import SerializationInfo, StreamingContext + +class Assembly: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def CodeBase(self) -> str: + """str: Property docstring.""" + ... + + @property + def CustomAttributes(self) -> List[CustomAttributeData]: + """List[CustomAttributeData]: Property docstring.""" + ... + + @property + def DefinedTypes(self) -> List[TypeInfo]: + """List[TypeInfo]: Property docstring.""" + ... + + @property + def EntryPoint(self) -> MethodInfo: + """MethodInfo: Property docstring.""" + ... + + @property + def EscapedCodeBase(self) -> str: + """str: Property docstring.""" + ... + + @property + def Evidence(self) -> Evidence: + """Evidence: Property docstring.""" + ... + + @property + def ExportedTypes(self) -> List[Type]: + """List[Type]: Property docstring.""" + ... + + @property + def FullName(self) -> str: + """str: Property docstring.""" + ... + + @property + def GlobalAssemblyCache(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def HostContext(self) -> int: + """int: Property docstring.""" + ... + + @property + def ImageRuntimeVersion(self) -> str: + """str: Property docstring.""" + ... + + @property + def IsDynamic(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsFullyTrusted(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def Location(self) -> str: + """str: Property docstring.""" + ... + + @property + def ManifestModule(self) -> Module: + """Module: Property docstring.""" + ... + + @property + def Modules(self) -> List[Module]: + """List[Module]: Property docstring.""" + ... + + @property + def PermissionSet(self) -> PermissionSet: + """PermissionSet: Property docstring.""" + ... + + @property + def ReflectionOnly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def SecurityRuleSet(self) -> SecurityRuleSet: + """SecurityRuleSet: Property docstring.""" + ... + + def CreateInstance(self, typeName: str) -> Any: + """Method docstring.""" + ... + + @overload + def CreateInstance(self, typeName: str, ignoreCase: bool) -> Any: + """Method docstring.""" + ... + + @overload + def CreateInstance(self, typeName: str, ignoreCase: bool, bindingAttr: BindingFlags, binder: Binder, args: Array[Any], culture: CultureInfo, activationAttributes: Array[Any]) -> Any: + """Method docstring.""" + ... + + @staticmethod + def CreateQualifiedName(assemblyName: str, typeName: str) -> str: + """Method docstring.""" + ... + + def Equals(self, o: Any) -> bool: + """Method docstring.""" + ... + + @staticmethod + def GetAssembly(type: Type) -> Assembly: + """Method docstring.""" + ... + + @staticmethod + def GetCallingAssembly() -> Assembly: + """Method docstring.""" + ... + + def GetCustomAttributes(self, inherit: bool) -> Array[Any]: + """Method docstring.""" + ... + + @overload + def GetCustomAttributes(self, attributeType: Type, inherit: bool) -> Array[Any]: + """Method docstring.""" + ... + + def GetCustomAttributesData(self) -> List[CustomAttributeData]: + """Method docstring.""" + ... + + @staticmethod + def GetEntryAssembly() -> Assembly: + """Method docstring.""" + ... + + @staticmethod + def GetExecutingAssembly() -> Assembly: + """Method docstring.""" + ... + + def GetExportedTypes(self) -> Array[Type]: + """Method docstring.""" + ... + + def GetFile(self, name: str) -> FileStream: + """Method docstring.""" + ... + + def GetFiles(self) -> Array[FileStream]: + """Method docstring.""" + ... + + @overload + def GetFiles(self, getResourceModules: bool) -> Array[FileStream]: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetLoadedModules(self) -> Array[Module]: + """Method docstring.""" + ... + + @overload + def GetLoadedModules(self, getResourceModules: bool) -> Array[Module]: + """Method docstring.""" + ... + + def GetManifestResourceInfo(self, resourceName: str) -> ManifestResourceInfo: + """Method docstring.""" + ... + + def GetManifestResourceNames(self) -> Array[str]: + """Method docstring.""" + ... + + def GetManifestResourceStream(self, type: Type, name: str) -> Stream: + """Method docstring.""" + ... + + @overload + def GetManifestResourceStream(self, name: str) -> Stream: + """Method docstring.""" + ... + + def GetModule(self, name: str) -> Module: + """Method docstring.""" + ... + + def GetModules(self) -> Array[Module]: + """Method docstring.""" + ... + + @overload + def GetModules(self, getResourceModules: bool) -> Array[Module]: + """Method docstring.""" + ... + + def GetName(self) -> AssemblyName: + """Method docstring.""" + ... + + @overload + def GetName(self, copiedName: bool) -> AssemblyName: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetReferencedAssemblies(self) -> Array[AssemblyName]: + """Method docstring.""" + ... + + def GetSatelliteAssembly(self, culture: CultureInfo) -> Assembly: + """Method docstring.""" + ... + + @overload + def GetSatelliteAssembly(self, culture: CultureInfo, version: Version) -> Assembly: + """Method docstring.""" + ... + + def GetType(self, name: str) -> Type: + """Method docstring.""" + ... + + @overload + def GetType(self, name: str, throwOnError: bool) -> Type: + """Method docstring.""" + ... + + @overload + def GetType(self, name: str, throwOnError: bool, ignoreCase: bool) -> Type: + """Method docstring.""" + ... + + @overload + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetTypes(self) -> Array[Type]: + """Method docstring.""" + ... + + def IsDefined(self, attributeType: Type, inherit: bool) -> bool: + """Method docstring.""" + ... + + @staticmethod + def Load(assemblyString: str) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def Load(assemblyString: str, assemblySecurity: Evidence) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def Load(assemblyRef: AssemblyName) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def Load(assemblyRef: AssemblyName, assemblySecurity: Evidence) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def Load(rawAssembly: Array[int]) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def Load(rawAssembly: Array[int], rawSymbolStore: Array[int]) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def Load(rawAssembly: Array[int], rawSymbolStore: Array[int], securityContextSource: SecurityContextSource) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def Load(rawAssembly: Array[int], rawSymbolStore: Array[int], securityEvidence: Evidence) -> Assembly: + """Method docstring.""" + ... + + @staticmethod + def LoadFile(path: str) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def LoadFile(path: str, securityEvidence: Evidence) -> Assembly: + """Method docstring.""" + ... + + @staticmethod + def LoadFrom(assemblyFile: str) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def LoadFrom(assemblyFile: str, securityEvidence: Evidence) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def LoadFrom(assemblyFile: str, securityEvidence: Evidence, hashValue: Array[int], hashAlgorithm: AssemblyHashAlgorithm) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def LoadFrom(assemblyFile: str, hashValue: Array[int], hashAlgorithm: AssemblyHashAlgorithm) -> Assembly: + """Method docstring.""" + ... + + def LoadModule(self, moduleName: str, rawModule: Array[int]) -> Module: + """Method docstring.""" + ... + + @overload + def LoadModule(self, moduleName: str, rawModule: Array[int], rawSymbolStore: Array[int]) -> Module: + """Method docstring.""" + ... + + @staticmethod + def LoadWithPartialName(partialName: str) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def LoadWithPartialName(partialName: str, securityEvidence: Evidence) -> Assembly: + """Method docstring.""" + ... + + @staticmethod + def ReflectionOnlyLoad(assemblyString: str) -> Assembly: + """Method docstring.""" + ... + + @overload + @staticmethod + def ReflectionOnlyLoad(rawAssembly: Array[int]) -> Assembly: + """Method docstring.""" + ... + + @staticmethod + def ReflectionOnlyLoadFrom(assemblyFile: str) -> Assembly: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + @staticmethod + def UnsafeLoadFrom(assemblyFile: str) -> Assembly: + """Method docstring.""" + ... + + +class AssemblyName: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, assemblyName: str) -> None: + """Initialize instance.""" + ... + + @property + def CodeBase(self) -> str: + """str: Property docstring.""" + ... + + @CodeBase.setter + def CodeBase(self, value: str) -> None: + """Set property value.""" + ... + + @property + def ContentType(self) -> AssemblyContentType: + """AssemblyContentType: Property docstring.""" + ... + + @ContentType.setter + def ContentType(self, value: AssemblyContentType) -> None: + """Set property value.""" + ... + + @property + def CultureInfo(self) -> CultureInfo: + """CultureInfo: Property docstring.""" + ... + + @CultureInfo.setter + def CultureInfo(self, value: CultureInfo) -> None: + """Set property value.""" + ... + + @property + def CultureName(self) -> str: + """str: Property docstring.""" + ... + + @CultureName.setter + def CultureName(self, value: str) -> None: + """Set property value.""" + ... + + @property + def EscapedCodeBase(self) -> str: + """str: Property docstring.""" + ... + + @property + def Flags(self) -> AssemblyNameFlags: + """AssemblyNameFlags: Property docstring.""" + ... + + @Flags.setter + def Flags(self, value: AssemblyNameFlags) -> None: + """Set property value.""" + ... + + @property + def FullName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HashAlgorithm(self) -> AssemblyHashAlgorithm: + """AssemblyHashAlgorithm: Property docstring.""" + ... + + @HashAlgorithm.setter + def HashAlgorithm(self, value: AssemblyHashAlgorithm) -> None: + """Set property value.""" + ... + + @property + def KeyPair(self) -> StrongNameKeyPair: + """StrongNameKeyPair: Property docstring.""" + ... + + @KeyPair.setter + def KeyPair(self, value: StrongNameKeyPair) -> None: + """Set property value.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @Name.setter + def Name(self, value: str) -> None: + """Set property value.""" + ... + + @property + def ProcessorArchitecture(self) -> ProcessorArchitecture: + """ProcessorArchitecture: Property docstring.""" + ... + + @ProcessorArchitecture.setter + def ProcessorArchitecture(self, value: ProcessorArchitecture) -> None: + """Set property value.""" + ... + + @property + def Version(self) -> Version: + """Version: Property docstring.""" + ... + + @Version.setter + def Version(self, value: Version) -> None: + """Set property value.""" + ... + + @property + def VersionCompatibility(self) -> AssemblyVersionCompatibility: + """AssemblyVersionCompatibility: Property docstring.""" + ... + + @VersionCompatibility.setter + def VersionCompatibility(self, value: AssemblyVersionCompatibility) -> None: + """Set property value.""" + ... + + def Clone(self) -> Any: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + @staticmethod + def GetAssemblyName(assemblyFile: str) -> AssemblyName: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetPublicKey(self) -> Array[int]: + """Method docstring.""" + ... + + def GetPublicKeyToken(self) -> Array[int]: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def OnDeserialization(self, sender: Any) -> None: + """Method docstring.""" + ... + + @staticmethod + def ReferenceMatchesDefinition(reference: AssemblyName, definition: AssemblyName) -> bool: + """Method docstring.""" + ... + + def SetPublicKey(self, publicKey: Array[int]) -> None: + """Method docstring.""" + ... + + def SetPublicKeyToken(self, publicKeyToken: Array[int]) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class MethodBase(MemberInfo): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Attributes(self) -> MethodAttributes: + """MethodAttributes: Property docstring.""" + ... + + @property + def CallingConvention(self) -> CallingConventions: + """CallingConventions: Property docstring.""" + ... + + @property + def ContainsGenericParameters(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def CustomAttributes(self) -> List[CustomAttributeData]: + """List[CustomAttributeData]: Property docstring.""" + ... + + @property + def DeclaringType(self) -> Type: + """Type: Property docstring.""" + ... + + @property + def IsAbstract(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsAssembly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsConstructor(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsFamily(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsFamilyAndAssembly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsFamilyOrAssembly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsFinal(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsGenericMethod(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsGenericMethodDefinition(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsHideBySig(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsPrivate(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsPublic(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSecurityCritical(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSecuritySafeCritical(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSecurityTransparent(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSpecialName(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsStatic(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsVirtual(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def MemberType(self) -> MemberTypes: + """MemberTypes: Property docstring.""" + ... + + @property + def MetadataToken(self) -> int: + """int: Property docstring.""" + ... + + @property + def MethodHandle(self) -> RuntimeMethodHandle: + """RuntimeMethodHandle: Property docstring.""" + ... + + @property + def MethodImplementationFlags(self) -> MethodImplAttributes: + """MethodImplAttributes: Property docstring.""" + ... + + @property + def Module(self) -> Module: + """Module: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def ReflectedType(self) -> Type: + """Type: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + @staticmethod + def GetCurrentMethod() -> MethodBase: + """Method docstring.""" + ... + + def GetCustomAttributes(self, inherit: bool) -> Array[Any]: + """Method docstring.""" + ... + + @overload + def GetCustomAttributes(self, attributeType: Type, inherit: bool) -> Array[Any]: + """Method docstring.""" + ... + + def GetCustomAttributesData(self) -> List[CustomAttributeData]: + """Method docstring.""" + ... + + def GetGenericArguments(self) -> Array[Type]: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetMethodBody(self) -> MethodBody: + """Method docstring.""" + ... + + @staticmethod + def GetMethodFromHandle(handle: RuntimeMethodHandle) -> MethodBase: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetMethodFromHandle(handle: RuntimeMethodHandle, declaringType: RuntimeTypeHandle) -> MethodBase: + """Method docstring.""" + ... + + def GetMethodImplementationFlags(self) -> MethodImplAttributes: + """Method docstring.""" + ... + + def GetParameters(self) -> Array[ParameterInfo]: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Invoke(self, obj: Any, parameters: Array[Any]) -> Any: + """Method docstring.""" + ... + + @overload + def Invoke(self, obj: Any, invokeAttr: BindingFlags, binder: Binder, parameters: Array[Any], culture: CultureInfo) -> Any: + """Method docstring.""" + ... + + def IsDefined(self, attributeType: Type, inherit: bool) -> bool: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class MethodInfo(MethodBase): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Attributes(self) -> MethodAttributes: + """MethodAttributes: Property docstring.""" + ... + + @property + def CallingConvention(self) -> CallingConventions: + """CallingConventions: Property docstring.""" + ... + + @property + def ContainsGenericParameters(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def CustomAttributes(self) -> List[CustomAttributeData]: + """List[CustomAttributeData]: Property docstring.""" + ... + + @property + def DeclaringType(self) -> Type: + """Type: Property docstring.""" + ... + + @property + def IsAbstract(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsAssembly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsConstructor(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsFamily(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsFamilyAndAssembly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsFamilyOrAssembly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsFinal(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsGenericMethod(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsGenericMethodDefinition(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsHideBySig(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsPrivate(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsPublic(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSecurityCritical(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSecuritySafeCritical(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSecurityTransparent(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSpecialName(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsStatic(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsVirtual(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def MemberType(self) -> MemberTypes: + """MemberTypes: Property docstring.""" + ... + + @property + def MetadataToken(self) -> int: + """int: Property docstring.""" + ... + + @property + def MethodHandle(self) -> RuntimeMethodHandle: + """RuntimeMethodHandle: Property docstring.""" + ... + + @property + def MethodImplementationFlags(self) -> MethodImplAttributes: + """MethodImplAttributes: Property docstring.""" + ... + + @property + def Module(self) -> Module: + """Module: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def ReflectedType(self) -> Type: + """Type: Property docstring.""" + ... + + @property + def ReturnParameter(self) -> ParameterInfo: + """ParameterInfo: Property docstring.""" + ... + + @property + def ReturnType(self) -> Type: + """Type: Property docstring.""" + ... + + @property + def ReturnTypeCustomAttributes(self) -> RuntimeType: + """RuntimeType: Property docstring.""" + ... + + def CreateDelegate(self, delegateType: Type) -> Delegate: + """Method docstring.""" + ... + + @overload + def CreateDelegate(self, delegateType: Type, target: Any) -> Delegate: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetBaseDefinition(self) -> MethodInfo: + """Method docstring.""" + ... + + def GetCustomAttributes(self, inherit: bool) -> Array[Any]: + """Method docstring.""" + ... + + @overload + def GetCustomAttributes(self, attributeType: Type, inherit: bool) -> Array[Any]: + """Method docstring.""" + ... + + def GetCustomAttributesData(self) -> List[CustomAttributeData]: + """Method docstring.""" + ... + + def GetGenericArguments(self) -> Array[Type]: + """Method docstring.""" + ... + + def GetGenericMethodDefinition(self) -> MethodInfo: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetMethodBody(self) -> MethodBody: + """Method docstring.""" + ... + + def GetMethodImplementationFlags(self) -> MethodImplAttributes: + """Method docstring.""" + ... + + def GetParameters(self) -> Array[ParameterInfo]: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Invoke(self, obj: Any, parameters: Array[Any]) -> Any: + """Method docstring.""" + ... + + @overload + def Invoke(self, obj: Any, invokeAttr: BindingFlags, binder: Binder, parameters: Array[Any], culture: CultureInfo) -> Any: + """Method docstring.""" + ... + + def IsDefined(self, attributeType: Type, inherit: bool) -> bool: + """Method docstring.""" + ... + + def MakeGenericMethod(self, typeArguments: Array[Type]) -> MethodInfo: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/__init__.pyi b/pyesapi/stubs/System/Runtime/InteropServices/WindowsRuntime/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/PlanValidationResultDetail/__init__.pyi rename to pyesapi/stubs/System/Runtime/InteropServices/WindowsRuntime/__init__.py diff --git a/pyesapi/stubs/System/Runtime/InteropServices/WindowsRuntime/__init__.pyi b/pyesapi/stubs/System/Runtime/InteropServices/WindowsRuntime/__init__.pyi new file mode 100644 index 0000000..ef5db5b --- /dev/null +++ b/pyesapi/stubs/System/Runtime/InteropServices/WindowsRuntime/__init__.pyi @@ -0,0 +1,27 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Type, ValueType + +class Point(ValueType): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/SegmentProfile/__init__.pyi b/pyesapi/stubs/System/Runtime/InteropServices/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/SegmentProfile/__init__.pyi rename to pyesapi/stubs/System/Runtime/InteropServices/__init__.py diff --git a/pyesapi/stubs/System/Runtime/InteropServices/__init__.pyi b/pyesapi/stubs/System/Runtime/InteropServices/__init__.pyi new file mode 100644 index 0000000..3eec92e --- /dev/null +++ b/pyesapi/stubs/System/Runtime/InteropServices/__init__.pyi @@ -0,0 +1,102 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Type +from System import Exception, IntPtr +from System.Reflection import MethodBase +from System.Runtime.Serialization import SerializationInfo, StreamingContext + +class _Attribute: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def GetIDsOfNames(self, riid: str, rgszNames: IntPtr, cNames: int, lcid: int, rgDispId: IntPtr) -> None: + """Method docstring.""" + ... + + def GetTypeInfo(self, iTInfo: int, lcid: int, ppTInfo: IntPtr) -> None: + """Method docstring.""" + ... + + def GetTypeInfoCount(self, pcTInfo: int) -> None: + """Method docstring.""" + ... + + def Invoke(self, dispIdMember: int, riid: str, lcid: int, wFlags: int, pDispParams: IntPtr, pVarResult: IntPtr, pExcepInfo: IntPtr, puArgErr: IntPtr) -> None: + """Method docstring.""" + ... + + +class _Exception: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def HelpLink(self) -> str: + """str: Property docstring.""" + ... + + @HelpLink.setter + def HelpLink(self, value: str) -> None: + """Set property value.""" + ... + + @property + def InnerException(self) -> Exception: + """Exception: Property docstring.""" + ... + + @property + def Message(self) -> str: + """str: Property docstring.""" + ... + + @property + def Source(self) -> str: + """str: Property docstring.""" + ... + + @Source.setter + def Source(self, value: str) -> None: + """Set property value.""" + ... + + @property + def StackTrace(self) -> str: + """str: Property docstring.""" + ... + + @property + def TargetSite(self) -> MethodBase: + """MethodBase: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetBaseException(self) -> Exception: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/Types/__init__.pyi b/pyesapi/stubs/System/Runtime/Serialization/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/Types/__init__.pyi rename to pyesapi/stubs/System/Runtime/Serialization/__init__.py diff --git a/pyesapi/stubs/System/Runtime/Serialization/__init__.pyi b/pyesapi/stubs/System/Runtime/Serialization/__init__.pyi new file mode 100644 index 0000000..38ae5aa --- /dev/null +++ b/pyesapi/stubs/System/Runtime/Serialization/__init__.pyi @@ -0,0 +1,262 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Type, ValueType + +class SerializationInfo: + """Class docstring.""" + + def __init__(self, type: Type, converter: FormatterConverter) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, type: Type, converter: FormatterConverter, requireSameTokenInPartialTrust: bool) -> None: + """Initialize instance.""" + ... + + @property + def AssemblyName(self) -> str: + """str: Property docstring.""" + ... + + @AssemblyName.setter + def AssemblyName(self, value: str) -> None: + """Set property value.""" + ... + + @property + def FullTypeName(self) -> str: + """str: Property docstring.""" + ... + + @FullTypeName.setter + def FullTypeName(self, value: str) -> None: + """Set property value.""" + ... + + @property + def IsAssemblyNameSetExplicit(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsFullTypeNameSetExplicit(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def MemberCount(self) -> int: + """int: Property docstring.""" + ... + + @property + def ObjectType(self) -> Type: + """Type: Property docstring.""" + ... + + def AddValue(self, name: str, value: Any, type: Type) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: Any) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: bool) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: Char) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: int) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: int) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: int) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: int) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: int) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: int) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: int) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: int) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: float) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: float) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: float) -> None: + """Method docstring.""" + ... + + @overload + def AddValue(self, name: str, value: datetime) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetBoolean(self, name: str) -> bool: + """Method docstring.""" + ... + + def GetByte(self, name: str) -> int: + """Method docstring.""" + ... + + def GetChar(self, name: str) -> Char: + """Method docstring.""" + ... + + def GetDateTime(self, name: str) -> datetime: + """Method docstring.""" + ... + + def GetDecimal(self, name: str) -> float: + """Method docstring.""" + ... + + def GetDouble(self, name: str) -> float: + """Method docstring.""" + ... + + def GetEnumerator(self) -> SerializationInfoEnumerator: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetInt16(self, name: str) -> int: + """Method docstring.""" + ... + + def GetInt32(self, name: str) -> int: + """Method docstring.""" + ... + + def GetInt64(self, name: str) -> int: + """Method docstring.""" + ... + + def GetSByte(self, name: str) -> int: + """Method docstring.""" + ... + + def GetSingle(self, name: str) -> float: + """Method docstring.""" + ... + + def GetString(self, name: str) -> str: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetUInt16(self, name: str) -> int: + """Method docstring.""" + ... + + def GetUInt32(self, name: str) -> int: + """Method docstring.""" + ... + + def GetUInt64(self, name: str) -> int: + """Method docstring.""" + ... + + def GetValue(self, name: str, type: Type) -> Any: + """Method docstring.""" + ... + + def SetType(self, type: Type) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class StreamingContext(ValueType): + """Class docstring.""" + + def __init__(self, state: StreamingContextStates) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, state: StreamingContextStates, additional: Any) -> None: + """Initialize instance.""" + ... + + @property + def Context(self) -> Any: + """Any: Property docstring.""" + ... + + @property + def State(self) -> StreamingContextStates: + """StreamingContextStates: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/__init__.pyi b/pyesapi/stubs/System/Runtime/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/Model/__init__.pyi rename to pyesapi/stubs/System/Runtime/__init__.py diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/__init__.pyi b/pyesapi/stubs/System/Text/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/Common/__init__.pyi rename to pyesapi/stubs/System/Text/__init__.py diff --git a/pyesapi/stubs/System/Text/__init__.pyi b/pyesapi/stubs/System/Text/__init__.pyi new file mode 100644 index 0000000..c801394 --- /dev/null +++ b/pyesapi/stubs/System/Text/__init__.pyi @@ -0,0 +1,370 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Array, Type +from System import AggregateException +from System.Globalization import CultureInfo + +class StringBuilder: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, capacity: int) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, value: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, value: str, capacity: int) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, value: str, startIndex: int, length: int, capacity: int) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, capacity: int, maxCapacity: int) -> None: + """Initialize instance.""" + ... + + @property + def Capacity(self) -> int: + """int: Property docstring.""" + ... + + @Capacity.setter + def Capacity(self, value: int) -> None: + """Set property value.""" + ... + + @property + def Chars(self) -> Char: + """Char: Property docstring.""" + ... + + @Chars.setter + def Chars(self, value: Char) -> None: + """Set property value.""" + ... + + @property + def Length(self) -> int: + """int: Property docstring.""" + ... + + @Length.setter + def Length(self, value: int) -> None: + """Set property value.""" + ... + + @property + def MaxCapacity(self) -> int: + """int: Property docstring.""" + ... + + def Append(self, value: Char, repeatCount: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: Array[Char], startIndex: int, charCount: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: str) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: str, startIndex: int, count: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: Char) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: float) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: float) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: float) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: Any) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: Array[Char]) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: Any, valueCount: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Append(self, value: bool) -> StringBuilder: + """Method docstring.""" + ... + + def AppendFormat(self, format: str, arg0: Any) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def AppendFormat(self, format: str, arg0: Any, arg1: Any) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def AppendFormat(self, format: str, arg0: Any, arg1: Any, arg2: Any) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def AppendFormat(self, provider: CultureInfo, format: str, arg0: Any) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def AppendFormat(self, provider: CultureInfo, format: str, arg0: Any, arg1: Any) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def AppendFormat(self, provider: CultureInfo, format: str, arg0: Any, arg1: Any, arg2: Any) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def AppendFormat(self, format: str, args: Array[Any]) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def AppendFormat(self, provider: CultureInfo, format: str, args: Array[Any]) -> StringBuilder: + """Method docstring.""" + ... + + def AppendLine(self) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def AppendLine(self, value: str) -> StringBuilder: + """Method docstring.""" + ... + + def Clear(self) -> StringBuilder: + """Method docstring.""" + ... + + def CopyTo(self, sourceIndex: int, destination: Array[Char], destinationIndex: int, count: int) -> None: + """Method docstring.""" + ... + + def EnsureCapacity(self, capacity: int) -> int: + """Method docstring.""" + ... + + def Equals(self, sb: StringBuilder) -> bool: + """Method docstring.""" + ... + + @overload + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Insert(self, index: int, value: str, count: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: str) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: Char) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: Array[Char]) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: Array[Char], startIndex: int, charCount: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: float) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: float) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: float) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: Any) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Insert(self, index: int, value: bool) -> StringBuilder: + """Method docstring.""" + ... + + def Remove(self, startIndex: int, length: int) -> StringBuilder: + """Method docstring.""" + ... + + def Replace(self, oldValue: str, newValue: str) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Replace(self, oldValue: str, newValue: str, startIndex: int, count: int) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Replace(self, oldChar: Char, newChar: Char) -> StringBuilder: + """Method docstring.""" + ... + + @overload + def Replace(self, oldChar: Char, newChar: Char, startIndex: int, count: int) -> StringBuilder: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + @overload + def ToString(self, startIndex: int, length: int) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/__init__.pyi b/pyesapi/stubs/System/Threading/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/TPS/__init__.pyi rename to pyesapi/stubs/System/Threading/__init__.py diff --git a/pyesapi/stubs/System/Threading/__init__.pyi b/pyesapi/stubs/System/Threading/__init__.pyi new file mode 100644 index 0000000..53594bf --- /dev/null +++ b/pyesapi/stubs/System/Threading/__init__.pyi @@ -0,0 +1,132 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Array, MulticastDelegate, Type +from System import AggregateException, AsyncCallback, Delegate, IntPtr +from System.IO import FileStreamAsyncResult +from System.Reflection import MethodInfo +from System.Runtime.Serialization import SerializationInfo, StreamingContext + +class SendOrPostCallback(MulticastDelegate): + """Class docstring.""" + + def __init__(self, object: Any, method: IntPtr) -> None: + """Initialize instance.""" + ... + + @property + def Method(self) -> MethodInfo: + """MethodInfo: Property docstring.""" + ... + + @property + def Target(self) -> Any: + """Any: Property docstring.""" + ... + + def BeginInvoke(self, state: Any, callback: AsyncCallback, object: Any) -> FileStreamAsyncResult: + """Method docstring.""" + ... + + def Clone(self) -> Any: + """Method docstring.""" + ... + + def DynamicInvoke(self, args: Array[Any]) -> Any: + """Method docstring.""" + ... + + def EndInvoke(self, result: FileStreamAsyncResult) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetInvocationList(self) -> Array[Delegate]: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Invoke(self, state: Any) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class SynchronizationContext: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @classmethod + @property + def Current(cls) -> SynchronizationContext: + """SynchronizationContext: Property docstring.""" + ... + + def CreateCopy(self) -> SynchronizationContext: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def IsWaitNotificationRequired(self) -> bool: + """Method docstring.""" + ... + + def OperationCompleted(self) -> None: + """Method docstring.""" + ... + + def OperationStarted(self) -> None: + """Method docstring.""" + ... + + def Post(self, d: SendOrPostCallback, state: Any) -> None: + """Method docstring.""" + ... + + def Send(self, d: SendOrPostCallback, state: Any) -> None: + """Method docstring.""" + ... + + @staticmethod + def SetSynchronizationContext(syncContext: SynchronizationContext) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def Wait(self, waitHandles: Array[IntPtr], waitAll: bool, millisecondsTimeout: int) -> int: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/__init__.pyi b/pyesapi/stubs/System/Xml/Schema/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/VVector/Item(VMS/__init__.pyi rename to pyesapi/stubs/System/Xml/Schema/__init__.py diff --git a/pyesapi/stubs/System/Xml/Schema/__init__.pyi b/pyesapi/stubs/System/Xml/Schema/__init__.pyi new file mode 100644 index 0000000..444ad20 --- /dev/null +++ b/pyesapi/stubs/System/Xml/Schema/__init__.pyi @@ -0,0 +1,260 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Array, Type +from System.Xml import XmlReader, XmlWriter + +class XmlSchema(XmlSchemaObject): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def AttributeFormDefault(self) -> XmlSchemaForm: + """XmlSchemaForm: Property docstring.""" + ... + + @AttributeFormDefault.setter + def AttributeFormDefault(self, value: XmlSchemaForm) -> None: + """Set property value.""" + ... + + @property + def AttributeGroups(self) -> XmlSchemaObjectTable: + """XmlSchemaObjectTable: Property docstring.""" + ... + + @property + def Attributes(self) -> XmlSchemaObjectTable: + """XmlSchemaObjectTable: Property docstring.""" + ... + + @property + def BlockDefault(self) -> XmlSchemaDerivationMethod: + """XmlSchemaDerivationMethod: Property docstring.""" + ... + + @BlockDefault.setter + def BlockDefault(self, value: XmlSchemaDerivationMethod) -> None: + """Set property value.""" + ... + + @property + def ElementFormDefault(self) -> XmlSchemaForm: + """XmlSchemaForm: Property docstring.""" + ... + + @ElementFormDefault.setter + def ElementFormDefault(self, value: XmlSchemaForm) -> None: + """Set property value.""" + ... + + @property + def Elements(self) -> XmlSchemaObjectTable: + """XmlSchemaObjectTable: Property docstring.""" + ... + + @property + def FinalDefault(self) -> XmlSchemaDerivationMethod: + """XmlSchemaDerivationMethod: Property docstring.""" + ... + + @FinalDefault.setter + def FinalDefault(self, value: XmlSchemaDerivationMethod) -> None: + """Set property value.""" + ... + + @property + def Groups(self) -> XmlSchemaObjectTable: + """XmlSchemaObjectTable: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Includes(self) -> XmlSchemaObjectCollection: + """XmlSchemaObjectCollection: Property docstring.""" + ... + + @property + def IsCompiled(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def Items(self) -> XmlSchemaObjectCollection: + """XmlSchemaObjectCollection: Property docstring.""" + ... + + @property + def LineNumber(self) -> int: + """int: Property docstring.""" + ... + + @LineNumber.setter + def LineNumber(self, value: int) -> None: + """Set property value.""" + ... + + @property + def LinePosition(self) -> int: + """int: Property docstring.""" + ... + + @LinePosition.setter + def LinePosition(self, value: int) -> None: + """Set property value.""" + ... + + @property + def Namespaces(self) -> XmlSerializerNamespaces: + """XmlSerializerNamespaces: Property docstring.""" + ... + + @Namespaces.setter + def Namespaces(self, value: XmlSerializerNamespaces) -> None: + """Set property value.""" + ... + + @property + def Notations(self) -> XmlSchemaObjectTable: + """XmlSchemaObjectTable: Property docstring.""" + ... + + @property + def Parent(self) -> XmlSchemaObject: + """XmlSchemaObject: Property docstring.""" + ... + + @Parent.setter + def Parent(self, value: XmlSchemaObject) -> None: + """Set property value.""" + ... + + @property + def SchemaTypes(self) -> XmlSchemaObjectTable: + """XmlSchemaObjectTable: Property docstring.""" + ... + + @property + def SourceUri(self) -> str: + """str: Property docstring.""" + ... + + @SourceUri.setter + def SourceUri(self, value: str) -> None: + """Set property value.""" + ... + + @property + def TargetNamespace(self) -> str: + """str: Property docstring.""" + ... + + @TargetNamespace.setter + def TargetNamespace(self, value: str) -> None: + """Set property value.""" + ... + + @property + def UnhandledAttributes(self) -> Array[XmlAttribute]: + """Array[XmlAttribute]: Property docstring.""" + ... + + @UnhandledAttributes.setter + def UnhandledAttributes(self, value: Array[XmlAttribute]) -> None: + """Set property value.""" + ... + + @property + def Version(self) -> str: + """str: Property docstring.""" + ... + + @Version.setter + def Version(self, value: str) -> None: + """Set property value.""" + ... + + def Compile(self, validationEventHandler: ValidationEventHandler, resolver: XmlResolver) -> None: + """Method docstring.""" + ... + + @overload + def Compile(self, validationEventHandler: ValidationEventHandler) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + @staticmethod + def Read(reader: TextReader, validationEventHandler: ValidationEventHandler) -> XmlSchema: + """Method docstring.""" + ... + + @overload + @staticmethod + def Read(stream: Stream, validationEventHandler: ValidationEventHandler) -> XmlSchema: + """Method docstring.""" + ... + + @overload + @staticmethod + def Read(reader: XmlReader, validationEventHandler: ValidationEventHandler) -> XmlSchema: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def Write(self, stream: Stream) -> None: + """Method docstring.""" + ... + + @overload + def Write(self, stream: Stream, namespaceManager: XmlNamespaceManager) -> None: + """Method docstring.""" + ... + + @overload + def Write(self, writer: TextWriter) -> None: + """Method docstring.""" + ... + + @overload + def Write(self, writer: TextWriter, namespaceManager: XmlNamespaceManager) -> None: + """Method docstring.""" + ... + + @overload + def Write(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + @overload + def Write(self, writer: XmlWriter, namespaceManager: XmlNamespaceManager) -> None: + """Method docstring.""" + ... + + InstanceNamespace: str + Namespace: str diff --git a/pyesapi/VMS/TPS/Common/Model/Types/VVector/__init__.pyi b/pyesapi/stubs/System/Xml/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/VVector/__init__.pyi rename to pyesapi/stubs/System/Xml/__init__.py diff --git a/pyesapi/stubs/System/Xml/__init__.pyi b/pyesapi/stubs/System/Xml/__init__.pyi new file mode 100644 index 0000000..df1b36e --- /dev/null +++ b/pyesapi/stubs/System/Xml/__init__.pyi @@ -0,0 +1,1073 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Array, Type +from Microsoft.Win32 import RegistryKey +from System.Text import StringBuilder + +class XmlReader: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def AttributeCount(self) -> int: + """int: Property docstring.""" + ... + + @property + def BaseURI(self) -> str: + """str: Property docstring.""" + ... + + @property + def CanReadBinaryContent(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def CanReadValueChunk(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def CanResolveEntity(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def Depth(self) -> int: + """int: Property docstring.""" + ... + + @property + def EOF(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def HasAttributes(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def HasValue(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsDefault(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsEmptyElement(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def Item(self) -> str: + """str: Property docstring.""" + ... + + @property + def LocalName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def NameTable(self) -> XmlNameTable: + """XmlNameTable: Property docstring.""" + ... + + @property + def NamespaceURI(self) -> str: + """str: Property docstring.""" + ... + + @property + def NodeType(self) -> XmlNodeType: + """XmlNodeType: Property docstring.""" + ... + + @property + def Prefix(self) -> str: + """str: Property docstring.""" + ... + + @property + def QuoteChar(self) -> Char: + """Char: Property docstring.""" + ... + + @property + def ReadState(self) -> ReadState: + """ReadState: Property docstring.""" + ... + + @property + def SchemaInfo(self) -> XmlAsyncCheckReaderWithLineInfoNSSchema: + """XmlAsyncCheckReaderWithLineInfoNSSchema: Property docstring.""" + ... + + @property + def Settings(self) -> XmlReaderSettings: + """XmlReaderSettings: Property docstring.""" + ... + + @property + def Value(self) -> str: + """str: Property docstring.""" + ... + + @property + def ValueType(self) -> Type: + """Type: Property docstring.""" + ... + + @property + def XmlLang(self) -> str: + """str: Property docstring.""" + ... + + @property + def XmlSpace(self) -> XmlSpace: + """XmlSpace: Property docstring.""" + ... + + def Close(self) -> None: + """Method docstring.""" + ... + + @staticmethod + def Create(inputUri: str) -> XmlReader: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(inputUri: str, settings: XmlReaderSettings) -> XmlReader: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(inputUri: str, settings: XmlReaderSettings, inputContext: XmlParserContext) -> XmlReader: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(input: Stream) -> XmlReader: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(input: Stream, settings: XmlReaderSettings) -> XmlReader: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(input: Stream, settings: XmlReaderSettings, baseUri: str) -> XmlReader: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(input: Stream, settings: XmlReaderSettings, inputContext: XmlParserContext) -> XmlReader: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(input: TextReader) -> XmlReader: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(input: TextReader, settings: XmlReaderSettings) -> XmlReader: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(input: TextReader, settings: XmlReaderSettings, baseUri: str) -> XmlReader: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(input: TextReader, settings: XmlReaderSettings, inputContext: XmlParserContext) -> XmlReader: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(reader: XmlReader, settings: XmlReaderSettings) -> XmlReader: + """Method docstring.""" + ... + + def Dispose(self) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetAttribute(self, name: str) -> str: + """Method docstring.""" + ... + + @overload + def GetAttribute(self, name: str, namespaceURI: str) -> str: + """Method docstring.""" + ... + + @overload + def GetAttribute(self, i: int) -> str: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetValueAsync(self) -> Task[str]: + """Method docstring.""" + ... + + @staticmethod + def IsName(str: str) -> bool: + """Method docstring.""" + ... + + @staticmethod + def IsNameToken(str: str) -> bool: + """Method docstring.""" + ... + + def IsStartElement(self) -> bool: + """Method docstring.""" + ... + + @overload + def IsStartElement(self, name: str) -> bool: + """Method docstring.""" + ... + + @overload + def IsStartElement(self, localname: str, ns: str) -> bool: + """Method docstring.""" + ... + + def LookupNamespace(self, prefix: str) -> str: + """Method docstring.""" + ... + + def MoveToAttribute(self, i: int) -> None: + """Method docstring.""" + ... + + @overload + def MoveToAttribute(self, name: str) -> bool: + """Method docstring.""" + ... + + @overload + def MoveToAttribute(self, name: str, ns: str) -> bool: + """Method docstring.""" + ... + + def MoveToContent(self) -> XmlNodeType: + """Method docstring.""" + ... + + def MoveToContentAsync(self) -> Task[XmlNodeType]: + """Method docstring.""" + ... + + def MoveToElement(self) -> bool: + """Method docstring.""" + ... + + def MoveToFirstAttribute(self) -> bool: + """Method docstring.""" + ... + + def MoveToNextAttribute(self) -> bool: + """Method docstring.""" + ... + + def Read(self) -> bool: + """Method docstring.""" + ... + + def ReadAsync(self) -> Task[bool]: + """Method docstring.""" + ... + + def ReadAttributeValue(self) -> bool: + """Method docstring.""" + ... + + def ReadContentAs(self, returnType: Type, namespaceResolver: ConfigXmlReader) -> Any: + """Method docstring.""" + ... + + def ReadContentAsAsync(self, returnType: Type, namespaceResolver: ConfigXmlReader) -> Task[Any]: + """Method docstring.""" + ... + + def ReadContentAsBase64(self, buffer: Array[int], index: int, count: int) -> int: + """Method docstring.""" + ... + + def ReadContentAsBase64Async(self, buffer: Array[int], index: int, count: int) -> Task[int]: + """Method docstring.""" + ... + + def ReadContentAsBinHex(self, buffer: Array[int], index: int, count: int) -> int: + """Method docstring.""" + ... + + def ReadContentAsBinHexAsync(self, buffer: Array[int], index: int, count: int) -> Task[int]: + """Method docstring.""" + ... + + def ReadContentAsBoolean(self) -> bool: + """Method docstring.""" + ... + + def ReadContentAsDateTime(self) -> datetime: + """Method docstring.""" + ... + + def ReadContentAsDateTimeOffset(self) -> DateTimeOffset: + """Method docstring.""" + ... + + def ReadContentAsDecimal(self) -> float: + """Method docstring.""" + ... + + def ReadContentAsDouble(self) -> float: + """Method docstring.""" + ... + + def ReadContentAsFloat(self) -> float: + """Method docstring.""" + ... + + def ReadContentAsInt(self) -> int: + """Method docstring.""" + ... + + def ReadContentAsLong(self) -> int: + """Method docstring.""" + ... + + def ReadContentAsObject(self) -> Any: + """Method docstring.""" + ... + + def ReadContentAsObjectAsync(self) -> Task[Any]: + """Method docstring.""" + ... + + def ReadContentAsString(self) -> str: + """Method docstring.""" + ... + + def ReadContentAsStringAsync(self) -> Task[str]: + """Method docstring.""" + ... + + def ReadElementContentAs(self, returnType: Type, namespaceResolver: ConfigXmlReader, localName: str, namespaceURI: str) -> Any: + """Method docstring.""" + ... + + @overload + def ReadElementContentAs(self, returnType: Type, namespaceResolver: ConfigXmlReader) -> Any: + """Method docstring.""" + ... + + def ReadElementContentAsAsync(self, returnType: Type, namespaceResolver: ConfigXmlReader) -> Task[Any]: + """Method docstring.""" + ... + + def ReadElementContentAsBase64(self, buffer: Array[int], index: int, count: int) -> int: + """Method docstring.""" + ... + + def ReadElementContentAsBase64Async(self, buffer: Array[int], index: int, count: int) -> Task[int]: + """Method docstring.""" + ... + + def ReadElementContentAsBinHex(self, buffer: Array[int], index: int, count: int) -> int: + """Method docstring.""" + ... + + def ReadElementContentAsBinHexAsync(self, buffer: Array[int], index: int, count: int) -> Task[int]: + """Method docstring.""" + ... + + def ReadElementContentAsBoolean(self, localName: str, namespaceURI: str) -> bool: + """Method docstring.""" + ... + + @overload + def ReadElementContentAsBoolean(self) -> bool: + """Method docstring.""" + ... + + def ReadElementContentAsDateTime(self, localName: str, namespaceURI: str) -> datetime: + """Method docstring.""" + ... + + @overload + def ReadElementContentAsDateTime(self) -> datetime: + """Method docstring.""" + ... + + def ReadElementContentAsDecimal(self, localName: str, namespaceURI: str) -> float: + """Method docstring.""" + ... + + @overload + def ReadElementContentAsDecimal(self) -> float: + """Method docstring.""" + ... + + def ReadElementContentAsDouble(self, localName: str, namespaceURI: str) -> float: + """Method docstring.""" + ... + + @overload + def ReadElementContentAsDouble(self) -> float: + """Method docstring.""" + ... + + def ReadElementContentAsFloat(self, localName: str, namespaceURI: str) -> float: + """Method docstring.""" + ... + + @overload + def ReadElementContentAsFloat(self) -> float: + """Method docstring.""" + ... + + def ReadElementContentAsInt(self, localName: str, namespaceURI: str) -> int: + """Method docstring.""" + ... + + @overload + def ReadElementContentAsInt(self) -> int: + """Method docstring.""" + ... + + def ReadElementContentAsLong(self, localName: str, namespaceURI: str) -> int: + """Method docstring.""" + ... + + @overload + def ReadElementContentAsLong(self) -> int: + """Method docstring.""" + ... + + def ReadElementContentAsObject(self, localName: str, namespaceURI: str) -> Any: + """Method docstring.""" + ... + + @overload + def ReadElementContentAsObject(self) -> Any: + """Method docstring.""" + ... + + def ReadElementContentAsObjectAsync(self) -> Task[Any]: + """Method docstring.""" + ... + + def ReadElementContentAsString(self, localName: str, namespaceURI: str) -> str: + """Method docstring.""" + ... + + @overload + def ReadElementContentAsString(self) -> str: + """Method docstring.""" + ... + + def ReadElementContentAsStringAsync(self) -> Task[str]: + """Method docstring.""" + ... + + def ReadElementString(self, name: str) -> str: + """Method docstring.""" + ... + + @overload + def ReadElementString(self) -> str: + """Method docstring.""" + ... + + @overload + def ReadElementString(self, localname: str, ns: str) -> str: + """Method docstring.""" + ... + + def ReadEndElement(self) -> None: + """Method docstring.""" + ... + + def ReadInnerXml(self) -> str: + """Method docstring.""" + ... + + def ReadInnerXmlAsync(self) -> Task[str]: + """Method docstring.""" + ... + + def ReadOuterXml(self) -> str: + """Method docstring.""" + ... + + def ReadOuterXmlAsync(self) -> Task[str]: + """Method docstring.""" + ... + + def ReadStartElement(self) -> None: + """Method docstring.""" + ... + + @overload + def ReadStartElement(self, name: str) -> None: + """Method docstring.""" + ... + + @overload + def ReadStartElement(self, localname: str, ns: str) -> None: + """Method docstring.""" + ... + + def ReadString(self) -> str: + """Method docstring.""" + ... + + def ReadSubtree(self) -> XmlReader: + """Method docstring.""" + ... + + def ReadToDescendant(self, name: str) -> bool: + """Method docstring.""" + ... + + @overload + def ReadToDescendant(self, localName: str, namespaceURI: str) -> bool: + """Method docstring.""" + ... + + def ReadToFollowing(self, name: str) -> bool: + """Method docstring.""" + ... + + @overload + def ReadToFollowing(self, localName: str, namespaceURI: str) -> bool: + """Method docstring.""" + ... + + def ReadToNextSibling(self, name: str) -> bool: + """Method docstring.""" + ... + + @overload + def ReadToNextSibling(self, localName: str, namespaceURI: str) -> bool: + """Method docstring.""" + ... + + def ReadValueChunk(self, buffer: Array[Char], index: int, count: int) -> int: + """Method docstring.""" + ... + + def ReadValueChunkAsync(self, buffer: Array[Char], index: int, count: int) -> Task[int]: + """Method docstring.""" + ... + + def ResolveEntity(self) -> None: + """Method docstring.""" + ... + + def Skip(self) -> None: + """Method docstring.""" + ... + + def SkipAsync(self) -> Task: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class XmlWriter: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Settings(self) -> XmlWriterSettings: + """XmlWriterSettings: Property docstring.""" + ... + + @property + def WriteState(self) -> WriteState: + """WriteState: Property docstring.""" + ... + + @property + def XmlLang(self) -> str: + """str: Property docstring.""" + ... + + @property + def XmlSpace(self) -> XmlSpace: + """XmlSpace: Property docstring.""" + ... + + def Close(self) -> None: + """Method docstring.""" + ... + + @staticmethod + def Create(outputFileName: str) -> XmlWriter: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(outputFileName: str, settings: XmlWriterSettings) -> XmlWriter: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(output: Stream) -> XmlWriter: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(output: Stream, settings: XmlWriterSettings) -> XmlWriter: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(output: TextWriter) -> XmlWriter: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(output: TextWriter, settings: XmlWriterSettings) -> XmlWriter: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(output: StringBuilder) -> XmlWriter: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(output: StringBuilder, settings: XmlWriterSettings) -> XmlWriter: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(output: XmlWriter) -> XmlWriter: + """Method docstring.""" + ... + + @overload + @staticmethod + def Create(output: XmlWriter, settings: XmlWriterSettings) -> XmlWriter: + """Method docstring.""" + ... + + def Dispose(self) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def Flush(self) -> None: + """Method docstring.""" + ... + + def FlushAsync(self) -> Task: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def LookupPrefix(self, ns: str) -> str: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteAttributeString(self, localName: str, ns: str, value: str) -> None: + """Method docstring.""" + ... + + @overload + def WriteAttributeString(self, localName: str, value: str) -> None: + """Method docstring.""" + ... + + @overload + def WriteAttributeString(self, prefix: str, localName: str, ns: str, value: str) -> None: + """Method docstring.""" + ... + + def WriteAttributeStringAsync(self, prefix: str, localName: str, ns: str, value: str) -> Task: + """Method docstring.""" + ... + + def WriteAttributes(self, reader: XmlReader, defattr: bool) -> None: + """Method docstring.""" + ... + + def WriteAttributesAsync(self, reader: XmlReader, defattr: bool) -> Task: + """Method docstring.""" + ... + + def WriteBase64(self, buffer: Array[int], index: int, count: int) -> None: + """Method docstring.""" + ... + + def WriteBase64Async(self, buffer: Array[int], index: int, count: int) -> Task: + """Method docstring.""" + ... + + def WriteBinHex(self, buffer: Array[int], index: int, count: int) -> None: + """Method docstring.""" + ... + + def WriteBinHexAsync(self, buffer: Array[int], index: int, count: int) -> Task: + """Method docstring.""" + ... + + def WriteCData(self, text: str) -> None: + """Method docstring.""" + ... + + def WriteCDataAsync(self, text: str) -> Task: + """Method docstring.""" + ... + + def WriteCharEntity(self, ch: Char) -> None: + """Method docstring.""" + ... + + def WriteCharEntityAsync(self, ch: Char) -> Task: + """Method docstring.""" + ... + + def WriteChars(self, buffer: Array[Char], index: int, count: int) -> None: + """Method docstring.""" + ... + + def WriteCharsAsync(self, buffer: Array[Char], index: int, count: int) -> Task: + """Method docstring.""" + ... + + def WriteComment(self, text: str) -> None: + """Method docstring.""" + ... + + def WriteCommentAsync(self, text: str) -> Task: + """Method docstring.""" + ... + + def WriteDocType(self, name: str, pubid: str, sysid: str, subset: str) -> None: + """Method docstring.""" + ... + + def WriteDocTypeAsync(self, name: str, pubid: str, sysid: str, subset: str) -> Task: + """Method docstring.""" + ... + + def WriteElementString(self, localName: str, value: str) -> None: + """Method docstring.""" + ... + + @overload + def WriteElementString(self, localName: str, ns: str, value: str) -> None: + """Method docstring.""" + ... + + @overload + def WriteElementString(self, prefix: str, localName: str, ns: str, value: str) -> None: + """Method docstring.""" + ... + + def WriteElementStringAsync(self, prefix: str, localName: str, ns: str, value: str) -> Task: + """Method docstring.""" + ... + + def WriteEndAttribute(self) -> None: + """Method docstring.""" + ... + + def WriteEndDocument(self) -> None: + """Method docstring.""" + ... + + def WriteEndDocumentAsync(self) -> Task: + """Method docstring.""" + ... + + def WriteEndElement(self) -> None: + """Method docstring.""" + ... + + def WriteEndElementAsync(self) -> Task: + """Method docstring.""" + ... + + def WriteEntityRef(self, name: str) -> None: + """Method docstring.""" + ... + + def WriteEntityRefAsync(self, name: str) -> Task: + """Method docstring.""" + ... + + def WriteFullEndElement(self) -> None: + """Method docstring.""" + ... + + def WriteFullEndElementAsync(self) -> Task: + """Method docstring.""" + ... + + def WriteName(self, name: str) -> None: + """Method docstring.""" + ... + + def WriteNameAsync(self, name: str) -> Task: + """Method docstring.""" + ... + + def WriteNmToken(self, name: str) -> None: + """Method docstring.""" + ... + + def WriteNmTokenAsync(self, name: str) -> Task: + """Method docstring.""" + ... + + def WriteNode(self, navigator: XPathNavigator, defattr: bool) -> None: + """Method docstring.""" + ... + + @overload + def WriteNode(self, reader: XmlReader, defattr: bool) -> None: + """Method docstring.""" + ... + + def WriteNodeAsync(self, reader: XmlReader, defattr: bool) -> Task: + """Method docstring.""" + ... + + @overload + def WriteNodeAsync(self, navigator: XPathNavigator, defattr: bool) -> Task: + """Method docstring.""" + ... + + def WriteProcessingInstruction(self, name: str, text: str) -> None: + """Method docstring.""" + ... + + def WriteProcessingInstructionAsync(self, name: str, text: str) -> Task: + """Method docstring.""" + ... + + def WriteQualifiedName(self, localName: str, ns: str) -> None: + """Method docstring.""" + ... + + def WriteQualifiedNameAsync(self, localName: str, ns: str) -> Task: + """Method docstring.""" + ... + + def WriteRaw(self, buffer: Array[Char], index: int, count: int) -> None: + """Method docstring.""" + ... + + @overload + def WriteRaw(self, data: str) -> None: + """Method docstring.""" + ... + + def WriteRawAsync(self, buffer: Array[Char], index: int, count: int) -> Task: + """Method docstring.""" + ... + + @overload + def WriteRawAsync(self, data: str) -> Task: + """Method docstring.""" + ... + + def WriteStartAttribute(self, localName: str, ns: str) -> None: + """Method docstring.""" + ... + + @overload + def WriteStartAttribute(self, localName: str) -> None: + """Method docstring.""" + ... + + @overload + def WriteStartAttribute(self, prefix: str, localName: str, ns: str) -> None: + """Method docstring.""" + ... + + def WriteStartDocument(self) -> None: + """Method docstring.""" + ... + + @overload + def WriteStartDocument(self, standalone: bool) -> None: + """Method docstring.""" + ... + + def WriteStartDocumentAsync(self) -> Task: + """Method docstring.""" + ... + + @overload + def WriteStartDocumentAsync(self, standalone: bool) -> Task: + """Method docstring.""" + ... + + def WriteStartElement(self, localName: str, ns: str) -> None: + """Method docstring.""" + ... + + @overload + def WriteStartElement(self, localName: str) -> None: + """Method docstring.""" + ... + + @overload + def WriteStartElement(self, prefix: str, localName: str, ns: str) -> None: + """Method docstring.""" + ... + + def WriteStartElementAsync(self, prefix: str, localName: str, ns: str) -> Task: + """Method docstring.""" + ... + + def WriteString(self, text: str) -> None: + """Method docstring.""" + ... + + def WriteStringAsync(self, text: str) -> Task: + """Method docstring.""" + ... + + def WriteSurrogateCharEntity(self, lowChar: Char, highChar: Char) -> None: + """Method docstring.""" + ... + + def WriteSurrogateCharEntityAsync(self, lowChar: Char, highChar: Char) -> Task: + """Method docstring.""" + ... + + def WriteValue(self, value: Any) -> None: + """Method docstring.""" + ... + + @overload + def WriteValue(self, value: str) -> None: + """Method docstring.""" + ... + + @overload + def WriteValue(self, value: datetime) -> None: + """Method docstring.""" + ... + + @overload + def WriteValue(self, value: DateTimeOffset) -> None: + """Method docstring.""" + ... + + @overload + def WriteValue(self, value: float) -> None: + """Method docstring.""" + ... + + @overload + def WriteValue(self, value: float) -> None: + """Method docstring.""" + ... + + @overload + def WriteValue(self, value: float) -> None: + """Method docstring.""" + ... + + @overload + def WriteValue(self, value: int) -> None: + """Method docstring.""" + ... + + @overload + def WriteValue(self, value: int) -> None: + """Method docstring.""" + ... + + @overload + def WriteValue(self, value: bool) -> None: + """Method docstring.""" + ... + + def WriteWhitespace(self, ws: str) -> None: + """Method docstring.""" + ... + + def WriteWhitespaceAsync(self, ws: str) -> Task: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/Types/__init__.pyi b/pyesapi/stubs/System/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/Types/__init__.pyi rename to pyesapi/stubs/System/__init__.py diff --git a/pyesapi/stubs/System/__init__.pyi b/pyesapi/stubs/System/__init__.pyi new file mode 100644 index 0000000..bde41dc --- /dev/null +++ b/pyesapi/stubs/System/__init__.pyi @@ -0,0 +1,2564 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System.Collections import IEnumerator +from Microsoft.Win32 import RegistryHive +from System.Collections import DictionaryBase +from System.Globalization import CultureInfo +from System.IO import FileStreamAsyncResult +from System.Reflection import Assembly, AssemblyName, MethodBase, MethodInfo +from System.Runtime.InteropServices import _Attribute, _Exception +from System.Runtime.Serialization import SerializationInfo, StreamingContext + +class Action(MulticastDelegate): + """Class docstring.""" + + def __init__(self, object: Any, method: IntPtr) -> None: + """Initialize instance.""" + ... + + @property + def Method(self) -> MethodInfo: + """MethodInfo: Property docstring.""" + ... + + @property + def Target(self) -> Any: + """Any: Property docstring.""" + ... + + def BeginInvoke(self, callback: AsyncCallback, object: Any) -> FileStreamAsyncResult: + """Method docstring.""" + ... + + def Clone(self) -> Any: + """Method docstring.""" + ... + + def DynamicInvoke(self, args: Array[Any]) -> Any: + """Method docstring.""" + ... + + def EndInvoke(self, result: FileStreamAsyncResult) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetInvocationList(self) -> Array[Delegate]: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Invoke(self) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Action(Generic[T], MulticastDelegate): + """Class docstring.""" + + def __init__(self, object: Any, method: IntPtr) -> None: + """Initialize instance.""" + ... + + @property + def Method(self) -> MethodInfo: + """MethodInfo: Property docstring.""" + ... + + @property + def Target(self) -> Any: + """Any: Property docstring.""" + ... + + def BeginInvoke(self, obj: T, callback: AsyncCallback, object: Any) -> FileStreamAsyncResult: + """Method docstring.""" + ... + + def Clone(self) -> Any: + """Method docstring.""" + ... + + def DynamicInvoke(self, args: Array[Any]) -> Any: + """Method docstring.""" + ... + + def EndInvoke(self, result: FileStreamAsyncResult) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetInvocationList(self) -> Array[Delegate]: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Invoke(self, obj: T) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class AggregateException(Exception): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, message: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, message: str, innerException: Exception) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, innerExceptions: List[Exception]) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, innerExceptions: Array[Exception]) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, message: str, innerExceptions: List[Exception]) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, message: str, innerExceptions: Array[Exception]) -> None: + """Initialize instance.""" + ... + + @property + def Data(self) -> DictionaryBase: + """DictionaryBase: Property docstring.""" + ... + + @property + def HResult(self) -> int: + """int: Property docstring.""" + ... + + @HResult.setter + def HResult(self, value: int) -> None: + """Set property value.""" + ... + + @property + def HelpLink(self) -> str: + """str: Property docstring.""" + ... + + @HelpLink.setter + def HelpLink(self, value: str) -> None: + """Set property value.""" + ... + + @property + def InnerException(self) -> Exception: + """Exception: Property docstring.""" + ... + + @property + def InnerExceptions(self) -> ReadOnlyCollection[Exception]: + """ReadOnlyCollection[Exception]: Property docstring.""" + ... + + @property + def Message(self) -> str: + """str: Property docstring.""" + ... + + @property + def Source(self) -> str: + """str: Property docstring.""" + ... + + @Source.setter + def Source(self, value: str) -> None: + """Set property value.""" + ... + + @property + def StackTrace(self) -> str: + """str: Property docstring.""" + ... + + @property + def TargetSite(self) -> MethodBase: + """MethodBase: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def Flatten(self) -> AggregateException: + """Method docstring.""" + ... + + def GetBaseException(self) -> Exception: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + @overload + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Handle(self, predicate: Func[Exception, bool]) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class ApplicationException(Exception): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, message: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, message: str, innerException: Exception) -> None: + """Initialize instance.""" + ... + + @property + def Data(self) -> DictionaryBase: + """DictionaryBase: Property docstring.""" + ... + + @property + def HResult(self) -> int: + """int: Property docstring.""" + ... + + @HResult.setter + def HResult(self, value: int) -> None: + """Set property value.""" + ... + + @property + def HelpLink(self) -> str: + """str: Property docstring.""" + ... + + @HelpLink.setter + def HelpLink(self, value: str) -> None: + """Set property value.""" + ... + + @property + def InnerException(self) -> Exception: + """Exception: Property docstring.""" + ... + + @property + def Message(self) -> str: + """str: Property docstring.""" + ... + + @property + def Source(self) -> str: + """str: Property docstring.""" + ... + + @Source.setter + def Source(self, value: str) -> None: + """Set property value.""" + ... + + @property + def StackTrace(self) -> str: + """str: Property docstring.""" + ... + + @property + def TargetSite(self) -> MethodBase: + """MethodBase: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetBaseException(self) -> Exception: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + @overload + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Array: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def IsFixedSize(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsReadOnly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSynchronized(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def Length(self) -> int: + """int: Property docstring.""" + ... + + @property + def LongLength(self) -> int: + """int: Property docstring.""" + ... + + @property + def Rank(self) -> int: + """int: Property docstring.""" + ... + + @property + def SyncRoot(self) -> Any: + """Any: Property docstring.""" + ... + + @staticmethod + def AsReadOnly(array: Array[T]) -> ReadOnlyCollection[T]: + """Method docstring.""" + ... + + @staticmethod + def BinarySearch(array: Array, value: Any) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def BinarySearch(array: Array, index: int, length: int, value: Any) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def BinarySearch(array: Array, value: Any, comparer: StringComparer) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def BinarySearch(array: Array[T], value: T) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def BinarySearch(array: Array[T], value: T, comparer: IComparer[T]) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def BinarySearch(array: Array[T], index: int, length: int, value: T) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def BinarySearch(array: Array[T], index: int, length: int, value: T, comparer: IComparer[T]) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def BinarySearch(array: Array, index: int, length: int, value: Any, comparer: StringComparer) -> int: + """Method docstring.""" + ... + + @staticmethod + def Clear(array: Array, index: int, length: int) -> None: + """Method docstring.""" + ... + + def Clone(self) -> Any: + """Method docstring.""" + ... + + @staticmethod + def ConstrainedCopy(sourceArray: Array, sourceIndex: int, destinationArray: Array, destinationIndex: int, length: int) -> None: + """Method docstring.""" + ... + + @staticmethod + def ConvertAll(array: Array[TInput], converter: Converter[TInput, TOutput]) -> Array[TOutput]: + """Method docstring.""" + ... + + @staticmethod + def Copy(sourceArray: Array, destinationArray: Array, length: int) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Copy(sourceArray: Array, sourceIndex: int, destinationArray: Array, destinationIndex: int, length: int) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Copy(sourceArray: Array, destinationArray: Array, length: int) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Copy(sourceArray: Array, sourceIndex: int, destinationArray: Array, destinationIndex: int, length: int) -> None: + """Method docstring.""" + ... + + def CopyTo(self, array: Array, index: int) -> None: + """Method docstring.""" + ... + + @overload + def CopyTo(self, array: Array, index: int) -> None: + """Method docstring.""" + ... + + @staticmethod + def CreateInstance(elementType: Type, length: int) -> Array: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateInstance(elementType: Type, length1: int, length2: int, length3: int) -> Array: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateInstance(elementType: Type, lengths: Array[int]) -> Array: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateInstance(elementType: Type, lengths: Array[int]) -> Array: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateInstance(elementType: Type, lengths: Array[int], lowerBounds: Array[int]) -> Array: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateInstance(elementType: Type, length1: int, length2: int) -> Array: + """Method docstring.""" + ... + + @staticmethod + def Empty() -> Array[T]: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + @staticmethod + def Exists(array: Array[T], match: Predicate[T]) -> bool: + """Method docstring.""" + ... + + @staticmethod + def Find(array: Array[T], match: Predicate[T]) -> T: + """Method docstring.""" + ... + + @staticmethod + def FindAll(array: Array[T], match: Predicate[T]) -> Array[T]: + """Method docstring.""" + ... + + @staticmethod + def FindIndex(array: Array[T], match: Predicate[T]) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def FindIndex(array: Array[T], startIndex: int, match: Predicate[T]) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def FindIndex(array: Array[T], startIndex: int, count: int, match: Predicate[T]) -> int: + """Method docstring.""" + ... + + @staticmethod + def FindLast(array: Array[T], match: Predicate[T]) -> T: + """Method docstring.""" + ... + + @staticmethod + def FindLastIndex(array: Array[T], match: Predicate[T]) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def FindLastIndex(array: Array[T], startIndex: int, match: Predicate[T]) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def FindLastIndex(array: Array[T], startIndex: int, count: int, match: Predicate[T]) -> int: + """Method docstring.""" + ... + + @staticmethod + def ForEach(array: Array[T], action: Action[T]) -> None: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetLength(self, dimension: int) -> int: + """Method docstring.""" + ... + + def GetLongLength(self, dimension: int) -> int: + """Method docstring.""" + ... + + def GetLowerBound(self, dimension: int) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetUpperBound(self, dimension: int) -> int: + """Method docstring.""" + ... + + def GetValue(self, indices: Array[int]) -> Any: + """Method docstring.""" + ... + + @overload + def GetValue(self, index: int) -> Any: + """Method docstring.""" + ... + + @overload + def GetValue(self, index1: int, index2: int) -> Any: + """Method docstring.""" + ... + + @overload + def GetValue(self, index1: int, index2: int, index3: int) -> Any: + """Method docstring.""" + ... + + @overload + def GetValue(self, index: int) -> Any: + """Method docstring.""" + ... + + @overload + def GetValue(self, index1: int, index2: int) -> Any: + """Method docstring.""" + ... + + @overload + def GetValue(self, index1: int, index2: int, index3: int) -> Any: + """Method docstring.""" + ... + + @overload + def GetValue(self, indices: Array[int]) -> Any: + """Method docstring.""" + ... + + @staticmethod + def IndexOf(array: Array, value: Any) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def IndexOf(array: Array, value: Any, startIndex: int) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def IndexOf(array: Array, value: Any, startIndex: int, count: int) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def IndexOf(array: Array[T], value: T) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def IndexOf(array: Array[T], value: T, startIndex: int) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def IndexOf(array: Array[T], value: T, startIndex: int, count: int) -> int: + """Method docstring.""" + ... + + def Initialize(self) -> None: + """Method docstring.""" + ... + + @staticmethod + def LastIndexOf(array: Array, value: Any) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def LastIndexOf(array: Array, value: Any, startIndex: int) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def LastIndexOf(array: Array, value: Any, startIndex: int, count: int) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def LastIndexOf(array: Array[T], value: T) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def LastIndexOf(array: Array[T], value: T, startIndex: int) -> int: + """Method docstring.""" + ... + + @overload + @staticmethod + def LastIndexOf(array: Array[T], value: T, startIndex: int, count: int) -> int: + """Method docstring.""" + ... + + @staticmethod + def Resize(array: Array[T], newSize: int) -> None: + """Method docstring.""" + ... + + @staticmethod + def Reverse(array: Array) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Reverse(array: Array, index: int, length: int) -> None: + """Method docstring.""" + ... + + def SetValue(self, value: Any, index: int) -> None: + """Method docstring.""" + ... + + @overload + def SetValue(self, value: Any, index1: int, index2: int) -> None: + """Method docstring.""" + ... + + @overload + def SetValue(self, value: Any, index1: int, index2: int, index3: int) -> None: + """Method docstring.""" + ... + + @overload + def SetValue(self, value: Any, indices: Array[int]) -> None: + """Method docstring.""" + ... + + @overload + def SetValue(self, value: Any, index: int) -> None: + """Method docstring.""" + ... + + @overload + def SetValue(self, value: Any, index1: int, index2: int) -> None: + """Method docstring.""" + ... + + @overload + def SetValue(self, value: Any, index1: int, index2: int, index3: int) -> None: + """Method docstring.""" + ... + + @overload + def SetValue(self, value: Any, indices: Array[int]) -> None: + """Method docstring.""" + ... + + @staticmethod + def Sort(array: Array) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(keys: Array, items: Array) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(array: Array, index: int, length: int) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(keys: Array, items: Array, index: int, length: int) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(array: Array, comparer: StringComparer) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(keys: Array, items: Array, comparer: StringComparer) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(array: Array, index: int, length: int, comparer: StringComparer) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(array: Array[T]) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(keys: Array[TKey], items: Array[TValue]) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(array: Array[T], index: int, length: int) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(keys: Array[TKey], items: Array[TValue], index: int, length: int) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(array: Array[T], comparer: IComparer[T]) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(keys: Array[TKey], items: Array[TValue], comparer: IComparer[TKey]) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(array: Array[T], index: int, length: int, comparer: IComparer[T]) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(keys: Array[TKey], items: Array[TValue], index: int, length: int, comparer: IComparer[TKey]) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(array: Array[T], comparison: Comparison[T]) -> None: + """Method docstring.""" + ... + + @overload + @staticmethod + def Sort(keys: Array, items: Array, index: int, length: int, comparer: StringComparer) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + @staticmethod + def TrueForAll(array: Array[T], match: Predicate[T]) -> bool: + """Method docstring.""" + ... + + +class AsyncCallback(MulticastDelegate): + """Class docstring.""" + + def __init__(self, object: Any, method: IntPtr) -> None: + """Initialize instance.""" + ... + + @property + def Method(self) -> MethodInfo: + """MethodInfo: Property docstring.""" + ... + + @property + def Target(self) -> Any: + """Any: Property docstring.""" + ... + + def BeginInvoke(self, ar: FileStreamAsyncResult, callback: AsyncCallback, object: Any) -> FileStreamAsyncResult: + """Method docstring.""" + ... + + def Clone(self) -> Any: + """Method docstring.""" + ... + + def DynamicInvoke(self, args: Array[Any]) -> Any: + """Method docstring.""" + ... + + def EndInvoke(self, result: FileStreamAsyncResult) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetInvocationList(self) -> Array[Delegate]: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Invoke(self, ar: FileStreamAsyncResult) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Attribute: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def TypeId(self) -> Any: + """Any: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + @staticmethod + def GetCustomAttribute(element: MemberInfo, attributeType: Type) -> Attribute: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttribute(element: MemberInfo, attributeType: Type, inherit: bool) -> Attribute: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttribute(element: ParameterInfo, attributeType: Type) -> Attribute: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttribute(element: ParameterInfo, attributeType: Type, inherit: bool) -> Attribute: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttribute(element: Module, attributeType: Type) -> Attribute: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttribute(element: Module, attributeType: Type, inherit: bool) -> Attribute: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttribute(element: Assembly, attributeType: Type) -> Attribute: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttribute(element: Assembly, attributeType: Type, inherit: bool) -> Attribute: + """Method docstring.""" + ... + + @staticmethod + def GetCustomAttributes(element: MemberInfo, type: Type) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: MemberInfo, type: Type, inherit: bool) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: MemberInfo) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: MemberInfo, inherit: bool) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: ParameterInfo) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: ParameterInfo, attributeType: Type) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: ParameterInfo, attributeType: Type, inherit: bool) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: ParameterInfo, inherit: bool) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: Module, attributeType: Type) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: Module) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: Module, inherit: bool) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: Module, attributeType: Type, inherit: bool) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: Assembly, attributeType: Type) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: Assembly, attributeType: Type, inherit: bool) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: Assembly) -> Array[Attribute]: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetCustomAttributes(element: Assembly, inherit: bool) -> Array[Attribute]: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def IsDefaultAttribute(self) -> bool: + """Method docstring.""" + ... + + @staticmethod + def IsDefined(element: MemberInfo, attributeType: Type) -> bool: + """Method docstring.""" + ... + + @overload + @staticmethod + def IsDefined(element: MemberInfo, attributeType: Type, inherit: bool) -> bool: + """Method docstring.""" + ... + + @overload + @staticmethod + def IsDefined(element: ParameterInfo, attributeType: Type) -> bool: + """Method docstring.""" + ... + + @overload + @staticmethod + def IsDefined(element: ParameterInfo, attributeType: Type, inherit: bool) -> bool: + """Method docstring.""" + ... + + @overload + @staticmethod + def IsDefined(element: Module, attributeType: Type) -> bool: + """Method docstring.""" + ... + + @overload + @staticmethod + def IsDefined(element: Module, attributeType: Type, inherit: bool) -> bool: + """Method docstring.""" + ... + + @overload + @staticmethod + def IsDefined(element: Assembly, attributeType: Type) -> bool: + """Method docstring.""" + ... + + @overload + @staticmethod + def IsDefined(element: Assembly, attributeType: Type, inherit: bool) -> bool: + """Method docstring.""" + ... + + def Match(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Delegate: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Method(self) -> MethodInfo: + """MethodInfo: Property docstring.""" + ... + + @property + def Target(self) -> Any: + """Any: Property docstring.""" + ... + + def Clone(self) -> Any: + """Method docstring.""" + ... + + @staticmethod + def Combine(a: Delegate, b: Delegate) -> Delegate: + """Method docstring.""" + ... + + @overload + @staticmethod + def Combine(delegates: Array[Delegate]) -> Delegate: + """Method docstring.""" + ... + + @staticmethod + def CreateDelegate(type: Type, target: Any, method: str) -> Delegate: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateDelegate(type: Type, target: Any, method: str, ignoreCase: bool) -> Delegate: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateDelegate(type: Type, target: Any, method: str, ignoreCase: bool, throwOnBindFailure: bool) -> Delegate: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateDelegate(type: Type, target: Type, method: str) -> Delegate: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateDelegate(type: Type, target: Type, method: str, ignoreCase: bool) -> Delegate: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateDelegate(type: Type, target: Type, method: str, ignoreCase: bool, throwOnBindFailure: bool) -> Delegate: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateDelegate(type: Type, method: MethodInfo, throwOnBindFailure: bool) -> Delegate: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateDelegate(type: Type, firstArgument: Any, method: MethodInfo, throwOnBindFailure: bool) -> Delegate: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateDelegate(type: Type, method: MethodInfo) -> Delegate: + """Method docstring.""" + ... + + @overload + @staticmethod + def CreateDelegate(type: Type, firstArgument: Any, method: MethodInfo) -> Delegate: + """Method docstring.""" + ... + + def DynamicInvoke(self, args: Array[Any]) -> Any: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetInvocationList(self) -> Array[Delegate]: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + @staticmethod + def Remove(source: Delegate, value: Delegate) -> Delegate: + """Method docstring.""" + ... + + @staticmethod + def RemoveAll(source: Delegate, value: Delegate) -> Delegate: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Enum(ValueType): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def CompareTo(self, target: Any) -> int: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + @staticmethod + def Format(enumType: Type, value: Any, format: str) -> str: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + @staticmethod + def GetName(enumType: Type, value: Any) -> str: + """Method docstring.""" + ... + + @staticmethod + def GetNames(enumType: Type) -> Array[str]: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetTypeCode(self) -> TypeCode: + """Method docstring.""" + ... + + @staticmethod + def GetUnderlyingType(enumType: Type) -> Type: + """Method docstring.""" + ... + + @staticmethod + def GetValues(enumType: Type) -> Array: + """Method docstring.""" + ... + + def HasFlag(self, flag: Enum) -> bool: + """Method docstring.""" + ... + + @staticmethod + def IsDefined(enumType: Type, value: Any) -> bool: + """Method docstring.""" + ... + + @staticmethod + def Parse(enumType: Type, value: str) -> Any: + """Method docstring.""" + ... + + @overload + @staticmethod + def Parse(enumType: Type, value: str, ignoreCase: bool) -> Any: + """Method docstring.""" + ... + + @staticmethod + def ToObject(enumType: Type, value: Any) -> Any: + """Method docstring.""" + ... + + @overload + @staticmethod + def ToObject(enumType: Type, value: int) -> Any: + """Method docstring.""" + ... + + @overload + @staticmethod + def ToObject(enumType: Type, value: int) -> Any: + """Method docstring.""" + ... + + @overload + @staticmethod + def ToObject(enumType: Type, value: int) -> Any: + """Method docstring.""" + ... + + @overload + @staticmethod + def ToObject(enumType: Type, value: int) -> Any: + """Method docstring.""" + ... + + @overload + @staticmethod + def ToObject(enumType: Type, value: int) -> Any: + """Method docstring.""" + ... + + @overload + @staticmethod + def ToObject(enumType: Type, value: int) -> Any: + """Method docstring.""" + ... + + @overload + @staticmethod + def ToObject(enumType: Type, value: int) -> Any: + """Method docstring.""" + ... + + @overload + @staticmethod + def ToObject(enumType: Type, value: int) -> Any: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + @overload + def ToString(self, format: str, provider: CultureInfo) -> str: + """Method docstring.""" + ... + + @overload + def ToString(self, provider: CultureInfo) -> str: + """Method docstring.""" + ... + + @overload + def ToString(self, format: str) -> str: + """Method docstring.""" + ... + + @staticmethod + def TryParse(value: str, result: TEnum) -> bool: + """Method docstring.""" + ... + + @overload + @staticmethod + def TryParse(value: str, ignoreCase: bool, result: TEnum) -> bool: + """Method docstring.""" + ... + + +class Exception: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, message: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, message: str, innerException: Exception) -> None: + """Initialize instance.""" + ... + + @property + def Data(self) -> DictionaryBase: + """DictionaryBase: Property docstring.""" + ... + + @property + def HResult(self) -> int: + """int: Property docstring.""" + ... + + @HResult.setter + def HResult(self, value: int) -> None: + """Set property value.""" + ... + + @property + def HelpLink(self) -> str: + """str: Property docstring.""" + ... + + @HelpLink.setter + def HelpLink(self, value: str) -> None: + """Set property value.""" + ... + + @property + def InnerException(self) -> Exception: + """Exception: Property docstring.""" + ... + + @property + def Message(self) -> str: + """str: Property docstring.""" + ... + + @property + def Source(self) -> str: + """str: Property docstring.""" + ... + + @Source.setter + def Source(self, value: str) -> None: + """Set property value.""" + ... + + @property + def StackTrace(self) -> str: + """str: Property docstring.""" + ... + + @property + def TargetSite(self) -> MethodBase: + """MethodBase: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetBaseException(self) -> Exception: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + @overload + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class IComparable: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def CompareTo(self, obj: Any) -> int: + """Method docstring.""" + ... + + +class IntPtr(ValueType): + """Class docstring.""" + + def __init__(self, value: int) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, value: int) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, value: Any) -> None: + """Initialize instance.""" + ... + + @classmethod + @property + def Size(cls) -> int: + """int: Property docstring.""" + ... + + @staticmethod + def Add(pointer: IntPtr, offset: int) -> IntPtr: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + @staticmethod + def Subtract(pointer: IntPtr, offset: int) -> IntPtr: + """Method docstring.""" + ... + + def ToInt32(self) -> int: + """Method docstring.""" + ... + + def ToInt64(self) -> int: + """Method docstring.""" + ... + + def ToPointer(self) -> Any: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + @overload + def ToString(self, format: str) -> str: + """Method docstring.""" + ... + + Zero: IntPtr + +class MulticastDelegate(Delegate): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Method(self) -> MethodInfo: + """MethodInfo: Property docstring.""" + ... + + @property + def Target(self) -> Any: + """Any: Property docstring.""" + ... + + def Clone(self) -> Any: + """Method docstring.""" + ... + + def DynamicInvoke(self, args: Array[Any]) -> Any: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetInvocationList(self) -> Array[Delegate]: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Type(MemberInfo): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Assembly(self) -> Assembly: + """Assembly: Property docstring.""" + ... + + @property + def AssemblyQualifiedName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Attributes(self) -> TypeAttributes: + """TypeAttributes: Property docstring.""" + ... + + @property + def BaseType(self) -> Type: + """Type: Property docstring.""" + ... + + @property + def ContainsGenericParameters(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def CustomAttributes(self) -> List[CustomAttributeData]: + """List[CustomAttributeData]: Property docstring.""" + ... + + @property + def DeclaringMethod(self) -> MethodBase: + """MethodBase: Property docstring.""" + ... + + @property + def DeclaringType(self) -> Type: + """Type: Property docstring.""" + ... + + @classmethod + @property + def DefaultBinder(cls) -> Binder: + """Binder: Property docstring.""" + ... + + @property + def FullName(self) -> str: + """str: Property docstring.""" + ... + + @property + def GUID(self) -> str: + """str: Property docstring.""" + ... + + @property + def GenericParameterAttributes(self) -> GenericParameterAttributes: + """GenericParameterAttributes: Property docstring.""" + ... + + @property + def GenericParameterPosition(self) -> int: + """int: Property docstring.""" + ... + + @property + def GenericTypeArguments(self) -> Array[Type]: + """Array[Type]: Property docstring.""" + ... + + @property + def HasElementType(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsAbstract(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsAnsiClass(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsArray(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsAutoClass(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsAutoLayout(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsByRef(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsCOMObject(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsClass(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsConstructedGenericType(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsContextful(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsEnum(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsExplicitLayout(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsGenericParameter(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsGenericType(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsGenericTypeDefinition(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsImport(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsInterface(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsLayoutSequential(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsMarshalByRef(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsNested(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsNestedAssembly(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsNestedFamANDAssem(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsNestedFamORAssem(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsNestedFamily(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsNestedPrivate(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsNestedPublic(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsNotPublic(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsPointer(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsPrimitive(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsPublic(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSealed(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSecurityCritical(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSecuritySafeCritical(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSecurityTransparent(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSerializable(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSpecialName(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsUnicodeClass(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsValueType(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsVisible(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def MemberType(self) -> MemberTypes: + """MemberTypes: Property docstring.""" + ... + + @property + def MetadataToken(self) -> int: + """int: Property docstring.""" + ... + + @property + def Module(self) -> Module: + """Module: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Namespace(self) -> str: + """str: Property docstring.""" + ... + + @property + def ReflectedType(self) -> Type: + """Type: Property docstring.""" + ... + + @property + def StructLayoutAttribute(self) -> StructLayoutAttribute: + """StructLayoutAttribute: Property docstring.""" + ... + + @property + def TypeHandle(self) -> RuntimeTypeHandle: + """RuntimeTypeHandle: Property docstring.""" + ... + + @property + def TypeInitializer(self) -> ConstructorInfo: + """ConstructorInfo: Property docstring.""" + ... + + @property + def UnderlyingSystemType(self) -> Type: + """Type: Property docstring.""" + ... + + def Equals(self, o: Any) -> bool: + """Method docstring.""" + ... + + @overload + def Equals(self, o: Type) -> bool: + """Method docstring.""" + ... + + def FindInterfaces(self, filter: TypeFilter, filterCriteria: Any) -> Array[Type]: + """Method docstring.""" + ... + + def FindMembers(self, memberType: MemberTypes, bindingAttr: BindingFlags, filter: MemberFilter, filterCriteria: Any) -> Array[MemberInfo]: + """Method docstring.""" + ... + + def GetArrayRank(self) -> int: + """Method docstring.""" + ... + + def GetConstructor(self, bindingAttr: BindingFlags, binder: Binder, callConvention: CallingConventions, types: Array[Type], modifiers: Array[ParameterModifier]) -> ConstructorInfo: + """Method docstring.""" + ... + + @overload + def GetConstructor(self, bindingAttr: BindingFlags, binder: Binder, types: Array[Type], modifiers: Array[ParameterModifier]) -> ConstructorInfo: + """Method docstring.""" + ... + + @overload + def GetConstructor(self, types: Array[Type]) -> ConstructorInfo: + """Method docstring.""" + ... + + def GetConstructors(self) -> Array[ConstructorInfo]: + """Method docstring.""" + ... + + @overload + def GetConstructors(self, bindingAttr: BindingFlags) -> Array[ConstructorInfo]: + """Method docstring.""" + ... + + def GetCustomAttributes(self, inherit: bool) -> Array[Any]: + """Method docstring.""" + ... + + @overload + def GetCustomAttributes(self, attributeType: Type, inherit: bool) -> Array[Any]: + """Method docstring.""" + ... + + def GetCustomAttributesData(self) -> List[CustomAttributeData]: + """Method docstring.""" + ... + + def GetDefaultMembers(self) -> Array[MemberInfo]: + """Method docstring.""" + ... + + def GetElementType(self) -> Type: + """Method docstring.""" + ... + + def GetEnumName(self, value: Any) -> str: + """Method docstring.""" + ... + + def GetEnumNames(self) -> Array[str]: + """Method docstring.""" + ... + + def GetEnumUnderlyingType(self) -> Type: + """Method docstring.""" + ... + + def GetEnumValues(self) -> Array: + """Method docstring.""" + ... + + def GetEvent(self, name: str) -> EventInfo: + """Method docstring.""" + ... + + @overload + def GetEvent(self, name: str, bindingAttr: BindingFlags) -> EventInfo: + """Method docstring.""" + ... + + def GetEvents(self) -> Array[EventInfo]: + """Method docstring.""" + ... + + @overload + def GetEvents(self, bindingAttr: BindingFlags) -> Array[EventInfo]: + """Method docstring.""" + ... + + def GetField(self, name: str) -> FieldInfo: + """Method docstring.""" + ... + + @overload + def GetField(self, name: str, bindingAttr: BindingFlags) -> FieldInfo: + """Method docstring.""" + ... + + def GetFields(self) -> Array[FieldInfo]: + """Method docstring.""" + ... + + @overload + def GetFields(self, bindingAttr: BindingFlags) -> Array[FieldInfo]: + """Method docstring.""" + ... + + def GetGenericArguments(self) -> Array[Type]: + """Method docstring.""" + ... + + def GetGenericParameterConstraints(self) -> Array[Type]: + """Method docstring.""" + ... + + def GetGenericTypeDefinition(self) -> Type: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetInterface(self, name: str) -> Type: + """Method docstring.""" + ... + + @overload + def GetInterface(self, name: str, ignoreCase: bool) -> Type: + """Method docstring.""" + ... + + def GetInterfaceMap(self, interfaceType: Type) -> InterfaceMapping: + """Method docstring.""" + ... + + def GetInterfaces(self) -> Array[Type]: + """Method docstring.""" + ... + + def GetMember(self, name: str) -> Array[MemberInfo]: + """Method docstring.""" + ... + + @overload + def GetMember(self, name: str, bindingAttr: BindingFlags) -> Array[MemberInfo]: + """Method docstring.""" + ... + + @overload + def GetMember(self, name: str, type: MemberTypes, bindingAttr: BindingFlags) -> Array[MemberInfo]: + """Method docstring.""" + ... + + def GetMembers(self) -> Array[MemberInfo]: + """Method docstring.""" + ... + + @overload + def GetMembers(self, bindingAttr: BindingFlags) -> Array[MemberInfo]: + """Method docstring.""" + ... + + def GetMethod(self, name: str, bindingAttr: BindingFlags, binder: Binder, callConvention: CallingConventions, types: Array[Type], modifiers: Array[ParameterModifier]) -> MethodInfo: + """Method docstring.""" + ... + + @overload + def GetMethod(self, name: str, bindingAttr: BindingFlags, binder: Binder, types: Array[Type], modifiers: Array[ParameterModifier]) -> MethodInfo: + """Method docstring.""" + ... + + @overload + def GetMethod(self, name: str, types: Array[Type], modifiers: Array[ParameterModifier]) -> MethodInfo: + """Method docstring.""" + ... + + @overload + def GetMethod(self, name: str, types: Array[Type]) -> MethodInfo: + """Method docstring.""" + ... + + @overload + def GetMethod(self, name: str, bindingAttr: BindingFlags) -> MethodInfo: + """Method docstring.""" + ... + + @overload + def GetMethod(self, name: str) -> MethodInfo: + """Method docstring.""" + ... + + def GetMethods(self) -> Array[MethodInfo]: + """Method docstring.""" + ... + + @overload + def GetMethods(self, bindingAttr: BindingFlags) -> Array[MethodInfo]: + """Method docstring.""" + ... + + def GetNestedType(self, name: str) -> Type: + """Method docstring.""" + ... + + @overload + def GetNestedType(self, name: str, bindingAttr: BindingFlags) -> Type: + """Method docstring.""" + ... + + def GetNestedTypes(self) -> Array[Type]: + """Method docstring.""" + ... + + @overload + def GetNestedTypes(self, bindingAttr: BindingFlags) -> Array[Type]: + """Method docstring.""" + ... + + def GetProperties(self) -> Array[PropertyInfo]: + """Method docstring.""" + ... + + @overload + def GetProperties(self, bindingAttr: BindingFlags) -> Array[PropertyInfo]: + """Method docstring.""" + ... + + def GetProperty(self, name: str, bindingAttr: BindingFlags, binder: Binder, returnType: Type, types: Array[Type], modifiers: Array[ParameterModifier]) -> PropertyInfo: + """Method docstring.""" + ... + + @overload + def GetProperty(self, name: str, returnType: Type, types: Array[Type], modifiers: Array[ParameterModifier]) -> PropertyInfo: + """Method docstring.""" + ... + + @overload + def GetProperty(self, name: str, bindingAttr: BindingFlags) -> PropertyInfo: + """Method docstring.""" + ... + + @overload + def GetProperty(self, name: str, returnType: Type, types: Array[Type]) -> PropertyInfo: + """Method docstring.""" + ... + + @overload + def GetProperty(self, name: str, types: Array[Type]) -> PropertyInfo: + """Method docstring.""" + ... + + @overload + def GetProperty(self, name: str, returnType: Type) -> PropertyInfo: + """Method docstring.""" + ... + + @overload + def GetProperty(self, name: str) -> PropertyInfo: + """Method docstring.""" + ... + + @staticmethod + def GetType(typeName: str, throwOnError: bool, ignoreCase: bool) -> Type: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetType(typeName: str, throwOnError: bool) -> Type: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetType(typeName: str) -> Type: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetType(typeName: str, assemblyResolver: Func[AssemblyName, Assembly], typeResolver: Func[Assembly, str, bool, Type]) -> Type: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetType(typeName: str, assemblyResolver: Func[AssemblyName, Assembly], typeResolver: Func[Assembly, str, bool, Type], throwOnError: bool) -> Type: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetType(typeName: str, assemblyResolver: Func[AssemblyName, Assembly], typeResolver: Func[Assembly, str, bool, Type], throwOnError: bool, ignoreCase: bool) -> Type: + """Method docstring.""" + ... + + @overload + def GetType(self) -> Type: + """Method docstring.""" + ... + + @overload + def GetType(self) -> Type: + """Method docstring.""" + ... + + @staticmethod + def GetTypeArray(args: Array[Any]) -> Array[Type]: + """Method docstring.""" + ... + + @staticmethod + def GetTypeCode(type: Type) -> TypeCode: + """Method docstring.""" + ... + + @staticmethod + def GetTypeFromCLSID(clsid: str) -> Type: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetTypeFromCLSID(clsid: str, throwOnError: bool) -> Type: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetTypeFromCLSID(clsid: str, server: str) -> Type: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetTypeFromCLSID(clsid: str, server: str, throwOnError: bool) -> Type: + """Method docstring.""" + ... + + @staticmethod + def GetTypeFromHandle(handle: RuntimeTypeHandle) -> Type: + """Method docstring.""" + ... + + @staticmethod + def GetTypeFromProgID(progID: str) -> Type: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetTypeFromProgID(progID: str, throwOnError: bool) -> Type: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetTypeFromProgID(progID: str, server: str) -> Type: + """Method docstring.""" + ... + + @overload + @staticmethod + def GetTypeFromProgID(progID: str, server: str, throwOnError: bool) -> Type: + """Method docstring.""" + ... + + @staticmethod + def GetTypeHandle(o: Any) -> RuntimeTypeHandle: + """Method docstring.""" + ... + + def InvokeMember(self, name: str, invokeAttr: BindingFlags, binder: Binder, target: Any, args: Array[Any], culture: CultureInfo) -> Any: + """Method docstring.""" + ... + + @overload + def InvokeMember(self, name: str, invokeAttr: BindingFlags, binder: Binder, target: Any, args: Array[Any]) -> Any: + """Method docstring.""" + ... + + @overload + def InvokeMember(self, name: str, invokeAttr: BindingFlags, binder: Binder, target: Any, args: Array[Any], modifiers: Array[ParameterModifier], culture: CultureInfo, namedParameters: Array[str]) -> Any: + """Method docstring.""" + ... + + def IsAssignableFrom(self, c: Type) -> bool: + """Method docstring.""" + ... + + def IsDefined(self, attributeType: Type, inherit: bool) -> bool: + """Method docstring.""" + ... + + def IsEnumDefined(self, value: Any) -> bool: + """Method docstring.""" + ... + + def IsEquivalentTo(self, other: Type) -> bool: + """Method docstring.""" + ... + + def IsInstanceOfType(self, o: Any) -> bool: + """Method docstring.""" + ... + + def IsSubclassOf(self, c: Type) -> bool: + """Method docstring.""" + ... + + def MakeArrayType(self) -> Type: + """Method docstring.""" + ... + + @overload + def MakeArrayType(self, rank: int) -> Type: + """Method docstring.""" + ... + + def MakeByRefType(self) -> Type: + """Method docstring.""" + ... + + def MakeGenericType(self, typeArguments: Array[Type]) -> Type: + """Method docstring.""" + ... + + def MakePointerType(self) -> Type: + """Method docstring.""" + ... + + @staticmethod + def ReflectionOnlyGetType(typeName: str, throwIfNotFound: bool, ignoreCase: bool) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + Delimiter: Char + EmptyTypes: Array[Type] + FilterAttribute: MemberFilter + FilterName: MemberFilter + FilterNameIgnoreCase: MemberFilter + Missing: Any + +class TypeCode: + """Class docstring.""" + + Boolean: TypeCode + Byte: TypeCode + Char: TypeCode + DBNull: TypeCode + DateTime: TypeCode + Decimal: TypeCode + Double: TypeCode + Empty: TypeCode + Int16: TypeCode + Int32: TypeCode + Int64: TypeCode + Object: TypeCode + SByte: TypeCode + Single: TypeCode + String: TypeCode + UInt16: TypeCode + UInt32: TypeCode + UInt64: TypeCode + +class ValueType: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/Model/__init__.pyi b/pyesapi/stubs/VMS/TPS/Common/Model/API/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/Model/__init__.pyi rename to pyesapi/stubs/VMS/TPS/Common/Model/API/__init__.py diff --git a/pyesapi/stubs/VMS/TPS/Common/Model/API/__init__.pyi b/pyesapi/stubs/VMS/TPS/Common/Model/API/__init__.pyi new file mode 100644 index 0000000..0f54c8e --- /dev/null +++ b/pyesapi/stubs/VMS/TPS/Common/Model/API/__init__.pyi @@ -0,0 +1,15547 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Array, Enum, MulticastDelegate, Type, ValueType +from System.Collections import BitArray, IEnumerator +from System.Xml import XmlReader, XmlWriter +from System.Xml.Schema import XmlSchema +from Windows.Media import Color +from Microsoft.Win32 import RegistryHive, RegistryKey +from System import Action, AggregateException, AsyncCallback, Attribute, Delegate, IntPtr, TypeCode +from System.Collections import ReadOnlyList +from System.Globalization import CultureInfo +from System.IO import FileStreamAsyncResult +from System.Reflection import Assembly, AssemblyName, MethodInfo +from System.Runtime.InteropServices import _Attribute +from System.Runtime.InteropServices.WindowsRuntime import Point +from System.Runtime.Serialization import SerializationInfo, StreamingContext +from System.Text import StringBuilder +from System.Threading import SendOrPostCallback, SynchronizationContext +from VMS.TPS.Common.Model.Types import ApplicationScriptApprovalStatus, ApplicationScriptType, ApprovalHistoryEntry, AxisAlignedMargins, BeamNumber, BeamTechnique, BlockType, BrachyTreatmentTechniqueType, CalculationType, ChangeBrachyTreatmentUnitResult, ClinicalGoal, ClosedLeavesMeetingPoint, CourseClinicalStatus, DRRCalculationParameters, DVHEstimateType, DVHEstimationStructureType, DVHPoint, DoseProfile, DoseValue, DoseValuePresentation, ExternalBeamMachineParameters, FitToStructureMargins, Fluence, GantryDirection, ImageApprovalHistoryEntry, ImageProfile, ImagingBeamSetupParameters, IonBeamScanMode, IonPlanNormalizationParameters, IonPlanOptimizationMode, JawFitting, LMCMSSOptions, LMCVOptions, LateralSpreadingDeviceType, LogSeverity, MLCPlanType, MeasureModifier, MeasureType, MetersetValue, OpenLeavesMeetingPoint, OptimizationAvoidanceSector, OptimizationIntermediateDoseOption, OptimizationObjectiveOperator, OptimizationOption, OptimizationOptionsIMPT, OptimizationOptionsIMRT, OptimizationOptionsVMAT, ParticleType, PatientOrientation, PatientSupportType, PlanSetupApprovalStatus, PlanSumOperation, PlanType, PlanUncertaintyType, PrescriptionModifier, PrescriptionType, ProtonBeamLineStatus, ProtonBeamMachineParameters, ProtonDeliveryTimeStatus, RTPrescriptionConstraintType, RTPrescriptionTargetType, RailPosition, RangeModulatorType, RangeShifterType, RegistrationApprovalStatus, SegmentProfile, SeriesModality, SetSourcePositionsResult, SetupTechnique, SmartLMCOptions, StructureApprovalHistoryEntry, StructureCodeInfo, TreatmentSessionStatus, UserIdentity, VRect, VVector, VolumePresentation + +class ActiveStructureCodeDictionaries: + """Provides access to the structure code dictionaries with the active structure codes.""" + + def __init__(self, providerFunc: Func[str, Dict[str, StructureCode]]) -> None: + """Initialize instance.""" + ... + + @property + def Fma(self) -> StructureCodeDictionary: + """StructureCodeDictionary: The Foundational Model of Anatomy Ontology structure scheme.""" + ... + + @property + def RadLex(self) -> StructureCodeDictionary: + """StructureCodeDictionary: The RSNA RadLex radiology lexicon structure scheme.""" + ... + + @property + def Srt(self) -> StructureCodeDictionary: + """StructureCodeDictionary: The SNOMED RT structure scheme.""" + ... + + @property + def VmsStructCode(self) -> StructureCodeDictionary: + """StructureCodeDictionary: The Varian 99VMS_STRUCTCODE structure scheme.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class AddOn(ApiDataObject): + """Represents an add-on, which is a beam modifying device that is inserted into a beam in an accessory slot of the external beam machine. An add-on is used to shape the beam or modulate its intensity or both. Add-ons are blocks, MLCs, wedges, compensators, applicators, a tray, and other devices or materials that can be fixed to a tray to be mounted into an accessory slot.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The date when this object was created.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class AddOnMaterial(ApiDataObject): + """Add-on material describes the dosimetric and physical properties of the metal alloy or other substance used to create the add-on.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Algorithm(ValueType): + """Algorithm""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + Name: str + Version: str + +class Algorithm(ValueType): + """Algorithm""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + Name: str + Version: str + +class ApiDataObject(SerializableObject): + """The base class of objects in the Eclipse Scripting API.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: A comment about the object.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: The date when this object was last modified.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: The name of the last user who modified this object.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: The identifier of the last user who modified this object.""" + ... + + @property + def Id(self) -> str: + """str: The identifier of the object.""" + ... + + @property + def Name(self) -> str: + """str: The name of the object.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Serves as a hash function for this type. + + Returns: + int: A hash code for the current Object.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Returns a string that represents the current object. + + Returns: + str: A string that represents the current object.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ApiObjectFactory: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Application(SerializableObject): + """The main application interface.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Calculation(self) -> Calculation: + """Calculation: Calculation related functions""" + ... + + @property + def CurrentUser(self) -> User: + """User: The user who is currently logged on.""" + ... + + @property + def Equipment(self) -> Equipment: + """Equipment: Provides access to clinical devices and accessories.""" + ... + + @property + def PatientSummaries(self) -> List[PatientSummary]: + """List[PatientSummary]: Fetches patient summaries from the database.""" + ... + + @property + def ScriptEnvironment(self) -> ScriptEnvironment: + """ScriptEnvironment: Gets the script environment.""" + ... + + @property + def StructureCodes(self) -> ActiveStructureCodeDictionaries: + """ActiveStructureCodeDictionaries: Provides access to the structure code dictionaries with the active structure codes.""" + ... + + def ClosePatient(self) -> None: + """Closes the current patient. If the script tries to access the data of a closed patient, an access violation exception occurs.""" + ... + + @staticmethod + def CreateApplication(username: str, password: str) -> Application: + """Creates an application instance for a standalone script and logs into the system. + + Code that uses ESAPI must run on a single-threaded apartment (STAThread). The Dispose method must be called before the program exits. Only one application instance may be created during the entire run of the program. + + Returns: + Application: Application object that is the root of the data model.""" + ... + + @overload + @staticmethod + def CreateApplication() -> Application: + """Creates an application instance for a standalone script and logs into the system. + + Code that uses ESAPI must run on a single-threaded apartment (STAThread). The Dispose method must be called before the program exits. Only one application instance may be created during the entire run of the program. + + Returns: + Application: Application object that is the root of the data model.""" + ... + + def Dispose(self) -> None: + """Releases all unmanaged resources of this object.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def OpenPatient(self, patientSummary: PatientSummary) -> Patient: + """Method docstring.""" + ... + + def OpenPatientById(self, id: str) -> Patient: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def SaveModifications(self) -> None: + """[Availability of this method depends on your Eclipse Scripting API license] Saves data modifications to the database if saving is allowed. Note: Calling this method can cause a multi-user warning dialog box to appear if the same patient is modified by other parties.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ApplicationPackage(ApiDataObject): + """Presents the application package information in the system. Note: not all methods are necessarily Published at the moment.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApprovalStatus(self) -> ApplicationScriptApprovalStatus: + """ApplicationScriptApprovalStatus: The status of the application package. Possible values are defined by a lookup RT_APP_EXTENSION_STATUS.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def Description(self) -> str: + """str: Description of functionality provided by the package.""" + ... + + @property + def ExpirationDate(self) -> Optional[datetime]: + """Optional[datetime]: An optional expiration date of the package. The package cannot be executed after expiration date. The date is presented in UTC.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def PackageId(self) -> str: + """str: Unique Package ID.""" + ... + + @property + def PackageName(self) -> str: + """str: The full name of the package.""" + ... + + @property + def PackageVersion(self) -> str: + """str: The version number of the package.""" + ... + + @property + def PublisherData(self) -> str: + """str: Optional JSON data that can be used by package internally, e.g. customer key.""" + ... + + @property + def PublisherName(self) -> str: + """str: The name of the organization or author that created the package. This is a free text that can be set by the approver.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ApplicationScript(ApiDataObject): + """Presents the application script information in the system. The location of the script file is not stored in the system.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApprovalStatus(self) -> ApplicationScriptApprovalStatus: + """ApplicationScriptApprovalStatus: The status of the script.""" + ... + + @property + def ApprovalStatusDisplayText(self) -> str: + """str: The display text of the approval status.""" + ... + + @property + def AssemblyName(self) -> AssemblyName: + """AssemblyName: The full name of the script assembly.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def ExpirationDate(self) -> Optional[datetime]: + """Optional[datetime]: An optional expiration date of the script. The script cannot be executed after expiration date. The date is presented in UTC.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def IsReadOnlyScript(self) -> bool: + """bool: Returns true if the script is intended only to read patient data.""" + ... + + @property + def IsWriteableScript(self) -> bool: + """bool: Returns true if the script is intended to modify persistent data.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def PublisherName(self) -> str: + """str: The name of the organization or author that created the script. This is a free text that can be set by the approver.""" + ... + + @property + def ScriptType(self) -> ApplicationScriptType: + """ApplicationScriptType: The type of the application script.""" + ... + + @property + def StatusDate(self) -> Optional[datetime]: + """Optional[datetime]: A timestamp of the last approval status modification.""" + ... + + @property + def StatusUserIdentity(self) -> UserIdentity: + """UserIdentity: The identity of the user who last modified the approval status.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ApplicationScriptLog(ApiDataObject): + """The log entry of the application script execution.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CourseId(self) -> str: + """str: The identifier of the course that was modified by the script.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def PatientId(self) -> str: + """str: The identifier of the patient that was modified by the script.""" + ... + + @property + def PlanSetupId(self) -> str: + """str: The identifier of the plan that was modified by the script, or an empty string if the script did not modify the plan.""" + ... + + @property + def PlanUID(self) -> str: + """str: The DICOM UID of the plan that was modified by the script, or an empty string if the script did not modify the plan.""" + ... + + @property + def Script(self) -> ApplicationScript: + """ApplicationScript: The script that modified the plan or structure set.""" + ... + + @property + def ScriptFullName(self) -> str: + """str: The full name of the script assembly that modified the plan or structure set. A System.Reflection.AssemblyName object can be created from the string.""" + ... + + @property + def StructureSetId(self) -> str: + """str: The identifier of the structure set that was modified by the script, or an empty string if the script did not modify the structure set.""" + ... + + @property + def StructureSetUID(self) -> str: + """str: The DICOM UID of the structure set that was modified by the script, or an empty string if the script did not modify the structure set.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Applicator(AddOn): + """An applicator add-on, either an electron applicator or cone applicator.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApplicatorLengthInMM(self) -> float: + """float: Applicator length in mm.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def DiameterInMM(self) -> float: + """float: Applicator Diameter in mm.""" + ... + + @property + def FieldSizeX(self) -> float: + """float: The field width in direction X (cm).""" + ... + + @property + def FieldSizeY(self) -> float: + """float: The field width in direction Y (cm).""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def IsStereotactic(self) -> bool: + """bool: Is stereotactic.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class AsyncPump: + """Provides a pump that supports running asynchronous methods on the current thread.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Beam(ApiDataObject): + """Represents one beam (also referred to as "field") of an external beam treatment plan. See the definition of DICOM RT Beam for more details.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Applicator(self) -> Applicator: + """Applicator: An applicator is a specific add-on used in the beam.""" + ... + + @property + def ArcLength(self) -> float: + """float: The arc length.""" + ... + + @property + def AreControlPointJawsMoving(self) -> bool: + """bool: Checks if jaws are moving.""" + ... + + @property + def AverageSSD(self) -> float: + """float: The average Source-to-Skin Distance (SSD) of an arc beam.""" + ... + + @property + def BeamNumber(self) -> int: + """int: DICOM RT Beam Number. The value is unique within the plan in which it is created.""" + ... + + @property + def BeamTechnique(self) -> BeamTechnique: + """BeamTechnique: Returns an enumeration that describes the type of the treatment field.""" + ... + + @property + def Blocks(self) -> List[Block]: + """List[Block]: A collection of installed blocks.""" + ... + + @property + def Boluses(self) -> List[Bolus]: + """List[Bolus]: A collection of beam boluses.""" + ... + + @property + def CalculationLogs(self) -> List[BeamCalculationLog]: + """List[BeamCalculationLog]: A collection of beam calculation logs.""" + ... + + @property + def CollimatorRotation(self) -> float: + """float: Collimator rotation""" + ... + + @property + def Comment(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The Beam comment.""" + ... + + @Comment.setter + def Comment(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Compensator(self) -> Compensator: + """Compensator: The compensator.""" + ... + + @property + def ControlPoints(self) -> ControlPointCollection: + """ControlPointCollection: An enumerable sequence of machine parameters that describe the planned treatment beam.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The date when this object was created.""" + ... + + @property + def Dose(self) -> BeamDose: + """BeamDose: The dose for the beam. Returns null if the dose is not calculated.""" + ... + + @property + def DoseRate(self) -> int: + """int: The dose rate of the treatment machine in MU/min.""" + ... + + @property + def DosimetricLeafGap(self) -> float: + """float: The dosimetric leaf gap that has been configured for the Dynamic Multileaf Collimator (DMLC) beams in the system. The dosimetric leaf gap is used for accounting for dose transmission through rounded MLC leaves.""" + ... + + @property + def EnergyMode(self) -> EnergyMode: + """EnergyMode: Energy mode of the treatment machine.""" + ... + + @property + def EnergyModeDisplayName(self) -> str: + """str: The display name of the energy mode. For example '18E' or '6X-SRS'.""" + ... + + @property + def FieldReferencePoints(self) -> List[FieldReferencePoint]: + """List[FieldReferencePoint]: A collection of field reference points.""" + ... + + @property + def GantryDirection(self) -> GantryDirection: + """GantryDirection: The gantry rotation direction: clockwise (CW), counterclockwise (CCW), or none.""" + ... + + @property + def HasAllMLCLeavesClosed(self) -> bool: + """bool: Returns true if all MLC leaves are closed.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Beam.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def IsGantryExtended(self) -> bool: + """bool: Checks if the gantry rotation is extended. For arc beams, checks if the gantry rotation is extended at the start angle.""" + ... + + @property + def IsGantryExtendedAtStopAngle(self) -> bool: + """bool: Checks if the gantry rotation is extended at the stop angle of an arc beam.""" + ... + + @property + def IsIMRT(self) -> bool: + """bool: Checks if a beam is IMRT.""" + ... + + @property + def IsImagingTreatmentField(self) -> bool: + """bool: Checks if a beam is an Imaging Treatment Beam, i.e., a beam that is used to take an MV image and whose dose is calculated and taken into account in treatment planning.""" + ... + + @property + def IsSetupField(self) -> bool: + """bool: Checks if a beam is a setup field.""" + ... + + @property + def IsocenterPosition(self) -> VVector: + """VVector: The position of the isocenter.""" + ... + + @property + def MLC(self) -> MLC: + """MLC: Returns a hardware description of the Multileaf Collimator (MLC) used in an MLC plan, or null if no MLC exists.""" + ... + + @property + def MLCPlanType(self) -> MLCPlanType: + """MLCPlanType: The type of the Multileaf Collimator (MLC) plan.""" + ... + + @property + def MLCTransmissionFactor(self) -> float: + """float: The transmission factor of the Multileaf Collimator (MLC) material.""" + ... + + @property + def Meterset(self) -> MetersetValue: + """MetersetValue: The meterset value of the beam.""" + ... + + @property + def MetersetPerGy(self) -> float: + """float: The calculated meterset/Gy value for the beam.""" + ... + + @property + def MotionCompensationTechnique(self) -> str: + """str: DICOM (respiratory) motion compensation technique. Returns an empty string if motion compensation technique is not used.""" + ... + + @property + def MotionSignalSource(self) -> str: + """str: DICOM (respiratory) signal source. Returns an empty string if motion compensation technique is not used.""" + ... + + @property + def Name(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The name of the Beam.""" + ... + + @Name.setter + def Name(self, value: str) -> None: + """Set property value.""" + ... + + @property + def NormalizationFactor(self) -> float: + """float: The beam normalization factor.""" + ... + + @property + def NormalizationMethod(self) -> str: + """str: The beam normalization method.""" + ... + + @property + def Plan(self) -> PlanSetup: + """PlanSetup: Used for navigating to parent Plan""" + ... + + @property + def PlannedSSD(self) -> float: + """float: The Source-to-Skin Distance (SSD) value defined by the user.""" + ... + + @property + def ReferenceImage(self) -> Image: + """Image: The reference image of the beam.""" + ... + + @property + def SSD(self) -> float: + """float: The Source-to-Skin Distance (SSD). For arc beams, the SSD at the start angle. This value is calculated from the geometrical setup of the beam.""" + ... + + @property + def SSDAtStopAngle(self) -> float: + """float: The Source-to-Skin Distance (SSD) at the stop angle of an arc beam. This value is calculated from the geometrical setup of the beam.""" + ... + + @property + def SetupNote(self) -> str: + """str: The setup note of the field.""" + ... + + @SetupNote.setter + def SetupNote(self, value: str) -> None: + """Set property value.""" + ... + + @property + def SetupTechnique(self) -> SetupTechnique: + """SetupTechnique: The setup technique.""" + ... + + @property + def Technique(self) -> Technique: + """Technique: The technique used in the planning beam.""" + ... + + @property + def ToleranceTableLabel(self) -> str: + """str: User-defined label for the referenced tolerance table, or an empty string if there is no reference to a tolerance table.""" + ... + + @property + def Trays(self) -> List[Tray]: + """List[Tray]: A collection of installed trays.""" + ... + + @property + def TreatmentTime(self) -> float: + """float: The treatment time set for the beam in seconds. Plan Approval wizard sets this value by default.""" + ... + + @property + def TreatmentUnit(self) -> ExternalBeamTreatmentUnit: + """ExternalBeamTreatmentUnit: The external beam treatment unit associated with this beam.""" + ... + + @property + def Wedges(self) -> List[Wedge]: + """List[Wedge]: A collection of installed wedges.""" + ... + + @property + def WeightFactor(self) -> float: + """float: The weight factor of the beam.""" + ... + + def AddBolus(self, bolus: Bolus) -> None: + """Method docstring.""" + ... + + @overload + def AddBolus(self, bolusId: str) -> None: + """Method docstring.""" + ... + + def AddFlatteningSequence(self) -> bool: + """[Availability of this method depends on your Eclipse Scripting API license] Adds a flattening sequence to a static Halcyon field. Throws an exception if the field is not a Halcyon field. + + Returns: + bool: True if flattening sequence was added.""" + ... + + def ApplyParameters(self, beamParams: BeamParameters) -> None: + """Method docstring.""" + ... + + def CalculateAverageLeafPairOpenings(self) -> Dict[int, float]: + """Calculate and get Average Leaf Pair Opening values. ALPO values are calculated on the fly (not serialized). Returns a Dictionary. Key element is the index of carriage group in the field and value element is the ALPO value for that carriage group.""" + ... + + def CanSetOptimalFluence(self, fluence: Fluence, message: str) -> bool: + """Method docstring.""" + ... + + def CollimatorAngleToUser(self, val: float) -> float: + """Method docstring.""" + ... + + def CountSubfields(self) -> int: + """Counts and returns Subfield count.""" + ... + + def CreateOrReplaceDRR(self, parameters: DRRCalculationParameters) -> Image: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def FitCollimatorToStructure(self, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) -> None: + """Method docstring.""" + ... + + def FitMLCToOutline(self, outline: Array[Array[Point]]) -> None: + """Method docstring.""" + ... + + @overload + def FitMLCToOutline(self, outline: Array[Array[Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """Method docstring.""" + ... + + def FitMLCToStructure(self, structure: Structure) -> None: + """Method docstring.""" + ... + + @overload + def FitMLCToStructure(self, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """Method docstring.""" + ... + + def GantryAngleToUser(self, val: float) -> float: + """Method docstring.""" + ... + + def GetCAXPathLengthInBolus(self, bolus: Bolus) -> float: + """Method docstring.""" + ... + + def GetEditableParameters(self) -> BeamParameters: + """Returns an editable copy of the beam parameters. The returned BeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another BeamParameters object. + + Returns: + BeamParameters: Returns a new parameters object. Its values are copied from the corresponding properties of this object.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetOptimalFluence(self) -> Fluence: + """Gets the optimal fluence for this beam. Returns null if optimal fluence does not exist. + + Returns: + Fluence: Returns the optimized fluence, if it exists. Otherwise null.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetSourceLocation(self, gantryAngle: float) -> VVector: + """Method docstring.""" + ... + + def GetSourceToBolusDistance(self, bolus: Bolus) -> float: + """Method docstring.""" + ... + + def GetStructureOutlines(self, structure: Structure, inBEV: bool) -> Array[Array[Point]]: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def JawPositionsToUserString(self, val: VRect[float]) -> str: + """Method docstring.""" + ... + + def PatientSupportAngleToUser(self, val: float) -> float: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemoveBolus(self, bolus: Bolus) -> bool: + """Method docstring.""" + ... + + @overload + def RemoveBolus(self, bolusId: str) -> bool: + """Method docstring.""" + ... + + def RemoveFlatteningSequence(self) -> bool: + """[Availability of this method depends on your Eclipse Scripting API license] Removes the flattening sequence from a Halcyon field. Throws an exception if the field is not a Halcyon field. + + Returns: + bool: True if flattening sequence was removed.""" + ... + + def SetOptimalFluence(self, fluence: Fluence) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class BeamCalculationLog(SerializableObject): + """Represents a beam calculation log.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Beam(self) -> Beam: + """Beam: Used for navigating to parent Beam""" + ... + + @property + def Category(self) -> str: + """str: The log category, for example, "Dose", or "Optimization".""" + ... + + @property + def MessageLines(self) -> List[str]: + """List[str]: The log as an array of lines.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class BeamDose(Dose): + """Represents a dose that is connected to a Beam.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def DoseMax3D(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def DoseMax3DLocation(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Isodoses(self) -> List[Isodose]: + """List[Isodose]: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Origin(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def Series(self) -> Series: + """Series: Property docstring.""" + ... + + @property + def SeriesUID(self) -> str: + """str: Property docstring.""" + ... + + @property + def UID(self) -> str: + """str: Property docstring.""" + ... + + @property + def XDirection(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def XRes(self) -> float: + """float: Property docstring.""" + ... + + @property + def XSize(self) -> int: + """int: Property docstring.""" + ... + + @property + def YDirection(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def YRes(self) -> float: + """float: Property docstring.""" + ... + + @property + def YSize(self) -> int: + """int: Property docstring.""" + ... + + @property + def ZDirection(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def ZRes(self) -> float: + """float: Property docstring.""" + ... + + @property + def ZSize(self) -> int: + """int: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetAbsoluteBeamDoseValue(self, relative: DoseValue) -> DoseValue: + """Method docstring.""" + ... + + def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> DoseProfile: + """Method docstring.""" + ... + + def GetDoseToPoint(self, at: VVector) -> DoseValue: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class BeamParameters: + """An editable copy of the parameters of a treatment beam. + + To apply the parameters, call the""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ControlPoints(self) -> List[ControlPointParameters]: + """List[ControlPointParameters]: Editable control point parameters copied from the treatment beam.""" + ... + + @property + def GantryDirection(self) -> GantryDirection: + """GantryDirection: The direction of gantry rotation (clockwise or counterclockwise).""" + ... + + @property + def Isocenter(self) -> VVector: + """VVector: A copy of the isocenter position, in millimeters.""" + ... + + @Isocenter.setter + def Isocenter(self, value: VVector) -> None: + """Set property value.""" + ... + + @property + def WeightFactor(self) -> float: + """float: The weight factor of the beam.""" + ... + + @WeightFactor.setter + def WeightFactor(self, value: float) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def SetAllLeafPositions(self, leafPositions: Array[float]) -> None: + """Method docstring.""" + ... + + def SetJawPositions(self, positions: VRect[float]) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class BeamUncertainty(ApiDataObject): + """Access to beam uncertainty.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Beam(self) -> Beam: + """Beam: The beam to which this uncertainty is linked.""" + ... + + @property + def BeamNumber(self) -> BeamNumber: + """BeamNumber: Beam number of the related beam.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def Dose(self) -> Dose: + """Dose: Dose of this beam uncertainty.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Block(ApiDataObject): + """Represents a block add-on, a custom-made beam collimating material fixed to a tray, used to shape the beam.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def AddOnMaterial(self) -> AddOnMaterial: + """AddOnMaterial: The dosimetric material of the block.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def IsDiverging(self) -> bool: + """bool: Checks if the block cut is diverging.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Outline(self) -> Array[Array[Point]]: + """Array[Array[Point]]: The block outline points in field coordinates.""" + ... + + @Outline.setter + def Outline(self, value: Array[Array[Point]]) -> None: + """Set property value.""" + ... + + @property + def TransmissionFactor(self) -> float: + """float: The transmission factor of the selected material.""" + ... + + @property + def Tray(self) -> Tray: + """Tray: The tray on which the block is installed.""" + ... + + @property + def TrayTransmissionFactor(self) -> float: + """float: The transmission factor of the selected tray.""" + ... + + @property + def Type(self) -> BlockType: + """BlockType: The type of the block: shielding or aperture.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Bolus(SerializableObject): + """Represents a bolus, which is custom-made material that is usually fixed to the patient's skin for treatment. The bolus is used to modulate the depth dose profile of a beam.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Id(self) -> str: + """str: The identifier of the bolus.""" + ... + + @property + def MaterialCTValue(self) -> float: + """float: The CT value of the bolus material (HU).""" + ... + + @property + def Name(self) -> str: + """str: The name of the bolus.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class BrachyFieldReferencePoint(ApiDataObject): + """This object links a Brachy field to a reference point.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def FieldDose(self) -> DoseValue: + """DoseValue: The field dose.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def IsFieldDoseNominal(self) -> bool: + """bool: Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation.""" + ... + + @property + def IsPrimaryReferencePoint(self) -> bool: + """bool: Checks if the reference point is primary.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def RefPointLocation(self) -> VVector: + """VVector: The location of the reference point.""" + ... + + @property + def ReferencePoint(self) -> ReferencePoint: + """ReferencePoint: Used for navigating to an underlying reference point.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class BrachyPlanSetup(PlanSetup): + """Represents a brachytherapy treatment plan.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApplicationScriptLogs(self) -> List[ApplicationScriptLog]: + """List[ApplicationScriptLog]: Property docstring.""" + ... + + @property + def ApplicationSetupType(self) -> str: + """str: The application setup type of this brachytherapy plan. Possible types are: "FLETCHER_SUIT", "DELCLOS", "BLOEDORN", "JOSLIN_FLYNN", "CHANDIGARH", "MANCHESTER", "HENSCHKE", "NASOPHARYNGEAL", "OESOPHAGEAL", "ENDOBRONCHIAL", "SYED_NEBLETT", "ENDORECTAL", "PERINEAL", "HAM_FLAB", "EYE_PLAQUE", and "OTHER".""" + ... + + @property + def ApprovalHistory(self) -> List[ApprovalHistoryEntry]: + """List[ApprovalHistoryEntry]: Property docstring.""" + ... + + @property + def ApprovalStatus(self) -> PlanSetupApprovalStatus: + """PlanSetupApprovalStatus: Property docstring.""" + ... + + @property + def ApprovalStatusAsString(self) -> str: + """str: Property docstring.""" + ... + + @property + def BaseDosePlanningItem(self) -> PlanningItem: + """PlanningItem: Property docstring.""" + ... + + @BaseDosePlanningItem.setter + def BaseDosePlanningItem(self, value: PlanningItem) -> None: + """Set property value.""" + ... + + @property + def Beams(self) -> List[Beam]: + """List[Beam]: Property docstring.""" + ... + + @property + def BeamsInTreatmentOrder(self) -> List[Beam]: + """List[Beam]: Property docstring.""" + ... + + @property + def BrachyTreatmentTechnique(self) -> BrachyTreatmentTechniqueType: + """BrachyTreatmentTechniqueType: The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT".""" + ... + + @BrachyTreatmentTechnique.setter + def BrachyTreatmentTechnique(self, value: BrachyTreatmentTechniqueType) -> None: + """Set property value.""" + ... + + @property + def Catheters(self) -> List[Catheter]: + """List[Catheter]: The catheters or applicator channel centerlines of this brachytherapy plan, including any catheters associated with""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @Comment.setter + def Comment(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Course(self) -> Course: + """Course: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def CreationUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def DVHEstimates(self) -> List[EstimatedDVH]: + """List[EstimatedDVH]: Property docstring.""" + ... + + @property + def Dose(self) -> PlanningItemDose: + """PlanningItemDose: Property docstring.""" + ... + + @property + def DosePerFraction(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def DosePerFractionInPrimaryRefPoint(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def DoseValuePresentation(self) -> DoseValuePresentation: + """DoseValuePresentation: Property docstring.""" + ... + + @DoseValuePresentation.setter + def DoseValuePresentation(self, value: DoseValuePresentation) -> None: + """Set property value.""" + ... + + @property + def ElectronCalculationModel(self) -> str: + """str: Property docstring.""" + ... + + @property + def ElectronCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def IntegrityHash(self) -> str: + """str: Property docstring.""" + ... + + @property + def IsDoseValid(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsTreated(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @Name.setter + def Name(self, value: str) -> None: + """Set property value.""" + ... + + @property + def NumberOfFractions(self) -> Optional[int]: + """Optional[int]: Property docstring.""" + ... + + @property + def NumberOfPdrPulses(self) -> Optional[int]: + """Optional[int]: The number of pulses in a brachytherapy Pulse Dose Rate (PDR) treatment. Null if the plan is not for a PDR treatment.""" + ... + + @property + def OptimizationSetup(self) -> OptimizationSetup: + """OptimizationSetup: Property docstring.""" + ... + + @property + def PatientSupportDevice(self) -> PatientSupportDevice: + """PatientSupportDevice: Property docstring.""" + ... + + @property + def PdrPulseInterval(self) -> Optional[float]: + """Optional[float]: The pulse interval in a brachytherapy Pulse Dose Rate (PDR) treatment in seconds. Null if the plan is not for a PDR treatment.""" + ... + + @property + def PhotonCalculationModel(self) -> str: + """str: Property docstring.""" + ... + + @property + def PhotonCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: Property docstring.""" + ... + + @property + def PlanIntent(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanIsInTreatment(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def PlanNormalizationMethod(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanNormalizationPoint(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def PlanNormalizationValue(self) -> float: + """float: Property docstring.""" + ... + + @PlanNormalizationValue.setter + def PlanNormalizationValue(self, value: float) -> None: + """Set property value.""" + ... + + @property + def PlanObjectiveStructures(self) -> List[str]: + """List[str]: Property docstring.""" + ... + + @property + def PlanType(self) -> PlanType: + """PlanType: Property docstring.""" + ... + + @property + def PlanUncertainties(self) -> List[PlanUncertainty]: + """List[PlanUncertainty]: Property docstring.""" + ... + + @property + def PlannedDosePerFraction(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def PlanningApprovalDate(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanningApprover(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanningApproverDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def PredecessorPlan(self) -> PlanSetup: + """PlanSetup: Property docstring.""" + ... + + @property + def PredecessorPlanUID(self) -> str: + """str: Property docstring.""" + ... + + @property + def PrescribedDosePerFraction(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def PrescribedPercentage(self) -> float: + """float: Property docstring.""" + ... + + @property + def PrimaryReferencePoint(self) -> ReferencePoint: + """ReferencePoint: Property docstring.""" + ... + + @property + def ProtocolID(self) -> str: + """str: Property docstring.""" + ... + + @property + def ProtocolPhaseID(self) -> str: + """str: Property docstring.""" + ... + + @property + def ProtonCalculationModel(self) -> str: + """str: Property docstring.""" + ... + + @property + def ProtonCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: Property docstring.""" + ... + + @property + def RTPrescription(self) -> RTPrescription: + """RTPrescription: Property docstring.""" + ... + + @property + def ReferenceLines(self) -> List[Structure]: + """List[Structure]: Collection of reference lines in the plan.""" + ... + + @property + def ReferencePoints(self) -> List[ReferencePoint]: + """List[ReferencePoint]: Property docstring.""" + ... + + @property + def SeedCollections(self) -> List[SeedCollection]: + """List[SeedCollection]: The seed collections of this brachytherapy plan.""" + ... + + @property + def Series(self) -> Series: + """Series: Property docstring.""" + ... + + @property + def SeriesUID(self) -> str: + """str: Property docstring.""" + ... + + @property + def SolidApplicators(self) -> List[BrachySolidApplicator]: + """List[BrachySolidApplicator]: The solid applicator parts of this brachytherapy plan.""" + ... + + @property + def StructureSet(self) -> StructureSet: + """StructureSet: Property docstring.""" + ... + + @property + def StructuresSelectedForDvh(self) -> List[Structure]: + """List[Structure]: Property docstring.""" + ... + + @property + def TargetVolumeID(self) -> str: + """str: Property docstring.""" + ... + + @property + def TotalDose(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def TotalPrescribedDose(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def TreatmentApprovalDate(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentApprover(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentApproverDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The treatment date of this brachytherapy plan.""" + ... + + @TreatmentDateTime.setter + def TreatmentDateTime(self, value: Optional[datetime]) -> None: + """Set property value.""" + ... + + @property + def TreatmentOrientation(self) -> PatientOrientation: + """PatientOrientation: Property docstring.""" + ... + + @property + def TreatmentOrientationAsString(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentPercentage(self) -> float: + """float: Property docstring.""" + ... + + @property + def TreatmentSessions(self) -> List[PlanTreatmentSession]: + """List[PlanTreatmentSession]: Property docstring.""" + ... + + @property + def TreatmentTechnique(self) -> str: + """str: The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT".""" + ... + + @property + def UID(self) -> str: + """str: Property docstring.""" + ... + + @property + def UseGating(self) -> bool: + """bool: Property docstring.""" + ... + + @UseGating.setter + def UseGating(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def VerifiedPlan(self) -> PlanSetup: + """PlanSetup: Property docstring.""" + ... + + def AddCatheter(self, catheterId: str, treatmentUnit: BrachyTreatmentUnit, outputDiagnostics: StringBuilder, appendChannelNumToId: bool, channelNum: int) -> Catheter: + """Method docstring.""" + ... + + def AddLocationToExistingReferencePoint(self, location: VVector, referencePoint: ReferencePoint) -> None: + """Method docstring.""" + ... + + def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: + """Method docstring.""" + ... + + def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: + """Method docstring.""" + ... + + @overload + def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: + """Method docstring.""" + ... + + @overload + def AddReferencePoint(self, refPoint: ReferencePoint) -> None: + """Method docstring.""" + ... + + def CalculateAccurateTG43DoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> DoseProfile: + """Method docstring.""" + ... + + def CalculateTG43Dose(self) -> CalculateBrachy3DDoseResult: + """Calculates 3D dose using the TG-43 brachy calculator.""" + ... + + def ChangeTreatmentUnit(self, treatmentUnit: BrachyTreatmentUnit, keepDoseIntact: bool, messages: List) -> ChangeBrachyTreatmentUnitResult: + """Method docstring.""" + ... + + def ClearCalculationModel(self, calculationType: CalculationType) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetCalculationModel(self, calculationType: CalculationType) -> str: + """Method docstring.""" + ... + + def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """Method docstring.""" + ... + + def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: + """Method docstring.""" + ... + + def GetClinicalGoals(self) -> List[ClinicalGoal]: + """Method docstring.""" + ... + + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """Method docstring.""" + ... + + def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: + """Method docstring.""" + ... + + def GetDvhEstimationModelName(self) -> str: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List, measures: List) -> None: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: + """Method docstring.""" + ... + + def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: + """Method docstring.""" + ... + + def IsValidForPlanApproval(self, validationResults: List) -> bool: + """Method docstring.""" + ... + + def MoveToCourse(self, destinationCourse: Course) -> None: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: + """Method docstring.""" + ... + + def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: + """Method docstring.""" + ... + + def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """Method docstring.""" + ... + + def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: + """Method docstring.""" + ... + + def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: StringBuilder) -> bool: + """Method docstring.""" + ... + + def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class BrachySolidApplicator(ApiDataObject): + """Represents a brachytherapy solid applicator part, such as a tandem or ovoid in a Fletcher Suit Delclos (FSD) applicator set. This class holds only the metadata related to the solid applicator part, and links to the""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApplicatorSetName(self) -> str: + """str: The name of the solid applicator set to which this part belongs.""" + ... + + @property + def ApplicatorSetType(self) -> str: + """str: The type of the solid applicator set to which this part belongs.""" + ... + + @property + def Category(self) -> str: + """str: The category of the solid applicator set to which this part belongs.""" + ... + + @property + def Catheters(self) -> List[Catheter]: + """List[Catheter]: The channel(s) of this solid applicator part.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def GroupNumber(self) -> int: + """int: Applicator Group number.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Note(self) -> str: + """str: A note or short description of the solid applicator part.""" + ... + + @property + def PartName(self) -> str: + """str: The name of the solid applicator part.""" + ... + + @property + def PartNumber(self) -> str: + """str: The part number of the solid applicator.""" + ... + + @property + def Summary(self) -> str: + """str: A summary of the solid applicator set to which this part belongs.""" + ... + + @property + def UID(self) -> str: + """str: The unique identifier of the solid applicator part.""" + ... + + @property + def Vendor(self) -> str: + """str: The vendor of the solid applicator set to which this part belongs.""" + ... + + @property + def Version(self) -> str: + """str: The version of the solid applicator part.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class BrachyTreatmentUnit(ApiDataObject): + """Represents a brachytherapy afterloader.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def DoseRateMode(self) -> str: + """str: The dose rate mode of this treatment unit. Supported modes are "HDR", "PDR", "MDR", and "LDR".""" + ... + + @property + def DwellTimeResolution(self) -> float: + """float: The dwell time resolution supported by this treatment unit in seconds.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def MachineInterface(self) -> str: + """str: The interface type for communicating with this brachytherapy treatment unit. Possible types are "GammaMed12i", "GammaMedPlus", "VariSource", "Other", and "Omnitron" (obsolete type).""" + ... + + @property + def MachineModel(self) -> str: + """str: The model identifier for this treatment unit. Possible models are "VariSource_5", "VariSource_10", "Remote_Afterloading", "Manual_Loading", "GammaMed12i", and "GammaMedPlus".""" + ... + + @property + def MaxDwellTimePerChannel(self) -> float: + """float: The maximum combined dwell time in a single channel in seconds.""" + ... + + @property + def MaxDwellTimePerPos(self) -> float: + """float: The maximum dwell time in a single dwell position in seconds.""" + ... + + @property + def MaxDwellTimePerTreatment(self) -> float: + """float: The maximum combined dwell time in all the channels during a single treatment session. The value is in seconds.""" + ... + + @property + def MaximumChannelLength(self) -> float: + """float: The maximum channel length supported by this treatment unit in millimeters.""" + ... + + @property + def MaximumDwellPositionsPerChannel(self) -> int: + """int: The maximum number of dwell positions per channel supported by this treatment unit.""" + ... + + @property + def MaximumStepSize(self) -> float: + """float: The maximum distance between adjacent source positions in millimeters.""" + ... + + @property + def MinAllowedSourcePos(self) -> float: + """float: The minimum allowed distance (in millimeters) from the tip of the inner lumen of the applicator to the center of the first dwell position. In other words, no source positions should be placed within this distance from the tip of the inner lumen.""" + ... + + @property + def MinimumChannelLength(self) -> float: + """float: The minimum channel length supported by this treatment unit in millimeters.""" + ... + + @property + def MinimumStepSize(self) -> float: + """float: The minimum distance between adjacent source positions in millimeters.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def NumberOfChannels(self) -> int: + """int: The number of channels in this treatment unit.""" + ... + + @property + def SourceCenterOffsetFromTip(self) -> float: + """float: The offset distance (in millimeters) from the tip of the applicator to the center of the source at its first possible dwell position. In other words, the offset accounts for half of the active source length and encapsulation.""" + ... + + @property + def SourceMovementType(self) -> str: + """str: The source movement type as defined in DICOM. Possible types are "STEPWISE", "FIXED", and "OSCILLATING".""" + ... + + @property + def StepSizeResolution(self) -> float: + """float: The default step size resolution for this treatment unit in millimeters.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetActiveRadioactiveSource(self) -> RadioactiveSource: + """Returns the active radioactive source of this treatment unit. + + Returns: + RadioactiveSource: A RadioactiveSource object if the treatment unit has a source installed. Otherwise null.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class CalculateBrachy3DDoseResult(SerializableObject): + """Brachy 3D dose calculation result""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Errors(self) -> List[str]: + """List[str]: Error messages if "Success" is false.""" + ... + + @property + def RoundedDwellTimeAdjustRatio(self) -> float: + """float: The ratio with which the dwell times were adjusted to meet the resolution of the treatment unit. A value of zero (0.0) means no adjustment to dwell times was made. Value is undefined if "Success" is false""" + ... + + @property + def Success(self) -> bool: + """bool: Was the dose calculation successful?""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Calculation: + """Contains a calculation specific functions""" + + def __init__(self, dvhEstimationModelLibrary: IDVHEstimationModelLibrary) -> None: + """Initialize instance.""" + ... + + @property + def AlgorithmsRootPath(self) -> str: + """str: Algorithms Root Path""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetCalculationModels(self) -> List[CalculationModel]: + """Retrieves calculation models""" + ... + + def GetDvhEstimationModelStructures(self, modelId: str) -> List[DVHEstimationModelStructure]: + """Method docstring.""" + ... + + def GetDvhEstimationModelSummaries(self) -> List[DVHEstimationModelSummary]: + """List of DVH Estimation Model summaries.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetInstalledAlgorithms(self) -> List[Algorithm]: + """Installed Algorithms""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class CalculationModel(ValueType): + """Calculation Model""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + AlgorithmName: str + AlgorithmVersion: str + BeamDataDirectory: str + DefaultOptionsFilePath: str + EnabledFlag: bool + ModelName: str + +class CalculationModel(ValueType): + """Calculation Model""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + AlgorithmName: str + AlgorithmVersion: str + BeamDataDirectory: str + DefaultOptionsFilePath: str + EnabledFlag: bool + ModelName: str + +class CalculationResult: + """Holds the result of the calculation (pass/fail).""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Success(self) -> bool: + """bool: Returns true if calculation did not return any errors. Otherwise returns false.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Catheter(ApiDataObject): + """Represents a brachytherapy catheter or an applicator channel centerline. Catheters are associated with a""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApplicatorLength(self) -> float: + """float: The total length from the tip of the catheter to the treatment unit in millimeters.""" + ... + + @ApplicatorLength.setter + def ApplicatorLength(self, value: float) -> None: + """Set property value.""" + ... + + @property + def BrachyFieldReferencePoints(self) -> List[BrachyFieldReferencePoint]: + """List[BrachyFieldReferencePoint]: A collection of brachy field reference points.""" + ... + + @property + def BrachySolidApplicatorPartID(self) -> int: + """int: The unique identifier of the""" + ... + + @property + def ChannelNumber(self) -> int: + """int: The channel number of this catheter.""" + ... + + @ChannelNumber.setter + def ChannelNumber(self, value: int) -> None: + """Set property value.""" + ... + + @property + def Color(self) -> Color: + """Color: The color of the catheter in 2D views.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def DeadSpaceLength(self) -> float: + """float: The total length from the tip of the catheter to the start of the inner lumen in millimeters.""" + ... + + @DeadSpaceLength.setter + def DeadSpaceLength(self, value: float) -> None: + """Set property value.""" + ... + + @property + def FirstSourcePosition(self) -> float: + """float: The first source position in millimeters in this catheter. This is the source position closest to the tip of the catheter.""" + ... + + @property + def GroupNumber(self) -> int: + """int: Catheter Group number.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def LastSourcePosition(self) -> float: + """float: The last source position in millimeters in this catheter. This is the source position furthest away from the tip of the catheter.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Shape(self) -> Array[VVector]: + """Array[VVector]: The DICOM coordinates of the applicator shape starting from the tip.""" + ... + + @Shape.setter + def Shape(self, value: Array[VVector]) -> None: + """Set property value.""" + ... + + @property + def SourcePositions(self) -> List[SourcePosition]: + """List[SourcePosition]: The source positions in the catheter starting from the tip.""" + ... + + @property + def StepSize(self) -> float: + """float: The step size of the catheter in millimeters.""" + ... + + @property + def TreatmentUnit(self) -> BrachyTreatmentUnit: + """BrachyTreatmentUnit: The brachytherapy treatment unit associated with this catheter.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetSourcePosCenterDistanceFromTip(self, sourcePosition: SourcePosition) -> float: + """Method docstring.""" + ... + + def GetTotalDwellTime(self) -> float: + """The total dwell time in this catheter in seconds. + + Returns: + float: The total dwell time in this catheter in seconds.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def LinkRefLine(self, refLine: Structure) -> None: + """Method docstring.""" + ... + + def LinkRefPoint(self, refPoint: ReferencePoint) -> None: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def SetId(self, id: str, message: str) -> bool: + """Method docstring.""" + ... + + def SetSourcePositions(self, stepSize: float, firstSourcePosition: float, lastSourcePosition: float) -> SetSourcePositionsResult: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def UnlinkRefLine(self, refLine: Structure) -> None: + """Method docstring.""" + ... + + def UnlinkRefPoint(self, refPoint: ReferencePoint) -> None: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Compensator(ApiDataObject): + """Represents a beam compensator add-on, a custom-made beam modulating material fixed to a tray, used to modulate the beam's intensity.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Material(self) -> AddOnMaterial: + """AddOnMaterial: The dosimetric material used in the compensator.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Slot(self) -> Slot: + """Slot: The slot into which the tray is inserted.""" + ... + + @property + def Tray(self) -> Tray: + """Tray: The tray to which the compensator is connected.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ConsoleEventHandlerDelegate(MulticastDelegate): + """Class docstring.""" + + def __init__(self, object: Any, method: IntPtr) -> None: + """Initialize instance.""" + ... + + @property + def Method(self) -> MethodInfo: + """MethodInfo: Property docstring.""" + ... + + @property + def Target(self) -> Any: + """Any: Property docstring.""" + ... + + def BeginInvoke(self, eventCode: ConsoleHandlerEventCode, callback: AsyncCallback, object: Any) -> FileStreamAsyncResult: + """Method docstring.""" + ... + + def Clone(self) -> Any: + """Method docstring.""" + ... + + def DynamicInvoke(self, args: Array[Any]) -> Any: + """Method docstring.""" + ... + + def EndInvoke(self, result: FileStreamAsyncResult) -> bool: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetInvocationList(self) -> Array[Delegate]: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Invoke(self, eventCode: ConsoleHandlerEventCode) -> bool: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class ConsoleHandlerEventCode: + """Class docstring.""" + + CTRL_BREAK_EVENT: ConsoleHandlerEventCode + CTRL_CLOSE_EVENT: ConsoleHandlerEventCode + CTRL_C_EVENT: ConsoleHandlerEventCode + CTRL_LOGOFF_EVENT: ConsoleHandlerEventCode + CTRL_SHUTDOWN_EVENT: ConsoleHandlerEventCode + +class ConsoleHandlerEventCode: + """Class docstring.""" + + CTRL_BREAK_EVENT: ConsoleHandlerEventCode + CTRL_CLOSE_EVENT: ConsoleHandlerEventCode + CTRL_C_EVENT: ConsoleHandlerEventCode + CTRL_LOGOFF_EVENT: ConsoleHandlerEventCode + CTRL_SHUTDOWN_EVENT: ConsoleHandlerEventCode + +class ControlPoint(SerializableObject): + """Represents a point in a planned sequence of treatment beam parameters. See the definition of control points in a DICOM RT Beam. + + Control points are discussed in DICOM PS 3.3 C.8.8.14. All beams have at least two control points. Note that some values may be NaN if they are not applicable to the treatment plan in question.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Beam(self) -> Beam: + """Beam: Used for navigating to parent beam""" + ... + + @property + def CollimatorAngle(self) -> float: + """float: The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).""" + ... + + @property + def GantryAngle(self) -> float: + """float: The gantry angle of the radiation source. In other words, the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).""" + ... + + @property + def Index(self) -> int: + """int: Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points.""" + ... + + @property + def JawPositions(self) -> VRect[float]: + """VRect[float]: The positions of the beam collimator jaws (in mm) in the IEC BEAM LIMITING DEVICE coordinates.""" + ... + + @property + def LeafPositions(self) -> Array[float]: + """Array[float]: The positions of the beam collimator leaf pairs (in mm) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If there is no MLC, a (0,0)-length array is returned.""" + ... + + @property + def MetersetWeight(self) -> float: + """float: The cumulative meterset weight to this control point. The cumulative meterset weight for the first item in a control point sequence is zero.""" + ... + + @property + def PatientSupportAngle(self) -> float: + """float: The patient support angle. In other words, the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).""" + ... + + @property + def TableTopLateralPosition(self) -> float: + """float: Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system.""" + ... + + @property + def TableTopLongitudinalPosition(self) -> float: + """float: Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system.""" + ... + + @property + def TableTopVerticalPosition(self) -> float: + """float: Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ControlPointCollection(SerializableObject): + """Represents a collection of machine parameters that describe the planned treatment beam.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: The number of control points in the collection.""" + ... + + @property + def Item(self) -> ControlPoint: + """ControlPoint: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator[ControlPoint]: + """Retrieves enumerator for ControlPoints in the collection. + + Returns: + IEnumerator[ControlPoint]: Enumerator for ControlPoints in the collection.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ControlPointParameters: + """An editable copy of the parameters of a control point. + + To apply the parameters, call the ApplyParameters method of the Beam class. Because the parameters are simple copies, they do not reflect the current state of the data model.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def CollimatorAngle(self) -> float: + """float: A copy of the collimator angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).""" + ... + + @property + def GantryAngle(self) -> float: + """float: A copy of the gantry angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).""" + ... + + @GantryAngle.setter + def GantryAngle(self, value: float) -> None: + """Set property value.""" + ... + + @property + def Index(self) -> int: + """int: Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points.""" + ... + + @property + def JawPositions(self) -> VRect[float]: + """VRect[float]: A copy of the jaw positions of the treatment beams at this control point in millimeters, and in IEC BEAM LIMITING DEVICE coordinates.""" + ... + + @JawPositions.setter + def JawPositions(self, value: VRect[float]) -> None: + """Set property value.""" + ... + + @property + def LeafPositions(self) -> Array[float]: + """Array[float]: A copy of the positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. If no MLC exists, a (0,0)-length array is returned.""" + ... + + @LeafPositions.setter + def LeafPositions(self, value: Array[float]) -> None: + """Set property value.""" + ... + + @property + def MetersetWeight(self) -> float: + """float: A copy of the cumulative meterset weight to this control point.""" + ... + + @MetersetWeight.setter + def MetersetWeight(self, value: float) -> None: + """Set property value.""" + ... + + @property + def PatientSupportAngle(self) -> float: + """float: A copy of the patient support angle at this control point, in degrees, in the range [0, 360[. It is defined as the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).""" + ... + + @property + def TableTopLateralPosition(self) -> float: + """float: Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system.""" + ... + + @property + def TableTopLongitudinalPosition(self) -> float: + """float: Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system.""" + ... + + @property + def TableTopVerticalPosition(self) -> float: + """float: Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Course(ApiDataObject): + """A course represents the course of treatment that a patient will be given. Every patient must have a course, and all plans always belong to a course.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def BrachyPlanSetups(self) -> List[BrachyPlanSetup]: + """List[BrachyPlanSetup]: A collection of brachytherapy plans for the course.""" + ... + + @property + def ClinicalStatus(self) -> CourseClinicalStatus: + """CourseClinicalStatus: Clinical Status of Course.""" + ... + + @property + def Comment(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] A comment about the Course.""" + ... + + @Comment.setter + def Comment(self, value: str) -> None: + """Set property value.""" + ... + + @property + def CompletedDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The date and time when the course was completed.""" + ... + + @property + def Diagnoses(self) -> List[Diagnosis]: + """List[Diagnosis]: The diagnoses that are attached to the course.""" + ... + + @property + def ExternalPlanSetups(self) -> List[ExternalPlanSetup]: + """List[ExternalPlanSetup]: A collection of external beam plans for the course.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Course.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Intent(self) -> str: + """str: The intent of the course.""" + ... + + @property + def IonPlanSetups(self) -> List[IonPlanSetup]: + """List[IonPlanSetup]: A collection of proton plans for the course.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Patient(self) -> Patient: + """Patient: Patient in which the course is defined.""" + ... + + @property + def PlanSetups(self) -> List[PlanSetup]: + """List[PlanSetup]: A collection of plans for the course. The plans can be of any type (external beam or brachytherapy).""" + ... + + @property + def PlanSums(self) -> List[PlanSum]: + """List[PlanSum]: A collection of plan sums for the course.""" + ... + + @property + def StartDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The date and time when the course was started.""" + ... + + @property + def TreatmentPhases(self) -> List[TreatmentPhase]: + """List[TreatmentPhase]: All treatment phases in the course.""" + ... + + @property + def TreatmentSessions(self) -> List[TreatmentSession]: + """List[TreatmentSession]: Treatment sessions of the course.""" + ... + + def AddBrachyPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, dosePerFraction: DoseValue, brachyTreatmentTechnique: BrachyTreatmentTechniqueType, additionalReferencePoints: List[ReferencePoint]) -> BrachyPlanSetup: + """Method docstring.""" + ... + + @overload + def AddBrachyPlanSetup(self, structureSet: StructureSet, dosePerFraction: DoseValue, brachyTreatmentTechnique: BrachyTreatmentTechniqueType) -> BrachyPlanSetup: + """Method docstring.""" + ... + + def AddExternalPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, additionalReferencePoints: List[ReferencePoint]) -> ExternalPlanSetup: + """Method docstring.""" + ... + + @overload + def AddExternalPlanSetup(self, structureSet: StructureSet) -> ExternalPlanSetup: + """Method docstring.""" + ... + + def AddExternalPlanSetupAsVerificationPlan(self, structureSet: StructureSet, verifiedPlan: ExternalPlanSetup) -> ExternalPlanSetup: + """Method docstring.""" + ... + + def AddIonPlanSetup(self, structureSet: StructureSet, targetStructure: Structure, primaryReferencePoint: ReferencePoint, patientSupportDeviceId: str, additionalReferencePoints: List[ReferencePoint]) -> IonPlanSetup: + """Method docstring.""" + ... + + @overload + def AddIonPlanSetup(self, structureSet: StructureSet, patientSupportDeviceId: str) -> IonPlanSetup: + """Method docstring.""" + ... + + def AddIonPlanSetupAsVerificationPlan(self, structureSet: StructureSet, patientSupportDeviceId: str, verifiedPlan: IonPlanSetup) -> IonPlanSetup: + """Method docstring.""" + ... + + def CanAddPlanSetup(self, structureSet: StructureSet) -> bool: + """Method docstring.""" + ... + + def CanRemovePlanSetup(self, planSetup: PlanSetup) -> bool: + """Method docstring.""" + ... + + def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, outputDiagnostics: StringBuilder) -> BrachyPlanSetup: + """Method docstring.""" + ... + + @overload + def CopyBrachyPlanSetup(self, sourcePlan: BrachyPlanSetup, structureset: StructureSet, outputDiagnostics: StringBuilder) -> BrachyPlanSetup: + """Method docstring.""" + ... + + def CopyPlanSetup(self, sourcePlan: PlanSetup) -> PlanSetup: + """Method docstring.""" + ... + + @overload + def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, outputDiagnostics: StringBuilder) -> PlanSetup: + """Method docstring.""" + ... + + @overload + def CopyPlanSetup(self, sourcePlan: PlanSetup, targetImage: Image, registration: Registration, outputDiagnostics: StringBuilder) -> PlanSetup: + """Method docstring.""" + ... + + @overload + def CopyPlanSetup(self, sourcePlan: PlanSetup, structureset: StructureSet, outputDiagnostics: StringBuilder) -> PlanSetup: + """Method docstring.""" + ... + + def CreatePlanSum(self, planningItems: List[PlanningItem], image: Image) -> PlanSum: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def IsCompleted(self) -> bool: + """Checks if the clinical status of the course is completed or restored. + + Returns: + bool: true if the clinical status of the course is completed or restored.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemovePlanSetup(self, planSetup: PlanSetup) -> None: + """Method docstring.""" + ... + + def RemovePlanSum(self, planSum: PlanSum) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class CustomScriptExecutable: + """A factory class for creating an application object for a custom script executable.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @staticmethod + def CreateApplication(scriptName: str) -> Application: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class DVHData(SerializableObject): + """Represents Dose Volume Histogram (DVH) data.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Coverage(self) -> float: + """float: The dose coverage of the target, normalized to 0.0 .. 1.0.""" + ... + + @property + def CurveData(self) -> Array[DVHPoint]: + """Array[DVHPoint]: The points of the Dose Volume Histogram (DVH) curve.""" + ... + + @property + def MaxDose(self) -> DoseValue: + """DoseValue: The maximum dose.""" + ... + + @property + def MaxDosePosition(self) -> VVector: + """VVector: The position of the maximum dose.""" + ... + + @property + def MeanDose(self) -> DoseValue: + """DoseValue: The mean dose.""" + ... + + @property + def MedianDose(self) -> DoseValue: + """DoseValue: The median dose.""" + ... + + @property + def MinDose(self) -> DoseValue: + """DoseValue: The minimum dose.""" + ... + + @property + def MinDosePosition(self) -> VVector: + """VVector: The position of the minimum dose.""" + ... + + @property + def SamplingCoverage(self) -> float: + """float: The sampling coverage.""" + ... + + @property + def StdDev(self) -> float: + """float: The standard deviation.""" + ... + + @property + def Volume(self) -> float: + """float: The volume of the structure in cubic centimeters.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class DVHEstimationModelStructure(SerializableObject): + """Structure of a DVH estimation model in Planning Model Library""" + + def __init__(self, impl: DVHEstimationModelStructure) -> None: + """Initialize instance.""" + ... + + @property + def Id(self) -> str: + """str: Id of the structure""" + ... + + @property + def IsValid(self) -> bool: + """bool: Is Valid""" + ... + + @property + def ModelStructureGuid(self) -> str: + """str: Model Id""" + ... + + @property + def StructureCodes(self) -> List[StructureCode]: + """List[StructureCode]: List of structure codes associated with the structure""" + ... + + @property + def StructureType(self) -> DVHEstimationStructureType: + """DVHEstimationStructureType: Structure type: PTV or OAR""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class DVHEstimationModelSummary(SerializableObject): + """A summary of an DVH Estimation Model. Contains the needed information for selecting a model.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Description(self) -> str: + """str: Model Description""" + ... + + @property + def IsPublished(self) -> bool: + """bool: True if set to published state. Only published models are available for optimizing.""" + ... + + @property + def IsTrained(self) -> bool: + """bool: True if the model contains data.""" + ... + + @property + def ModelDataVersion(self) -> str: + """str: Version""" + ... + + @property + def ModelParticleType(self) -> ParticleType: + """ParticleType: Returns particle type for the model. Either ParticleType.Proton or ParticleType.Photon.""" + ... + + @property + def ModelUID(self) -> str: + """str: Model UID. To be used for the Load command.""" + ... + + @property + def Name(self) -> str: + """str: Display Name""" + ... + + @property + def Revision(self) -> int: + """int: Publish revision of the model""" + ... + + @property + def TreatmentSite(self) -> str: + """str: Indicating the treatment site the model was created for""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class DefaultApplicationContext: + """Class docstring.""" + + def __init__(self, appName: str, taskName: str, versionString: str) -> None: + """Initialize instance.""" + ... + + @property + def ApprovesWorkflowSupportedPlans(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def AutomaticFieldOrdering(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def CanEditBrachyPlans(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def EditsTreatmentMachines(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def LoadsPatientsWithoutOpening(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def RequireConeInEachField(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def WantsToCalculateOnTheFly(self) -> bool: + """bool: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetAppEdition(self) -> str: + """Method docstring.""" + ... + + def GetAppName(self) -> str: + """Method docstring.""" + ... + + def GetAppVersion(self) -> str: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetTaskEdition(self) -> str: + """Method docstring.""" + ... + + def GetTaskName(self) -> str: + """Method docstring.""" + ... + + def GetTaskVersion(self) -> str: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetWorkspaceName(self) -> str: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Diagnosis(ApiDataObject): + """Represents a diagnosis of the patient.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ClinicalDescription(self) -> str: + """str: User-defined clinical description of the diagnosis.""" + ... + + @property + def Code(self) -> str: + """str: The disease code from the specified code table.""" + ... + + @property + def CodeTable(self) -> str: + """str: Identifies the coding system table, for example, ICD-9-CM.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Dose(ApiDataObject): + """Represents a 3D dose grid.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def DoseMax3D(self) -> DoseValue: + """DoseValue: The maximum dose.""" + ... + + @property + def DoseMax3DLocation(self) -> VVector: + """VVector: The location of the maximum dose.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Isodoses(self) -> List[Isodose]: + """List[Isodose]: A collection of isodoses.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Origin(self) -> VVector: + """VVector: The origin of the dose matrix. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first dose plane.""" + ... + + @property + def Series(self) -> Series: + """Series: Returns the series that contains the dose, or null if the dose is not connected to a series.""" + ... + + @property + def SeriesUID(self) -> str: + """str: Returns the DICOM UID of the series that contains the dose, or an empty string if the dose is not connected to a series.""" + ... + + @property + def UID(self) -> str: + """str: The DICOM UID of the dose.""" + ... + + @property + def XDirection(self) -> VVector: + """VVector: The direction of the x-axis in the dose matrix.""" + ... + + @property + def XRes(self) -> float: + """float: The dose matrix resolution in X-direction in millimeters.""" + ... + + @property + def XSize(self) -> int: + """int: The dose matrix size in X-direction in voxels.""" + ... + + @property + def YDirection(self) -> VVector: + """VVector: The direction of the y-axis in the dose matrix.""" + ... + + @property + def YRes(self) -> float: + """float: The dose matrix resolution in Y-direction in millimeters.""" + ... + + @property + def YSize(self) -> int: + """int: The dose matrix size in Y-direction in voxels.""" + ... + + @property + def ZDirection(self) -> VVector: + """VVector: The direction of the z-axis in the dose matrix.""" + ... + + @property + def ZRes(self) -> float: + """float: The dose matrix resolution in Z-direction in millimeters.""" + ... + + @property + def ZSize(self) -> int: + """int: The dose matrix size in Z-direction in voxels.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> DoseProfile: + """Method docstring.""" + ... + + def GetDoseToPoint(self, at: VVector) -> DoseValue: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class DynamicWedge(Wedge): + """A Dynamic Wedge is formed by a moving jaw of a standard collimator during irradiation.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def Direction(self) -> float: + """float: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def WedgeAngle(self) -> float: + """float: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ESAPIActionPackAttribute(Attribute): + """Specifies the assembly as an Eclipse visual scripting action pack. Action packs are ESAPI scripts that are used by visual scripts.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def IsWriteable(self) -> bool: + """bool: Returns true if the action pack can modify patient data.""" + ... + + @IsWriteable.setter + def IsWriteable(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def TypeId(self) -> Any: + """Any: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def IsDefaultAttribute(self) -> bool: + """Method docstring.""" + ... + + def Match(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class ESAPIScriptAttribute(Attribute): + """Specifies the assembly as an Eclipse Scripting API (ESAPI) script.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def IsWriteable(self) -> bool: + """bool: Returns true if the script can modify patient data.""" + ... + + @IsWriteable.setter + def IsWriteable(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def TypeId(self) -> Any: + """Any: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def IsDefaultAttribute(self) -> bool: + """Method docstring.""" + ... + + def Match(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class EnergyMode(ApiDataObject): + """Represents an energy mode.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def IsElectron(self) -> bool: + """bool: Checks if the mode is electron.""" + ... + + @property + def IsPhoton(self) -> bool: + """bool: Checks if the mode is photon.""" + ... + + @property + def IsProton(self) -> bool: + """bool: Checks if the mode is proton.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class EnhancedDynamicWedge(DynamicWedge): + """An Enhanced Dynamic Wedge is similar to a Dynamic Wedge, but it features more wedge angles than a simple Dynamic Wedge.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def Direction(self) -> float: + """float: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def WedgeAngle(self) -> float: + """float: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Equipment: + """Provides access to clinical devices and accessories.""" + + def __init__(self, admin: IAdmin) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetBrachyTreatmentUnits(self) -> List[BrachyTreatmentUnit]: + """Returns the available brachy treatment units. Excludes virtual and deleted ones. + + Returns: + List[BrachyTreatmentUnit]: The available brachy treatment units.""" + ... + + def GetExternalBeamTreatmentUnits(self) -> List[ExternalBeamTreatmentUnit]: + """Returns the available External Beam treatment units. Excludes virtual and deleted ones. + + Returns: + List[ExternalBeamTreatmentUnit]: The available brachy treatment units.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class EstimatedDVH(ApiDataObject): + """Represents an estimated Dose Volume Histogram (DVH) curve.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CurveData(self) -> Array[DVHPoint]: + """Array[DVHPoint]: The points of the estimated DVH curve.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanSetup(self) -> PlanSetup: + """PlanSetup: Parent plan.""" + ... + + @property + def PlanSetupId(self) -> str: + """str: ID of the parent plan.""" + ... + + @property + def Structure(self) -> Structure: + """Structure: Parent structure.""" + ... + + @property + def StructureId(self) -> str: + """str: ID of the parent structure.""" + ... + + @property + def TargetDoseLevel(self) -> DoseValue: + """DoseValue: Dose level of the associated target structure.""" + ... + + @property + def Type(self) -> DVHEstimateType: + """DVHEstimateType: Type of DVH estimate curve.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class EvaluationDose(Dose): + """Represents an evaluation dose that is connected to a plan that has no beams.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def DoseMax3D(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def DoseMax3DLocation(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Isodoses(self) -> List[Isodose]: + """List[Isodose]: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Origin(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def Series(self) -> Series: + """Series: Property docstring.""" + ... + + @property + def SeriesUID(self) -> str: + """str: Property docstring.""" + ... + + @property + def UID(self) -> str: + """str: Property docstring.""" + ... + + @property + def XDirection(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def XRes(self) -> float: + """float: Property docstring.""" + ... + + @property + def XSize(self) -> int: + """int: Property docstring.""" + ... + + @property + def YDirection(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def YRes(self) -> float: + """float: Property docstring.""" + ... + + @property + def YSize(self) -> int: + """int: Property docstring.""" + ... + + @property + def ZDirection(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def ZRes(self) -> float: + """float: Property docstring.""" + ... + + @property + def ZSize(self) -> int: + """int: Property docstring.""" + ... + + def DoseValueToVoxel(self, doseValue: DoseValue) -> int: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> DoseProfile: + """Method docstring.""" + ... + + def GetDoseToPoint(self, at: VVector) -> DoseValue: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def SetVoxels(self, planeIndex: int, values: Array[int]) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ExternalBeamTreatmentUnit(ApiDataObject): + """Represents a treatment machine used for delivering external beam radiotherapy.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def MachineDepartmentName(self) -> str: + """str: Default department associated with the machine.""" + ... + + @property + def MachineModel(self) -> str: + """str: The model of the treatment unit.""" + ... + + @property + def MachineModelName(self) -> str: + """str: The displayed name of the treatment unit model.""" + ... + + @property + def MachineScaleDisplayName(self) -> str: + """str: The name of the scale used in the treatment unit.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def OperatingLimits(self) -> TreatmentUnitOperatingLimits: + """TreatmentUnitOperatingLimits: Information about operating limits for a set of treatment unit parameters.""" + ... + + @property + def SourceAxisDistance(self) -> float: + """float: The Source to Axis Distance (SAD).""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ExternalPlanSetup(PlanSetup): + """Represents an external beam plan. For more information, see the definition of the DICOM RT Plan.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApplicationScriptLogs(self) -> List[ApplicationScriptLog]: + """List[ApplicationScriptLog]: Property docstring.""" + ... + + @property + def ApprovalHistory(self) -> List[ApprovalHistoryEntry]: + """List[ApprovalHistoryEntry]: Property docstring.""" + ... + + @property + def ApprovalStatus(self) -> PlanSetupApprovalStatus: + """PlanSetupApprovalStatus: Property docstring.""" + ... + + @property + def ApprovalStatusAsString(self) -> str: + """str: Property docstring.""" + ... + + @property + def BaseDosePlanningItem(self) -> PlanningItem: + """PlanningItem: Property docstring.""" + ... + + @BaseDosePlanningItem.setter + def BaseDosePlanningItem(self, value: PlanningItem) -> None: + """Set property value.""" + ... + + @property + def Beams(self) -> List[Beam]: + """List[Beam]: Property docstring.""" + ... + + @property + def BeamsInTreatmentOrder(self) -> List[Beam]: + """List[Beam]: Property docstring.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @Comment.setter + def Comment(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Course(self) -> Course: + """Course: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def CreationUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def DVHEstimates(self) -> List[EstimatedDVH]: + """List[EstimatedDVH]: Property docstring.""" + ... + + @property + def Dose(self) -> PlanningItemDose: + """PlanningItemDose: Property docstring.""" + ... + + @property + def DoseAsEvaluationDose(self) -> EvaluationDose: + """EvaluationDose: The evaluation dose is connected to the plan and contains voxels that are set by""" + ... + + @property + def DosePerFraction(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def DosePerFractionInPrimaryRefPoint(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def DoseValuePresentation(self) -> DoseValuePresentation: + """DoseValuePresentation: Property docstring.""" + ... + + @DoseValuePresentation.setter + def DoseValuePresentation(self, value: DoseValuePresentation) -> None: + """Set property value.""" + ... + + @property + def ElectronCalculationModel(self) -> str: + """str: Property docstring.""" + ... + + @property + def ElectronCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def IntegrityHash(self) -> str: + """str: Property docstring.""" + ... + + @property + def IsDoseValid(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsTreated(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @Name.setter + def Name(self, value: str) -> None: + """Set property value.""" + ... + + @property + def NumberOfFractions(self) -> Optional[int]: + """Optional[int]: Property docstring.""" + ... + + @property + def OptimizationSetup(self) -> OptimizationSetup: + """OptimizationSetup: Property docstring.""" + ... + + @property + def PatientSupportDevice(self) -> PatientSupportDevice: + """PatientSupportDevice: Property docstring.""" + ... + + @property + def PhotonCalculationModel(self) -> str: + """str: Property docstring.""" + ... + + @property + def PhotonCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: Property docstring.""" + ... + + @property + def PlanIntent(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanIsInTreatment(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def PlanNormalizationMethod(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanNormalizationPoint(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def PlanNormalizationValue(self) -> float: + """float: Property docstring.""" + ... + + @PlanNormalizationValue.setter + def PlanNormalizationValue(self, value: float) -> None: + """Set property value.""" + ... + + @property + def PlanObjectiveStructures(self) -> List[str]: + """List[str]: Property docstring.""" + ... + + @property + def PlanType(self) -> PlanType: + """PlanType: Property docstring.""" + ... + + @property + def PlanUncertainties(self) -> List[PlanUncertainty]: + """List[PlanUncertainty]: Property docstring.""" + ... + + @property + def PlannedDosePerFraction(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def PlanningApprovalDate(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanningApprover(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanningApproverDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def PredecessorPlan(self) -> PlanSetup: + """PlanSetup: Property docstring.""" + ... + + @property + def PredecessorPlanUID(self) -> str: + """str: Property docstring.""" + ... + + @property + def PrescribedDosePerFraction(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def PrescribedPercentage(self) -> float: + """float: Property docstring.""" + ... + + @property + def PrimaryReferencePoint(self) -> ReferencePoint: + """ReferencePoint: Property docstring.""" + ... + + @property + def ProtocolID(self) -> str: + """str: Property docstring.""" + ... + + @property + def ProtocolPhaseID(self) -> str: + """str: Property docstring.""" + ... + + @property + def ProtonCalculationModel(self) -> str: + """str: Property docstring.""" + ... + + @property + def ProtonCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: Property docstring.""" + ... + + @property + def RTPrescription(self) -> RTPrescription: + """RTPrescription: Property docstring.""" + ... + + @property + def ReferencePoints(self) -> List[ReferencePoint]: + """List[ReferencePoint]: Property docstring.""" + ... + + @property + def Series(self) -> Series: + """Series: Property docstring.""" + ... + + @property + def SeriesUID(self) -> str: + """str: Property docstring.""" + ... + + @property + def StructureSet(self) -> StructureSet: + """StructureSet: Property docstring.""" + ... + + @property + def StructuresSelectedForDvh(self) -> List[Structure]: + """List[Structure]: Property docstring.""" + ... + + @property + def TargetVolumeID(self) -> str: + """str: Property docstring.""" + ... + + @property + def TotalDose(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def TotalPrescribedDose(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def TradeoffExplorationContext(self) -> TradeoffExplorationContext: + """TradeoffExplorationContext: [Availability of this property depends on your Eclipse Scripting API license] Gets the""" + ... + + @property + def TreatmentApprovalDate(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentApprover(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentApproverDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentOrientation(self) -> PatientOrientation: + """PatientOrientation: Property docstring.""" + ... + + @property + def TreatmentOrientationAsString(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentPercentage(self) -> float: + """float: Property docstring.""" + ... + + @property + def TreatmentSessions(self) -> List[PlanTreatmentSession]: + """List[PlanTreatmentSession]: Property docstring.""" + ... + + @property + def UID(self) -> str: + """str: Property docstring.""" + ... + + @property + def UseGating(self) -> bool: + """bool: Property docstring.""" + ... + + @UseGating.setter + def UseGating(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def VerifiedPlan(self) -> PlanSetup: + """PlanSetup: Property docstring.""" + ... + + def AddArcBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddConformalArcBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, controlPointCount: int, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddFixedSequenceBeam(self, machineParameters: ExternalBeamMachineParameters, collimatorAngle: float, gantryAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddImagingSetup(self, machineParameters: ExternalBeamMachineParameters, setupParameters: ImagingBeamSetupParameters, targetStructure: Structure) -> bool: + """Method docstring.""" + ... + + def AddMLCArcBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddMLCBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddMLCSetupBeam(self, machineParameters: ExternalBeamMachineParameters, leafPositions: Array[float], jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddMultipleStaticSegmentBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: + """Method docstring.""" + ... + + def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: + """Method docstring.""" + ... + + @overload + def AddReferencePoint(self, refPoint: ReferencePoint) -> None: + """Method docstring.""" + ... + + def AddSetupBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddSlidingWindowBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddSlidingWindowBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddStaticBeam(self, machineParameters: ExternalBeamMachineParameters, jawPositions: VRect[float], collimatorAngle: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddVMATBeam(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryAngle: float, gantryStop: float, gantryDirection: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddVMATBeamForFixedJaws(self, machineParameters: ExternalBeamMachineParameters, metersetWeights: List[float], collimatorAngle: float, gantryStartAngle: float, gantryStopAngle: float, gantryDir: GantryDirection, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """Method docstring.""" + ... + + def CalculateDose(self) -> CalculationResult: + """[Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the plan. + + Returns: + CalculationResult: The calculation result. See calculation details from""" + ... + + def CalculateDoseWithPresetValues(self, presetValues: List[KeyValuePair[str, MetersetValue]]) -> CalculationResult: + """Method docstring.""" + ... + + def CalculateLeafMotions(self) -> CalculationResult: + """[Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. + + Returns: + CalculationResult: The calculation result. See calculation details from""" + ... + + @overload + def CalculateLeafMotions(self, options: LMCVOptions) -> CalculationResult: + """[Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. + + Returns: + CalculationResult: The calculation result. See calculation details from""" + ... + + @overload + def CalculateLeafMotions(self, options: SmartLMCOptions) -> CalculationResult: + """[Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. + + Returns: + CalculationResult: The calculation result. See calculation details from""" + ... + + @overload + def CalculateLeafMotions(self, options: LMCMSSOptions) -> CalculationResult: + """[Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. + + Returns: + CalculationResult: The calculation result. See calculation details from""" + ... + + def CalculateLeafMotionsAndDose(self) -> CalculationResult: + """Calculate leaf motions and dose using the calculation models defined in the plan setup. + + Returns: + CalculationResult: Result of the intermediate dose calculation.""" + ... + + def CalculatePlanUncertaintyDoses(self) -> CalculationResult: + """[Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the photon plan. + + Returns: + CalculationResult: The calculation result. See calculation details in""" + ... + + def ClearCalculationModel(self, calculationType: CalculationType) -> None: + """Method docstring.""" + ... + + def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: + """Method docstring.""" + ... + + def CreateEvaluationDose(self) -> EvaluationDose: + """[Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the + + Saving modifications to the database is not possible if the evaluation dose has been created but voxels have not been set. + + Returns: + EvaluationDose: A new evaluation dose object.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetCalculationModel(self, calculationType: CalculationType) -> str: + """Method docstring.""" + ... + + def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """Method docstring.""" + ... + + def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: + """Method docstring.""" + ... + + def GetClinicalGoals(self) -> List[ClinicalGoal]: + """Method docstring.""" + ... + + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """Method docstring.""" + ... + + def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: + """Method docstring.""" + ... + + def GetDvhEstimationModelName(self) -> str: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: + """Method docstring.""" + ... + + def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List, measures: List) -> None: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: + """Method docstring.""" + ... + + def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: + """Method docstring.""" + ... + + def IsValidForPlanApproval(self, validationResults: List) -> bool: + """Method docstring.""" + ... + + def MoveToCourse(self, destinationCourse: Course) -> None: + """Method docstring.""" + ... + + def Optimize(self, maxIterations: int) -> OptimizerResult: + """Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + + Returns: + OptimizerResult: The result of the optimization.""" + ... + + @overload + def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption) -> OptimizerResult: + """Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + + Returns: + OptimizerResult: The result of the optimization.""" + ... + + @overload + def Optimize(self, maxIterations: int, optimizationOption: OptimizationOption, mlcId: str) -> OptimizerResult: + """Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + + Returns: + OptimizerResult: The result of the optimization.""" + ... + + @overload + def Optimize(self) -> OptimizerResult: + """Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + + Returns: + OptimizerResult: The result of the optimization.""" + ... + + @overload + def Optimize(self, options: OptimizationOptionsIMRT) -> OptimizerResult: + """Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + + Returns: + OptimizerResult: The result of the optimization.""" + ... + + def OptimizeVMAT(self, mlcId: str) -> OptimizerResult: + """[Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + + Returns: + OptimizerResult: The result of the optimization.""" + ... + + @overload + def OptimizeVMAT(self) -> OptimizerResult: + """[Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + + Returns: + OptimizerResult: The result of the optimization.""" + ... + + @overload + def OptimizeVMAT(self, options: OptimizationOptionsVMAT) -> OptimizerResult: + """[Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization. + + Returns: + OptimizerResult: The result of the optimization.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemoveBeam(self, beam: Beam) -> None: + """Method docstring.""" + ... + + def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: + """Method docstring.""" + ... + + def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: + """Method docstring.""" + ... + + def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """Method docstring.""" + ... + + def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: + """Method docstring.""" + ... + + def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: StringBuilder) -> bool: + """Method docstring.""" + ... + + def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class FieldReferencePoint(ApiDataObject): + """This object links a treatment beam to a reference point.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def EffectiveDepth(self) -> float: + """float: The effective depth of the field reference point. For arc fields this is the average value over the span of the arc.""" + ... + + @property + def FieldDose(self) -> DoseValue: + """DoseValue: The field dose.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def IsFieldDoseNominal(self) -> bool: + """bool: Checks if the field dose is nominal (the real calculated field dose is not known). If the field doses at a reference point are nominal, they alone cannot be used to verify MU calculation.""" + ... + + @property + def IsPrimaryReferencePoint(self) -> bool: + """bool: Checks if the reference point is primary.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def RefPointLocation(self) -> VVector: + """VVector: The location of the reference point.""" + ... + + @property + def ReferencePoint(self) -> ReferencePoint: + """ReferencePoint: Used for navigating to an underlying reference point.""" + ... + + @property + def SSD(self) -> float: + """float: The Source-to-Skin Distance (SSD) of the reference point. For arc fields this is the average value over the span of the arc.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Globals: + """This class is internal to the Eclipse Scripting API.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @classmethod + @property + def AbortNow(cls) -> bool: + """bool: The flag that aborts script execution the next time any property or method of the Eclipse Scripting API is accessed.""" + ... + + @classmethod + @AbortNow.setter + def AbortNow(cls, value: bool) -> None: + """Set property value.""" + ... + + @classmethod + @property + def DefaultMaximumNumberOfLoggedApiCalls(cls) -> int: + """int: The default maximum number of API calls that are saved in the script execution log.""" + ... + + @staticmethod + def AddCustomLogEntry(message: str, logSeverity: LogSeverity) -> None: + """Method docstring.""" + ... + + @staticmethod + def DisableApiAccessTrace() -> None: + """Disables the getting of access information for API members through .NET trace listener.""" + ... + + @staticmethod + def EnableApiAccessTrace() -> None: + """Enables the getting of access information for API members through .NET trace listener.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + @staticmethod + def GetLoggedApiCalls() -> List[str]: + """Returns the last called properties and methods. The oldest cached call is the first. The maximum number of logged calls is set by calling SetMaximumNumberOfLoggedApiCalls. + + Returns: + List[str]: The called API properties and methods as saved in the cache.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + @staticmethod + def Initialize(logger: ILogger, executingAssemblyName: AssemblyName) -> None: + """Method docstring.""" + ... + + @staticmethod + def SetMaximumNumberOfLoggedApiCalls(apiLogCacheSize: int) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Hospital(ApiDataObject): + """Represents a hospital.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The date when this object was created.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Location(self) -> str: + """str: The location of the hospital.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class IDVHEstimationCalculator: + """Interface to the calculation of the DVH Estimates""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """Method docstring.""" + ... + + +class Image(ApiDataObject): + """Represents a 2D or 3D image, which can be a DRR, a CT, MR, or other volumetric dataset.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApprovalHistory(self) -> List[ImageApprovalHistoryEntry]: + """List[ImageApprovalHistoryEntry]: Returns the approval history of the image.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def ContrastBolusAgentIngredientName(self) -> str: + """str: The name of the contrast bolus agent ingredient that is used in the image. If the value has not been specified, returns null.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The date when this object was created.""" + ... + + @property + def DisplayUnit(self) -> str: + """str: The name of the display unit in which the voxels of the image are shown in the user interface.""" + ... + + @property + def FOR(self) -> str: + """str: The UID of the frame of reference.""" + ... + + @property + def HasUserOrigin(self) -> bool: + """bool: Defines if a user origin has been specified for the image.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The identifier of the image.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def ImageType(self) -> str: + """str: The type of the image as indicated in the properties of the image slices.""" + ... + + @property + def ImagingDeviceId(self) -> str: + """str: Identification of the device that is used to scan the images into the system.""" + ... + + @property + def ImagingOrientation(self) -> PatientOrientation: + """PatientOrientation: The orientation of the patient.""" + ... + + @property + def ImagingOrientationAsString(self) -> str: + """str: The orientation of the patient as a string (localized)""" + ... + + @property + def IsProcessed(self) -> bool: + """bool: Returns the value true if an image processing filter is in use for the image.""" + ... + + @property + def Level(self) -> int: + """int: The level setting. The value is given in the internal voxel scale.""" + ... + + @property + def Modality(self) -> SeriesModality: + """SeriesModality: The modality of the image as indicated in the properties of the image slices.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Origin(self) -> VVector: + """VVector: The origin of the image. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first image plane. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs.""" + ... + + @property + def Series(self) -> Series: + """Series: Used for navigating to parent series.""" + ... + + @property + def UID(self) -> str: + """str: Return UID of the first (and the only) slice in case of a 2D Image. Return null in case of a 3D Image.""" + ... + + @property + def UserOrigin(self) -> VVector: + """VVector: The user origin in DICOM coordinates in millimeter.""" + ... + + @UserOrigin.setter + def UserOrigin(self, value: VVector) -> None: + """Set property value.""" + ... + + @property + def UserOriginComments(self) -> str: + """str: The text typed on the Origin tab in the Image Properties dialog box.""" + ... + + @property + def Window(self) -> int: + """int: The window setting. The value is given in the internal voxel scale.""" + ... + + @property + def XDirection(self) -> VVector: + """VVector: The direction of the x-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs.""" + ... + + @property + def XRes(self) -> float: + """float: The image resolution in X-direction in millimeters.""" + ... + + @property + def XSize(self) -> int: + """int: The image size in X-direction in voxels.""" + ... + + @property + def YDirection(self) -> VVector: + """VVector: The direction of the y-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs.""" + ... + + @property + def YRes(self) -> float: + """float: The image resolution in Y-direction in millimeters.""" + ... + + @property + def YSize(self) -> int: + """int: The image size in Y-direction in voxels.""" + ... + + @property + def ZDirection(self) -> VVector: + """VVector: The direction of the z-axis in the image. Supported only for volume images. For other types of images, the return value is a vector of Double.NaNs.""" + ... + + @property + def ZRes(self) -> float: + """float: The image resolution in Z-direction in millimeters.""" + ... + + @property + def ZSize(self) -> int: + """int: The image size in Z-direction in voxels.""" + ... + + def CalculateDectProtonStoppingPowers(self, rhoImage: Image, zImage: Image, planeIndex: int, preallocatedBuffer: Array[float]) -> None: + """Method docstring.""" + ... + + def CreateNewStructureSet(self) -> StructureSet: + """[Availability of this method depends on your Eclipse Scripting API license] Creates a new structure set. If the image does not yet have a structure set, the new structure set will be assigned directly to it. If the image already has a structure set, a copy of this image is made, and the new structure set is assigned to the copy. The image must be a 3D image. + + Returns: + StructureSet: New structure set.""" + ... + + def DicomToUser(self, dicom: VVector, planSetup: PlanSetup) -> VVector: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetImageProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> ImageProfile: + """Method docstring.""" + ... + + def GetProtonStoppingPowerCurve(self, protonStoppingPowerCurve: List[float]) -> bool: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def UserToDicom(self, user: VVector, planSetup: PlanSetup) -> VVector: + """Method docstring.""" + ... + + def VoxelToDisplayValue(self, voxelValue: int) -> float: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class IonBeam(Beam): + """Proton beam interface.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def AirGap(self) -> float: + """float: The user-defined air gap in mm.""" + ... + + @property + def Applicator(self) -> Applicator: + """Applicator: Property docstring.""" + ... + + @property + def ArcLength(self) -> float: + """float: Property docstring.""" + ... + + @property + def AreControlPointJawsMoving(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def AverageSSD(self) -> float: + """float: Property docstring.""" + ... + + @property + def BeamLineStatus(self) -> ProtonBeamLineStatus: + """ProtonBeamLineStatus: Determine beamline's status""" + ... + + @property + def BeamNumber(self) -> int: + """int: Property docstring.""" + ... + + @property + def BeamTechnique(self) -> BeamTechnique: + """BeamTechnique: Property docstring.""" + ... + + @property + def Blocks(self) -> List[Block]: + """List[Block]: Property docstring.""" + ... + + @property + def Boluses(self) -> List[Bolus]: + """List[Bolus]: Property docstring.""" + ... + + @property + def CalculationLogs(self) -> List[BeamCalculationLog]: + """List[BeamCalculationLog]: Property docstring.""" + ... + + @property + def CollimatorRotation(self) -> float: + """float: Property docstring.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @Comment.setter + def Comment(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Compensator(self) -> Compensator: + """Compensator: Property docstring.""" + ... + + @property + def ControlPoints(self) -> ControlPointCollection: + """ControlPointCollection: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def DistalTargetMargin(self) -> float: + """float: Distal end margin, in mm.""" + ... + + @DistalTargetMargin.setter + def DistalTargetMargin(self, value: float) -> None: + """Set property value.""" + ... + + @property + def Dose(self) -> BeamDose: + """BeamDose: Property docstring.""" + ... + + @property + def DoseRate(self) -> int: + """int: Property docstring.""" + ... + + @property + def DosimetricLeafGap(self) -> float: + """float: Property docstring.""" + ... + + @property + def EnergyMode(self) -> EnergyMode: + """EnergyMode: Property docstring.""" + ... + + @property + def EnergyModeDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def FieldReferencePoints(self) -> List[FieldReferencePoint]: + """List[FieldReferencePoint]: Property docstring.""" + ... + + @property + def GantryDirection(self) -> GantryDirection: + """GantryDirection: Property docstring.""" + ... + + @property + def HasAllMLCLeavesClosed(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def IonControlPoints(self) -> IonControlPointCollection: + """IonControlPointCollection: Gets the proton control points.""" + ... + + @property + def IsGantryExtended(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsGantryExtendedAtStopAngle(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsIMRT(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsImagingTreatmentField(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsSetupField(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsocenterPosition(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def LateralMargins(self) -> VRect[float]: + """VRect[float]: The lateral margins of this field, in mm.""" + ... + + @LateralMargins.setter + def LateralMargins(self, value: VRect[float]) -> None: + """Set property value.""" + ... + + @property + def LateralSpreadingDevices(self) -> List[LateralSpreadingDevice]: + """List[LateralSpreadingDevice]: The lateral spreading devices in this beam.""" + ... + + @property + def MLC(self) -> MLC: + """MLC: Property docstring.""" + ... + + @property + def MLCPlanType(self) -> MLCPlanType: + """MLCPlanType: Property docstring.""" + ... + + @property + def MLCTransmissionFactor(self) -> float: + """float: Property docstring.""" + ... + + @property + def Meterset(self) -> MetersetValue: + """MetersetValue: Property docstring.""" + ... + + @property + def MetersetPerGy(self) -> float: + """float: Property docstring.""" + ... + + @property + def MotionCompensationTechnique(self) -> str: + """str: Property docstring.""" + ... + + @property + def MotionSignalSource(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @Name.setter + def Name(self, value: str) -> None: + """Set property value.""" + ... + + @property + def NominalRange(self) -> float: + """float: The nominal range of the beam line, in mm.""" + ... + + @property + def NominalSOBPWidth(self) -> float: + """float: The nominal width of the Spread Out Bragg Peak, in mm.""" + ... + + @property + def NormalizationFactor(self) -> float: + """float: Property docstring.""" + ... + + @property + def NormalizationMethod(self) -> str: + """str: Property docstring.""" + ... + + @property + def OptionId(self) -> str: + """str: The identifier of the selected beam-line setting for proton beams. For a typical double scattering system, for example, an option is a combination of range modulator, second scatterer, and nominal energy that correspond to a broad proton beam with a certain range in patient and field size. Returns null if the option is undefined.""" + ... + + @property + def PatientSupportId(self) -> str: + """str: Patient support identifier. Returns null if undefined.""" + ... + + @property + def PatientSupportType(self) -> PatientSupportType: + """PatientSupportType: Patient support type.""" + ... + + @property + def Plan(self) -> PlanSetup: + """PlanSetup: Property docstring.""" + ... + + @property + def PlannedSSD(self) -> float: + """float: Property docstring.""" + ... + + @property + def ProximalTargetMargin(self) -> float: + """float: Proximal end margin, in mm.""" + ... + + @ProximalTargetMargin.setter + def ProximalTargetMargin(self, value: float) -> None: + """Set property value.""" + ... + + @property + def RangeModulators(self) -> List[RangeModulator]: + """List[RangeModulator]: The range modulator devices in this beam.""" + ... + + @property + def RangeShifters(self) -> List[RangeShifter]: + """List[RangeShifter]: The range shifter devices in this beam.""" + ... + + @property + def ReferenceImage(self) -> Image: + """Image: Property docstring.""" + ... + + @property + def SSD(self) -> float: + """float: Property docstring.""" + ... + + @property + def SSDAtStopAngle(self) -> float: + """float: Property docstring.""" + ... + + @property + def ScanMode(self) -> IonBeamScanMode: + """IonBeamScanMode: The method of beam scanning to be used during treatment.""" + ... + + @property + def SetupNote(self) -> str: + """str: Property docstring.""" + ... + + @SetupNote.setter + def SetupNote(self, value: str) -> None: + """Set property value.""" + ... + + @property + def SetupTechnique(self) -> SetupTechnique: + """SetupTechnique: Property docstring.""" + ... + + @property + def SnoutId(self) -> str: + """str: The Snout identifier. Returns null if undefined.""" + ... + + @property + def SnoutPosition(self) -> float: + """float: The snout position in cm. Returns System::Double::NaN if undefined.""" + ... + + @property + def TargetStructure(self) -> Structure: + """Structure: Returns the field target structure. Null if the field target is not defined (and axial margins are defined around the isocenter level).""" + ... + + @property + def Technique(self) -> Technique: + """Technique: Property docstring.""" + ... + + @property + def ToleranceTableLabel(self) -> str: + """str: Property docstring.""" + ... + + @property + def Trays(self) -> List[Tray]: + """List[Tray]: Property docstring.""" + ... + + @property + def TreatmentTime(self) -> float: + """float: Property docstring.""" + ... + + @property + def TreatmentUnit(self) -> ExternalBeamTreatmentUnit: + """ExternalBeamTreatmentUnit: Property docstring.""" + ... + + @property + def VirtualSADX(self) -> float: + """float: Virtual Source-to-Axis Distance X, in mm.""" + ... + + @property + def VirtualSADY(self) -> float: + """float: Virtual Source-to-Axis Distance Y, in mm.""" + ... + + @property + def Wedges(self) -> List[Wedge]: + """List[Wedge]: Property docstring.""" + ... + + @property + def WeightFactor(self) -> float: + """float: Property docstring.""" + ... + + def AddBolus(self, bolus: Bolus) -> None: + """Method docstring.""" + ... + + @overload + def AddBolus(self, bolusId: str) -> None: + """Method docstring.""" + ... + + def AddFlatteningSequence(self) -> bool: + """Method docstring.""" + ... + + def ApplyParameters(self, beamParams: BeamParameters) -> None: + """Method docstring.""" + ... + + @overload + def ApplyParameters(self, beamParams: BeamParameters) -> None: + """Method docstring.""" + ... + + def CalculateAverageLeafPairOpenings(self) -> Dict[int, float]: + """Method docstring.""" + ... + + def CanSetOptimalFluence(self, fluence: Fluence, message: str) -> bool: + """Method docstring.""" + ... + + def CollimatorAngleToUser(self, val: float) -> float: + """Method docstring.""" + ... + + def CountSubfields(self) -> int: + """Method docstring.""" + ... + + def CreateOrReplaceDRR(self, parameters: DRRCalculationParameters) -> Image: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def FitCollimatorToStructure(self, margins: FitToStructureMargins, structure: Structure, useAsymmetricXJaws: bool, useAsymmetricYJaws: bool, optimizeCollimatorRotation: bool) -> None: + """Method docstring.""" + ... + + def FitMLCToOutline(self, outline: Array[Array[Point]]) -> None: + """Method docstring.""" + ... + + @overload + def FitMLCToOutline(self, outline: Array[Array[Point]], optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """Method docstring.""" + ... + + def FitMLCToStructure(self, structure: Structure) -> None: + """Method docstring.""" + ... + + @overload + def FitMLCToStructure(self, margins: FitToStructureMargins, structure: Structure, optimizeCollimatorRotation: bool, jawFit: JawFitting, olmp: OpenLeavesMeetingPoint, clmp: ClosedLeavesMeetingPoint) -> None: + """Method docstring.""" + ... + + def GantryAngleToUser(self, val: float) -> float: + """Method docstring.""" + ... + + def GetCAXPathLengthInBolus(self, bolus: Bolus) -> float: + """Method docstring.""" + ... + + def GetDeliveryTimeStatusByRoomId(self, roomId: str) -> ProtonDeliveryTimeStatus: + """Method docstring.""" + ... + + def GetEditableParameters(self) -> IonBeamParameters: + """Returns a new editable copy of the ion beam parameters. The returned IonBeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another IonBeamParameters object. + + Returns: + IonBeamParameters: Returns a new parameters object. Its values are copied from the corresponding properties of this object.""" + ... + + @overload + def GetEditableParameters(self) -> BeamParameters: + """Returns a new editable copy of the ion beam parameters. The returned IonBeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another IonBeamParameters object. + + Returns: + BeamParameters: Returns a new parameters object. Its values are copied from the corresponding properties of this object.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetOptimalFluence(self) -> Fluence: + """Method docstring.""" + ... + + def GetProtonDeliveryTimeByRoomIdAsNumber(self, roomId: str) -> float: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetSourceLocation(self, gantryAngle: float) -> VVector: + """Method docstring.""" + ... + + def GetSourceToBolusDistance(self, bolus: Bolus) -> float: + """Method docstring.""" + ... + + def GetStructureOutlines(self, structure: Structure, inBEV: bool) -> Array[Array[Point]]: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def JawPositionsToUserString(self, val: VRect[float]) -> str: + """Method docstring.""" + ... + + def PatientSupportAngleToUser(self, val: float) -> float: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemoveBolus(self, bolus: Bolus) -> bool: + """Method docstring.""" + ... + + @overload + def RemoveBolus(self, bolusId: str) -> bool: + """Method docstring.""" + ... + + def RemoveFlatteningSequence(self) -> bool: + """Method docstring.""" + ... + + def SetOptimalFluence(self, fluence: Fluence) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class IonBeamParameters(BeamParameters): + """An editable copy of the parameters of a proton beam. + + To apply the parameters, call the""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ControlPoints(self) -> List[ControlPointParameters]: + """List[ControlPointParameters]: Editable control point parameters copied from the treatment beam.""" + ... + + @property + def GantryDirection(self) -> GantryDirection: + """GantryDirection: Property docstring.""" + ... + + @property + def IonControlPointPairs(self) -> IonControlPointPairCollection: + """IonControlPointPairCollection: A copy of editable control point pairs.""" + ... + + @property + def Isocenter(self) -> VVector: + """VVector: Property docstring.""" + ... + + @Isocenter.setter + def Isocenter(self, value: VVector) -> None: + """Set property value.""" + ... + + @property + def PreSelectedRangeShifter1Id(self) -> str: + """str: ID of the pre-selected range shifter 1 in the field.""" + ... + + @PreSelectedRangeShifter1Id.setter + def PreSelectedRangeShifter1Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def PreSelectedRangeShifter1Setting(self) -> str: + """str: Setting of the pre-selected range shifter 1 in the field.""" + ... + + @PreSelectedRangeShifter1Setting.setter + def PreSelectedRangeShifter1Setting(self, value: str) -> None: + """Set property value.""" + ... + + @property + def PreSelectedRangeShifter2Id(self) -> str: + """str: ID of the pre-selected range shifter 2 in the field.""" + ... + + @PreSelectedRangeShifter2Id.setter + def PreSelectedRangeShifter2Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def PreSelectedRangeShifter2Setting(self) -> str: + """str: Setting of the pre-selected range shifter 2 in the field.""" + ... + + @PreSelectedRangeShifter2Setting.setter + def PreSelectedRangeShifter2Setting(self, value: str) -> None: + """Set property value.""" + ... + + @property + def SnoutId(self) -> str: + """str: The snout identifier. Returns null if undefined.""" + ... + + @property + def SnoutPosition(self) -> float: + """float: Snout position in centimeters.""" + ... + + @property + def TargetStructure(self) -> Structure: + """Structure: Target structure of the field.""" + ... + + @TargetStructure.setter + def TargetStructure(self, value: Structure) -> None: + """Set property value.""" + ... + + @property + def WeightFactor(self) -> float: + """float: Property docstring.""" + ... + + @WeightFactor.setter + def WeightFactor(self, value: float) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def SetAllLeafPositions(self, leafPositions: Array[float]) -> None: + """Method docstring.""" + ... + + def SetJawPositions(self, positions: VRect[float]) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class IonControlPoint(ControlPoint): + """Proton control point interface.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Beam(self) -> Beam: + """Beam: Property docstring.""" + ... + + @property + def CollimatorAngle(self) -> float: + """float: Property docstring.""" + ... + + @property + def FinalSpotList(self) -> IonSpotCollection: + """IonSpotCollection: Gets a cached copy of the post-processed final spot list.""" + ... + + @property + def GantryAngle(self) -> float: + """float: Property docstring.""" + ... + + @property + def Index(self) -> int: + """int: Property docstring.""" + ... + + @property + def JawPositions(self) -> VRect[float]: + """VRect[float]: Property docstring.""" + ... + + @property + def LateralSpreadingDeviceSettings(self) -> List[LateralSpreadingDeviceSettings]: + """List[LateralSpreadingDeviceSettings]: The lateral spreading device settings.""" + ... + + @property + def LeafPositions(self) -> Array[float]: + """Array[float]: Property docstring.""" + ... + + @property + def MetersetWeight(self) -> float: + """float: Property docstring.""" + ... + + @property + def NominalBeamEnergy(self) -> float: + """float: Nominal beam energy, in megavolts.""" + ... + + @property + def NumberOfPaintings(self) -> int: + """int: The number of times the scan pattern shall be applied at the current control point.""" + ... + + @property + def PatientSupportAngle(self) -> float: + """float: Property docstring.""" + ... + + @property + def RangeModulatorSettings(self) -> List[RangeModulatorSettings]: + """List[RangeModulatorSettings]: The range modulator settings.""" + ... + + @property + def RangeShifterSettings(self) -> List[RangeShifterSettings]: + """List[RangeShifterSettings]: The range shifter settings.""" + ... + + @property + def RawSpotList(self) -> IonSpotCollection: + """IonSpotCollection: Gets a cached copy of the raw spot list.""" + ... + + @property + def ScanSpotTuneId(self) -> str: + """str: User-supplied or machine code identifier for machine configuration to produce beam spot. This may be the nominal spot size or some other machine-specific value. Returns null if undefined.""" + ... + + @property + def ScanningSpotSizeX(self) -> float: + """float: The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY X direction (mm).""" + ... + + @property + def ScanningSpotSizeY(self) -> float: + """float: The scanning spot size as calculated using the Full Width HalfMaximum (FWHM). The size is measured in air at isocenter in IEC GANTRY Y direction (mm).""" + ... + + @property + def SnoutPosition(self) -> float: + """float: The snout position, in mm.""" + ... + + @property + def TableTopLateralPosition(self) -> float: + """float: Property docstring.""" + ... + + @property + def TableTopLongitudinalPosition(self) -> float: + """float: Property docstring.""" + ... + + @property + def TableTopVerticalPosition(self) -> float: + """float: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class IonControlPointCollection(SerializableObject): + """Represents a collection of machine parameters that describe the planned proton beam.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: The number of control points in the collection.""" + ... + + @property + def Item(self) -> IonControlPoint: + """IonControlPoint: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator[IonControlPoint]: + """Retrieves enumerator for IonControlPoints in the collection. + + Returns: + IEnumerator[IonControlPoint]: Enumerator for IonControlPoints in the collection.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class IonControlPointPair: + """An editable copy of a control point pair (the pair of the start control point with an even index, and the end control point with an odd index). + + To apply the parameters, call the""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def EndControlPoint(self) -> IonControlPointParameters: + """IonControlPointParameters: The end control point in the pair, with an odd index.""" + ... + + @property + def FinalSpotList(self) -> IonSpotParametersCollection: + """IonSpotParametersCollection: Gets a cached copy of the editable post-processed final spot list.""" + ... + + @property + def NominalBeamEnergy(self) -> float: + """float: Nominal beam energy in megavolts.""" + ... + + @property + def RawSpotList(self) -> IonSpotParametersCollection: + """IonSpotParametersCollection: Gets a cached copy of the editable raw spot list""" + ... + + @property + def StartControlPoint(self) -> IonControlPointParameters: + """IonControlPointParameters: Start control point in the pair, with an even index from zero.""" + ... + + @property + def StartIndex(self) -> int: + """int: The index of the start control point in the pair. The index should be an even number starting from zero.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ResizeFinalSpotList(self, count: int) -> None: + """Method docstring.""" + ... + + def ResizeRawSpotList(self, count: int) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class IonControlPointPairCollection: + """A collection of editable copies of control point pairs that describe the planned proton beam. + + To apply the parameters, call the""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: The number of control point pairs in the collection.""" + ... + + @property + def Item(self) -> IonControlPointPair: + """IonControlPointPair: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator[IonControlPointPair]: + """Retrieves enumerator for IonControlPointPairs in the collection. + + Returns: + IEnumerator[IonControlPointPair]: Enumerator for IonControlPointPairs in the collection.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class IonControlPointParameters(ControlPointParameters): + """An editable copy of the parameters of a proton control point. + + To apply the parameters, call the ApplyParameters method of the Beam class. Because the parameters are simple copies, they do not reflect the current state of the data model.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def CollimatorAngle(self) -> float: + """float: Property docstring.""" + ... + + @property + def FinalSpotList(self) -> IonSpotParametersCollection: + """IonSpotParametersCollection: Gets a cached copy of the post-processed final spot list.""" + ... + + @property + def GantryAngle(self) -> float: + """float: Property docstring.""" + ... + + @GantryAngle.setter + def GantryAngle(self, value: float) -> None: + """Set property value.""" + ... + + @property + def Index(self) -> int: + """int: Property docstring.""" + ... + + @property + def JawPositions(self) -> VRect[float]: + """VRect[float]: Property docstring.""" + ... + + @JawPositions.setter + def JawPositions(self, value: VRect[float]) -> None: + """Set property value.""" + ... + + @property + def LeafPositions(self) -> Array[float]: + """Array[float]: Property docstring.""" + ... + + @LeafPositions.setter + def LeafPositions(self, value: Array[float]) -> None: + """Set property value.""" + ... + + @property + def MetersetWeight(self) -> float: + """float: Property docstring.""" + ... + + @MetersetWeight.setter + def MetersetWeight(self, value: float) -> None: + """Set property value.""" + ... + + @property + def PatientSupportAngle(self) -> float: + """float: Property docstring.""" + ... + + @property + def RawSpotList(self) -> IonSpotParametersCollection: + """IonSpotParametersCollection: Gets a cached copy of the raw spot list.""" + ... + + @property + def SnoutPosition(self) -> float: + """float: Snout position in centimeters.""" + ... + + @SnoutPosition.setter + def SnoutPosition(self, value: float) -> None: + """Set property value.""" + ... + + @property + def TableTopLateralPosition(self) -> float: + """float: Property docstring.""" + ... + + @property + def TableTopLongitudinalPosition(self) -> float: + """float: Property docstring.""" + ... + + @property + def TableTopVerticalPosition(self) -> float: + """float: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class IonPlanSetup(PlanSetup): + """Represents a proton treatment plan.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApplicationScriptLogs(self) -> List[ApplicationScriptLog]: + """List[ApplicationScriptLog]: Property docstring.""" + ... + + @property + def ApprovalHistory(self) -> List[ApprovalHistoryEntry]: + """List[ApprovalHistoryEntry]: Property docstring.""" + ... + + @property + def ApprovalStatus(self) -> PlanSetupApprovalStatus: + """PlanSetupApprovalStatus: Property docstring.""" + ... + + @property + def ApprovalStatusAsString(self) -> str: + """str: Property docstring.""" + ... + + @property + def BaseDosePlanningItem(self) -> PlanningItem: + """PlanningItem: Property docstring.""" + ... + + @BaseDosePlanningItem.setter + def BaseDosePlanningItem(self, value: PlanningItem) -> None: + """Set property value.""" + ... + + @property + def Beams(self) -> List[Beam]: + """List[Beam]: Property docstring.""" + ... + + @property + def BeamsInTreatmentOrder(self) -> List[Beam]: + """List[Beam]: Property docstring.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @Comment.setter + def Comment(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Course(self) -> Course: + """Course: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def CreationUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def DVHEstimates(self) -> List[EstimatedDVH]: + """List[EstimatedDVH]: Property docstring.""" + ... + + @property + def Dose(self) -> PlanningItemDose: + """PlanningItemDose: Property docstring.""" + ... + + @property + def DoseAsEvaluationDose(self) -> EvaluationDose: + """EvaluationDose: The evaluation dose is connected to the plan and contains voxels that are set by""" + ... + + @property + def DosePerFraction(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def DosePerFractionInPrimaryRefPoint(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def DoseValuePresentation(self) -> DoseValuePresentation: + """DoseValuePresentation: Property docstring.""" + ... + + @DoseValuePresentation.setter + def DoseValuePresentation(self, value: DoseValuePresentation) -> None: + """Set property value.""" + ... + + @property + def ElectronCalculationModel(self) -> str: + """str: Property docstring.""" + ... + + @property + def ElectronCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def IntegrityHash(self) -> str: + """str: Property docstring.""" + ... + + @property + def IonBeams(self) -> List[IonBeam]: + """List[IonBeam]: Gets the proton beams of the plan.""" + ... + + @property + def IsDoseValid(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def IsPostProcessingNeeded(self) -> bool: + """bool: Instructs whether to include the post-processing of scanning spots in proton dose calculation.""" + ... + + @IsPostProcessingNeeded.setter + def IsPostProcessingNeeded(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def IsTreated(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @Name.setter + def Name(self, value: str) -> None: + """Set property value.""" + ... + + @property + def NumberOfFractions(self) -> Optional[int]: + """Optional[int]: Property docstring.""" + ... + + @property + def OptimizationSetup(self) -> OptimizationSetup: + """OptimizationSetup: Property docstring.""" + ... + + @property + def PatientSupportDevice(self) -> PatientSupportDevice: + """PatientSupportDevice: Property docstring.""" + ... + + @property + def PhotonCalculationModel(self) -> str: + """str: Property docstring.""" + ... + + @property + def PhotonCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: Property docstring.""" + ... + + @property + def PlanIntent(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanIsInTreatment(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def PlanNormalizationMethod(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanNormalizationPoint(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def PlanNormalizationValue(self) -> float: + """float: Property docstring.""" + ... + + @PlanNormalizationValue.setter + def PlanNormalizationValue(self, value: float) -> None: + """Set property value.""" + ... + + @property + def PlanObjectiveStructures(self) -> List[str]: + """List[str]: Property docstring.""" + ... + + @property + def PlanType(self) -> PlanType: + """PlanType: Property docstring.""" + ... + + @property + def PlanUncertainties(self) -> List[PlanUncertainty]: + """List[PlanUncertainty]: Property docstring.""" + ... + + @property + def PlannedDosePerFraction(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def PlanningApprovalDate(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanningApprover(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanningApproverDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def PredecessorPlan(self) -> PlanSetup: + """PlanSetup: Property docstring.""" + ... + + @property + def PredecessorPlanUID(self) -> str: + """str: Property docstring.""" + ... + + @property + def PrescribedDosePerFraction(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def PrescribedPercentage(self) -> float: + """float: Property docstring.""" + ... + + @property + def PrimaryReferencePoint(self) -> ReferencePoint: + """ReferencePoint: Property docstring.""" + ... + + @property + def ProtocolID(self) -> str: + """str: Property docstring.""" + ... + + @property + def ProtocolPhaseID(self) -> str: + """str: Property docstring.""" + ... + + @property + def ProtonCalculationModel(self) -> str: + """str: Property docstring.""" + ... + + @property + def ProtonCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: Property docstring.""" + ... + + @property + def RTPrescription(self) -> RTPrescription: + """RTPrescription: Property docstring.""" + ... + + @property + def ReferencePoints(self) -> List[ReferencePoint]: + """List[ReferencePoint]: Property docstring.""" + ... + + @property + def Series(self) -> Series: + """Series: Property docstring.""" + ... + + @property + def SeriesUID(self) -> str: + """str: Property docstring.""" + ... + + @property + def StructureSet(self) -> StructureSet: + """StructureSet: Property docstring.""" + ... + + @property + def StructuresSelectedForDvh(self) -> List[Structure]: + """List[Structure]: Property docstring.""" + ... + + @property + def TargetVolumeID(self) -> str: + """str: Property docstring.""" + ... + + @property + def TotalDose(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def TotalPrescribedDose(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def TreatmentApprovalDate(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentApprover(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentApproverDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentOrientation(self) -> PatientOrientation: + """PatientOrientation: Property docstring.""" + ... + + @property + def TreatmentOrientationAsString(self) -> str: + """str: Property docstring.""" + ... + + @property + def TreatmentPercentage(self) -> float: + """float: Property docstring.""" + ... + + @property + def TreatmentSessions(self) -> List[PlanTreatmentSession]: + """List[PlanTreatmentSession]: Property docstring.""" + ... + + @property + def UID(self) -> str: + """str: Property docstring.""" + ... + + @property + def UseGating(self) -> bool: + """bool: Property docstring.""" + ... + + @UseGating.setter + def UseGating(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def VerifiedPlan(self) -> PlanSetup: + """PlanSetup: Property docstring.""" + ... + + def AddModulatedScanningBeam(self, machineParameters: ProtonBeamMachineParameters, snoutId: str, snoutPosition: float, gantryAngle: float, patientSupportAngle: float, isocenter: VVector) -> Beam: + """Method docstring.""" + ... + + def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: + """Method docstring.""" + ... + + def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: + """Method docstring.""" + ... + + @overload + def AddReferencePoint(self, refPoint: ReferencePoint) -> None: + """Method docstring.""" + ... + + def CalculateBeamDeliveryDynamics(self) -> CalculationResult: + """[Availability of this method depends on your Eclipse Scripting API license] Calculates the beam delivery dynamics for the final spot list of a proton plan.""" + ... + + def CalculateBeamLine(self) -> CalculationResult: + """[Availability of this method depends on your Eclipse Scripting API license] Calculates the beam line for the proton plan. + + Returns: + CalculationResult: The calculation result. See calculation details from""" + ... + + def CalculateDVHEstimates(self, modelId: str, targetDoseLevels: Dict[str, DoseValue], structureMatches: Dict[str, str]) -> CalculationResult: + """Method docstring.""" + ... + + def CalculateDose(self) -> CalculationResult: + """[Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the proton plan. + + Returns: + CalculationResult: The calculation result. See calculation details from""" + ... + + def CalculateDoseWithoutPostProcessing(self) -> CalculationResult: + """Calculates the dose for a proton plan without post-processing. The existing final spot list is used, and no new list is created during the calculation. + + Returns: + CalculationResult: The calculation result. See calculation details from""" + ... + + def CalculatePlanUncertaintyDoses(self) -> CalculationResult: + """[Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the proton plan. + + Returns: + CalculationResult: The calculation result. See calculation details in""" + ... + + def ClearCalculationModel(self, calculationType: CalculationType) -> None: + """Method docstring.""" + ... + + def CopyEvaluationDose(self, existing: Dose) -> EvaluationDose: + """Method docstring.""" + ... + + def CreateDectVerificationPlan(self, rhoImage: Image, zImage: Image) -> IonPlanSetup: + """Method docstring.""" + ... + + def CreateEvaluationDose(self) -> EvaluationDose: + """[Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the + + Saving modifications to the database is not possible if the evaluation dose has been created but voxels have not been set. + + Returns: + EvaluationDose: A new evaluation dose object.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetCalculationModel(self, calculationType: CalculationType) -> str: + """Method docstring.""" + ... + + def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """Method docstring.""" + ... + + def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: + """Method docstring.""" + ... + + def GetClinicalGoals(self) -> List[ClinicalGoal]: + """Method docstring.""" + ... + + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """Method docstring.""" + ... + + def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: + """Method docstring.""" + ... + + def GetDvhEstimationModelName(self) -> str: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetModelsForCalculationType(self, calculationType: CalculationType) -> List[str]: + """Method docstring.""" + ... + + def GetOptimizationMode(self) -> IonPlanOptimizationMode: + """Get information on whether the plan is optimized using multi-field optimization or single-field optimization. + + Returns: + IonPlanOptimizationMode: MultiFieldOptimization if the plan uses multi-field proton optimization and returns SingleFieldOptimization if the plan uses single-field proton optimization.""" + ... + + def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List, measures: List) -> None: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: + """Method docstring.""" + ... + + def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: + """Method docstring.""" + ... + + def IsValidForPlanApproval(self, validationResults: List) -> bool: + """Method docstring.""" + ... + + def MoveToCourse(self, destinationCourse: Course) -> None: + """Method docstring.""" + ... + + def OptimizeIMPT(self, options: OptimizationOptionsIMPT) -> OptimizerResult: + """Method docstring.""" + ... + + def PostProcessAndCalculateDose(self) -> CalculationResult: + """Post-processes the proton plan by creating a final spot list, and calculates the dose. + + Returns: + CalculationResult: The calculation result. See calculation details from""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: + """Method docstring.""" + ... + + def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: + """Method docstring.""" + ... + + def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """Method docstring.""" + ... + + def SetNormalization(self, normalizationParameters: IonPlanNormalizationParameters) -> None: + """Method docstring.""" + ... + + def SetOptimizationMode(self, mode: IonPlanOptimizationMode) -> None: + """Method docstring.""" + ... + + def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: + """Method docstring.""" + ... + + def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: StringBuilder) -> bool: + """Method docstring.""" + ... + + def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class IonSpot(SerializableObject): + """The proton scanning spot interface that contains the 3D spot position and spot weight.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Position(self) -> VVector: + """VVector: Read-only spot position in X, Y, and Z directions.""" + ... + + @property + def Weight(self) -> float: + """float: Read-only spot weight.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class IonSpotCollection(SerializableObject): + """Interface for the proton scanning spot list.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: The number of scanning spots in this collection (spot list).""" + ... + + @property + def Item(self) -> IonSpot: + """IonSpot: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator[IonSpot]: + """Retrieves enumerator for IonSpots in the collection. + + Returns: + IEnumerator[IonSpot]: Enumerator for IonSpots in the collection.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class IonSpotParameters(SerializableObject): + """Interface for the proton scanning spot that contains the 3D spot position and spot weight.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Weight(self) -> float: + """float: Editable spot weight.""" + ... + + @Weight.setter + def Weight(self, value: float) -> None: + """Set property value.""" + ... + + @property + def X(self) -> float: + """float: Editable X position.""" + ... + + @X.setter + def X(self, value: float) -> None: + """Set property value.""" + ... + + @property + def Y(self) -> float: + """float: Editable Y position.""" + ... + + @Y.setter + def Y(self, value: float) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class IonSpotParametersCollection(SerializableObject): + """Interface for the editable proton scanning spot list.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: The number of editable scanning spots in this collection (spot list).""" + ... + + @property + def Item(self) -> IonSpotParameters: + """IonSpotParameters: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator[IonSpotParameters]: + """Retrieves enumerator for IonSpotParameterss in the collection. + + Returns: + IEnumerator[IonSpotParameters]: Enumerator for IonSpotParameterss in the collection.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Isodose(SerializableObject): + """Represents an isodose level for a fixed absolute or relative dose value.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Color(self) -> Color: + """Color: The color of the isodose.""" + ... + + @property + def Level(self) -> DoseValue: + """DoseValue: The dose value of the isodose level.""" + ... + + @property + def MeshGeometry(self) -> MeshGeometry3D: + """MeshGeometry3D: The triangle mesh of the isodose. Returned for those isodose levels that are rendered in 3D in Eclipse.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class LMCMSSProgressHandler: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def HandleProgressUntilDone(self, progress: ILMCMSSProgress) -> None: + """Method docstring.""" + ... + + def HandleVeryLowMinMUOperatingLimit(self, machine: str, minMu: float, precision: int, canContinue: bool) -> None: + """Method docstring.""" + ... + + def ShowDetailedError(self, message: str, details: str) -> None: + """Method docstring.""" + ... + + def ShowDetailedWarning(self, message: str, details: str) -> None: + """Method docstring.""" + ... + + def ShowError(self, message: str) -> None: + """Method docstring.""" + ... + + def ShowMessage(self, message: str) -> None: + """Method docstring.""" + ... + + def ShowWarning(self, message: str) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class LateralSpreadingDevice(AddOn): + """The lateral spreading device.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Type(self) -> LateralSpreadingDeviceType: + """LateralSpreadingDeviceType: The type of the device.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class LateralSpreadingDeviceSettings(SerializableObject): + """Settings for the lateral spreading device.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def IsocenterToLateralSpreadingDeviceDistance(self) -> float: + """float: Distance from the isocenter to the downstream edge of the lateral spreading device (mm) at the current control point.""" + ... + + @property + def LateralSpreadingDeviceSetting(self) -> str: + """str: Machine-specific setting.""" + ... + + @property + def LateralSpreadingDeviceWaterEquivalentThickness(self) -> float: + """float: Water equivalent thickness (in mm) of the lateral spreading device at the central axis for the beam energy incident upon the device.""" + ... + + @property + def ReferencedLateralSpreadingDevice(self) -> LateralSpreadingDevice: + """LateralSpreadingDevice: The referenced lateral spreading device.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class LoggingMessageHandler: + """Class docstring.""" + + def __init__(self, onMessageHandler: OnMessageHandler) -> None: + """Initialize instance.""" + ... + + @property + def LogFileDelegate(self) -> Func[ILogFile]: + """Func[ILogFile]: Property docstring.""" + ... + + @LogFileDelegate.setter + def LogFileDelegate(self, value: Func[ILogFile]) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def OnMessage(self, args: MessageArgs) -> DialogResult: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class MLC(AddOn): + """Represents a Multileaf Collimator (MLC) add-on.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def ManufacturerName(self) -> str: + """str: The name of the manufacturer of the Multileaf Collimator (MLC).""" + ... + + @property + def MinDoseDynamicLeafGap(self) -> float: + """float: For dose-dynamic treatments, the minimum gap (mm) between moving, open leaf pairs that the Multileaf Collimator (MLC) hardware can handle.""" + ... + + @property + def Model(self) -> str: + """str: The number or name of the Multileaf Collimator (MLC) model.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def SerialNumber(self) -> str: + """str: The serial number given to the Multileaf Collimator (MLC) by the factory.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class McoContextState: + """Class docstring.""" + + BalancedPlanReset: McoContextState + LoadingSavedNavigationSpace: McoContextState + NavigationObjectivesUpdated: McoContextState + PlanLibraryUpdated: McoContextState + ResettingToBalancedPlan: McoContextState + SavedNavigationSpaceLoaded: McoContextState + Undefined: McoContextState + UpdatingNavigationObjectives: McoContextState + UpdatingPlanLibrary: McoContextState + +class MotorizedWedge(Wedge): + """A motorized wedge is a standard wedge placed in the beam for a user-defined fraction of the total treatment time.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def Direction(self) -> float: + """float: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def WedgeAngle(self) -> float: + """float: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OmniWedge(Wedge): + """An OmniWedge is a special type of wedge that combines an open field, a motorized wedge, and a virtual wedge to create the desired wedge effect.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def Direction(self) -> float: + """float: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def WedgeAngle(self) -> float: + """float: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationControllerBase(Generic[T, T1, T2]): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Dispose(self) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class OptimizationControllerIMPT(OptimizationControllerBase[IProtonPlanSetup, IProtonCalculation, IProtonOptimizationClient]): + """Controls the IMPT optimization from the Script""" + + def __init__(self, calculation: IProtonCalculation, planSetup: IProtonPlanSetup) -> None: + """Initialize instance.""" + ... + + def Dispose(self) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Run(self, options: OptimizationOptionsIMPT) -> OptimizerResult: + """Method docstring.""" + ... + + @overload + def Run(self, maxIterations: int, optimizationOption: OptimizationOption) -> OptimizerResult: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class OptimizationControllerIMRT(OptimizationControllerBase[ExternalPlanSetup, IPhotonCalculation, IPhotonOptimizationClient]): + """Controls the IMRT optimization from the Script""" + + def __init__(self, calculation: IPhotonCalculation, planSetup: ExternalPlanSetup) -> None: + """Initialize instance.""" + ... + + def Dispose(self) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Run(self, maxIterations: int, options: OptimizationOptionsIMRT, intermediateDose: Dose) -> OptimizerResult: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class OptimizationControllerVMAT(OptimizationControllerBase[ExternalPlanSetup, IPhotonCalculation, IPhotonOptimizationClient]): + """Controls the VMAT optimization from the Script""" + + def __init__(self, calculation: IPhotonCalculation, planSetup: ExternalPlanSetup) -> None: + """Initialize instance.""" + ... + + def Dispose(self) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Run(self, options: OptimizationOptionsVMAT, intermediateDose: Dose) -> OptimizerResult: + """Method docstring.""" + ... + + @overload + def Run(self, mlcIdOrEmpty: str) -> OptimizerResult: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class OptimizationEUDObjective(OptimizationObjective): + """A gEUD objective is an exact, upper or lower objective. An exact gEUD objective defines an exact dose value that a target structure should receive. An upper gEUD objective defines the maximum dose value that a structure should receive. A lower gEUD objective defines the minimum dose value that a target structure should receive. Generalized Equivalent Uniform Dose (gEUD) is a uniform dose that, if delivered over the same number of fractions, yields the same radiobiological effect as the non-uniform dose distribution of interest.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Dose(self) -> DoseValue: + """DoseValue: The dose value for the objective.""" + ... + + @property + def Operator(self) -> OptimizationObjectiveOperator: + """OptimizationObjectiveOperator: Property docstring.""" + ... + + @property + def ParameterA(self) -> float: + """float: A tissue-specific parameter that illustrates the effect of the volume on the dose.""" + ... + + @property + def Priority(self) -> float: + """float: Property docstring.""" + ... + + @property + def Structure(self) -> Structure: + """Structure: Property docstring.""" + ... + + @property + def StructureId(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationExcludeStructureParameter(OptimizationParameter): + """Structures that have this parameter are excluded from the optimization.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Structure(self) -> Structure: + """Structure: The structure to be excluded.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationIMRTBeamParameter(OptimizationParameter): + """Beam-specific optimization parameter for IMRT optimization.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Beam(self) -> Beam: + """Beam: The beam to which this parameter belongs.""" + ... + + @property + def BeamId(self) -> str: + """str: The identifier of the beam.""" + ... + + @property + def Excluded(self) -> bool: + """bool: True if the beam is excluded from the optimization.""" + ... + + @property + def FixedJaws(self) -> bool: + """bool: If true, the collimator jaw positions of the beam remain the same during the optimization.""" + ... + + @property + def SmoothX(self) -> float: + """float: A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value.""" + ... + + @property + def SmoothY(self) -> float: + """float: A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationJawTrackingUsedParameter(OptimizationParameter): + """An optimization parameter for using jaw tracking in VMAT optimization. The parameter exists if OptimizationSetup.UseJawTracking has been set to true.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationLineObjective(OptimizationObjective): + """A line objective is a collection of point objectives that have the same priority. It is used to limit the dose in a given structure.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def CurveData(self) -> Array[DVHPoint]: + """Array[DVHPoint]: The points in the line objective.""" + ... + + @property + def Operator(self) -> OptimizationObjectiveOperator: + """OptimizationObjectiveOperator: Property docstring.""" + ... + + @property + def Priority(self) -> float: + """float: Property docstring.""" + ... + + @property + def Structure(self) -> Structure: + """Structure: Property docstring.""" + ... + + @property + def StructureId(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationMeanDoseObjective(OptimizationObjective): + """A mean objective defines the mean dose that should not be exceeded. The mean objective is used to decrease the dose that a structure receives.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Dose(self) -> DoseValue: + """DoseValue: The dose value for the objective.""" + ... + + @property + def Operator(self) -> OptimizationObjectiveOperator: + """OptimizationObjectiveOperator: Property docstring.""" + ... + + @property + def Priority(self) -> float: + """float: Property docstring.""" + ... + + @property + def Structure(self) -> Structure: + """Structure: Property docstring.""" + ... + + @property + def StructureId(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationNormalTissueParameter(OptimizationParameter): + """An optimization parameter for the normal tissue objective.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def DistanceFromTargetBorderInMM(self) -> float: + """float: Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins.""" + ... + + @property + def EndDosePercentage(self) -> float: + """float: Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100.""" + ... + + @property + def FallOff(self) -> float: + """float: Determines the steepness of the normal tissue objective fall-off. The value is positive.""" + ... + + @property + def IsAutomatic(self) -> bool: + """bool: Returns True if an automatic normal tissue objective (NTO) is used. The automatic NTO adapts to the patient anatomy and the optimization objectives, and automatically determines the dose fall-off criteria. When an automatic NTO is used, the other properties of this object, except Priority, are not used.""" + ... + + @property + def IsAutomaticSbrt(self) -> bool: + """bool: Returns True if an automatic SBRT normal tissue objective (NTO) is used. When an automatic SBRT NTO is used, the other properties of this object, except Priority, are not used.""" + ... + + @property + def IsAutomaticSrs(self) -> bool: + """bool: Returns True if an automatic SRS normal tissue objective (NTO) is used. When an automatic SRS NTO is used, the other properties of this object, except Priority, are not used.""" + ... + + @property + def Priority(self) -> float: + """float: Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive.""" + ... + + @property + def StartDosePercentage(self) -> float: + """float: Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationObjective(SerializableObject): + """Provides a common base type for all structure-specific optimization objectives.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Operator(self) -> OptimizationObjectiveOperator: + """OptimizationObjectiveOperator: Specifies the type of the objective (upper, lower, exact).""" + ... + + @property + def Priority(self) -> float: + """float: The priority of the objective as a positive double.""" + ... + + @property + def Structure(self) -> Structure: + """Structure: The structure to which this optimization objective belongs.""" + ... + + @property + def StructureId(self) -> str: + """str: The identifier of the structure.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Serves as a hash function for a particular type. + + Returns: + int: A hash code for the current object.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationOptionsVMATInternal(OptimizationOptionsVMAT): + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def IntermediateDoseOption(self) -> OptimizationIntermediateDoseOption: + """OptimizationIntermediateDoseOption: Property docstring.""" + ... + + @property + def MLC(self) -> str: + """str: Property docstring.""" + ... + + @property + def NumberOfOptimizationCycles(self) -> int: + """int: Property docstring.""" + ... + + @property + def StartOption(self) -> OptimizationOption: + """OptimizationOption: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class OptimizationParameter(SerializableObject): + """Provides a common base type for all optimization parameters.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Serves as a hash function for a particular type. + + Returns: + int: A hash code for the current object.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationPointCloudParameter(OptimizationParameter): + """Structure-specific parameter for point cloud optimization. Relevant if the optimization algorithm uses a point cloud. The point cloud parameters are automatically created with default values when you add other structure-specific parameters or objectives in the optimization setup.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def PointResolutionInMM(self) -> float: + """float: The point cloud resolution.""" + ... + + @property + def Structure(self) -> Structure: + """Structure: The structure whose parameters these are.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationPointObjective(OptimizationObjective): + """A point objective is either an upper or lower objective. An upper objective is used to limit the dose in a given structure. A lower objective is used to define the desired dose levels in target structures.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Dose(self) -> DoseValue: + """DoseValue: The dose value for the objective.""" + ... + + @property + def Operator(self) -> OptimizationObjectiveOperator: + """OptimizationObjectiveOperator: Property docstring.""" + ... + + @property + def Priority(self) -> float: + """float: Property docstring.""" + ... + + @property + def Structure(self) -> Structure: + """Structure: Property docstring.""" + ... + + @property + def StructureId(self) -> str: + """str: Property docstring.""" + ... + + @property + def Volume(self) -> float: + """float: Percentage of the structure volume (0-100 %) to receive the dose.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationSetup(SerializableObject): + """Gives access to the optimization parameters and objectives.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Objectives(self) -> List[OptimizationObjective]: + """List[OptimizationObjective]: A collection of optimization objectives.""" + ... + + @property + def Parameters(self) -> List[OptimizationParameter]: + """List[OptimizationParameter]: A collection of optimization parameters.""" + ... + + @property + def UseJawTracking(self) -> bool: + """bool: [Availability of this property depends on your Eclipse Scripting API license] Jaw tracking parameter for VMAT optimization. The parameter can only be set for plans to be delivered with a treatment machine that supports jaw tracking.""" + ... + + @UseJawTracking.setter + def UseJawTracking(self, value: bool) -> None: + """Set property value.""" + ... + + def AddAutomaticNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: + """Method docstring.""" + ... + + def AddAutomaticSbrtNormalTissueObjective(self, priority: float) -> OptimizationNormalTissueParameter: + """Method docstring.""" + ... + + def AddBeamSpecificParameter(self, beam: Beam, smoothX: float, smoothY: float, fixedJaws: bool) -> OptimizationIMRTBeamParameter: + """Method docstring.""" + ... + + def AddEUDObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, parameterA: float, priority: float) -> OptimizationEUDObjective: + """Method docstring.""" + ... + + def AddMeanDoseObjective(self, structure: Structure, dose: DoseValue, priority: float) -> OptimizationMeanDoseObjective: + """Method docstring.""" + ... + + def AddNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float, fallOff: float) -> OptimizationNormalTissueParameter: + """Method docstring.""" + ... + + def AddPointObjective(self, structure: Structure, objectiveOperator: OptimizationObjectiveOperator, dose: DoseValue, volume: float, priority: float) -> OptimizationPointObjective: + """Method docstring.""" + ... + + def AddProtonNormalTissueObjective(self, priority: float, distanceFromTargetBorderInMM: float, startDosePercentage: float, endDosePercentage: float) -> OptimizationNormalTissueParameter: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemoveObjective(self, objective: OptimizationObjective) -> None: + """Method docstring.""" + ... + + def RemoveParameter(self, parameter: OptimizationParameter) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizationVMATAvoidanceSectors(OptimizationParameter): + """Beam-specific optimization parameter for VMAT Avoidance sectors.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def AvoidanceSector1(self) -> OptimizationAvoidanceSector: + """OptimizationAvoidanceSector: Avoidance Sector 1.""" + ... + + @property + def AvoidanceSector2(self) -> OptimizationAvoidanceSector: + """OptimizationAvoidanceSector: Avoidance Sector 2.""" + ... + + @property + def Beam(self) -> Beam: + """Beam: The beam to which this parameter belongs.""" + ... + + @property + def IsValid(self) -> bool: + """bool: Is Avoidance Sectors valid.""" + ... + + @property + def ValidationError(self) -> str: + """str: Validation error if any.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class OptimizerDVH: + """Contains a structure-specific Dose Volume Histogram (DVH) curve generated in optimization.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def CurveData(self) -> Array[DVHPoint]: + """Array[DVHPoint]: An array of DVH points representing the DVH curve data.""" + ... + + @property + def Structure(self) -> Structure: + """Structure: The corresponding structure for the DVH curve data.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class OptimizerObjectiveValue: + """The optimizer objective function value for the structure.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Structure(self) -> Structure: + """Structure: The corresponding structure for the objective function value.""" + ... + + @property + def Value(self) -> float: + """float: The objective function value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class OptimizerResult(CalculationResult): + """Holds the result of the optimization (pass/fail).""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def NumberOfIMRTOptimizerIterations(self) -> int: + """int: The number of iterations taken by the IMRT optimizer.""" + ... + + @NumberOfIMRTOptimizerIterations.setter + def NumberOfIMRTOptimizerIterations(self, value: int) -> None: + """Set property value.""" + ... + + @property + def StructureDVHs(self) -> List[OptimizerDVH]: + """List[OptimizerDVH]: A list of Dose Volume Histogram (DVH) curves for structures.""" + ... + + @property + def StructureObjectiveValues(self) -> List[OptimizerObjectiveValue]: + """List[OptimizerObjectiveValue]: The list of objective function values per structure.""" + ... + + @property + def Success(self) -> bool: + """bool: Property docstring.""" + ... + + @property + def TotalObjectiveFunctionValue(self) -> float: + """float: The total objective function value for the optimization.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Patient(ApiDataObject): + """Represents a patient.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def Courses(self) -> List[Course]: + """List[Course]: A collection of the patient's courses.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The date when this object was created.""" + ... + + @property + def DateOfBirth(self) -> Optional[datetime]: + """Optional[datetime]: The date of birth of the patient.""" + ... + + @property + def DefaultDepartment(self) -> str: + """str: The default department name.""" + ... + + @property + def FirstName(self) -> str: + """str: The first name of the patient.""" + ... + + @FirstName.setter + def FirstName(self, value: str) -> None: + """Set property value.""" + ... + + @property + def HasModifiedData(self) -> bool: + """bool: Returns true if the patient object tree has been modified.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Hospital(self) -> Hospital: + """Hospital: The hospital.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id2(self) -> str: + """str: The patient ID2.""" + ... + + @property + def LastName(self) -> str: + """str: The last name of the patient.""" + ... + + @LastName.setter + def LastName(self, value: str) -> None: + """Set property value.""" + ... + + @property + def MiddleName(self) -> str: + """str: The middle name of the patient.""" + ... + + @MiddleName.setter + def MiddleName(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def PrimaryOncologistId(self) -> str: + """str: The identifier of the primary oncologist.""" + ... + + @property + def PrimaryOncologistName(self) -> str: + """str: The primary oncologist name.""" + ... + + @property + def ReferencePoints(self) -> List[ReferencePoint]: + """List[ReferencePoint]: Collection of all reference points for the patient.""" + ... + + @property + def Registrations(self) -> List[Registration]: + """List[Registration]: A collection of registrations.""" + ... + + @property + def SSN(self) -> str: + """str: The Social Security Account Number (SSN) of the patient.""" + ... + + @property + def Sex(self) -> str: + """str: The gender of the patient.""" + ... + + @property + def StructureSets(self) -> List[StructureSet]: + """List[StructureSet]: A collection of structure sets.""" + ... + + @property + def Studies(self) -> List[Study]: + """List[Study]: A collection of studies.""" + ... + + def AddCourse(self) -> Course: + """[Availability of this method depends on your Eclipse Scripting API license] Attaches a new course to this patient. + + Returns: + Course: The new course.""" + ... + + def AddEmptyPhantom(self, imageId: str, orientation: PatientOrientation, xSizePixel: int, ySizePixel: int, widthMM: float, heightMM: float, nrOfPlanes: int, planeSepMM: float) -> StructureSet: + """Method docstring.""" + ... + + def AddReferencePoint(self, target: bool, id: str) -> ReferencePoint: + """Method docstring.""" + ... + + def BeginModifications(self) -> None: + """Enables write-access to the data model from the Scripting API. This function must be called for each patient the script modifies. If this function is not called, the data in the database cannot be modified. + + The method""" + ... + + def CanAddCourse(self) -> bool: + """Checks if a new course can be added to the patient. + + Returns: + bool: true if a new course can be added to the patient.""" + ... + + def CanAddEmptyPhantom(self, errorMessage: str) -> bool: + """Method docstring.""" + ... + + def CanCopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str, errorMessage: str) -> bool: + """Method docstring.""" + ... + + def CanModifyData(self) -> bool: + """Returns true if the script can modify patient data in the database. + + Returns: + bool: true if the script can modify patient data in the database. Otherwise false.""" + ... + + def CanRemoveCourse(self, course: Course) -> bool: + """Method docstring.""" + ... + + def CanRemoveEmptyPhantom(self, structureset: StructureSet, errorMessage: str) -> bool: + """Method docstring.""" + ... + + def CopyImageFromOtherPatient(self, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: + """Method docstring.""" + ... + + @overload + def CopyImageFromOtherPatient(self, targetStudy: Study, otherPatientId: str, otherPatientStudyId: str, otherPatient3DImageId: str) -> StructureSet: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemoveCourse(self, course: Course) -> None: + """Method docstring.""" + ... + + def RemoveEmptyPhantom(self, structureset: StructureSet) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class PatientSummary(SerializableObject): + """Basic information about the patient.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The date when the patient object was created.""" + ... + + @property + def DateOfBirth(self) -> Optional[datetime]: + """Optional[datetime]: The date of birth of the patient.""" + ... + + @property + def FirstName(self) -> str: + """str: The first name of the patient.""" + ... + + @property + def Id(self) -> str: + """str: The patient ID.""" + ... + + @property + def Id2(self) -> str: + """str: The patient ID2.""" + ... + + @property + def LastName(self) -> str: + """str: The last name of the patient.""" + ... + + @property + def MiddleName(self) -> str: + """str: The middle name of the patient.""" + ... + + @property + def SSN(self) -> str: + """str: The Social Security Account Number (SSN) of the patient.""" + ... + + @property + def Sex(self) -> str: + """str: The gender of the patient.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class PatientSupportDevice(ApiDataObject): + """Represents a proton patient support device.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def PatientSupportAccessoryCode(self) -> str: + """str: Patient support device accessory code.""" + ... + + @property + def PatientSupportDeviceType(self) -> str: + """str: Type of the patient support device.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class PlanSetup(PlanningItem): + """Represents a treatment plan. See the definition of a DICOM RT Plan for more information.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApplicationScriptLogs(self) -> List[ApplicationScriptLog]: + """List[ApplicationScriptLog]: The log entries of the script executions that have modified the plan.""" + ... + + @property + def ApprovalHistory(self) -> List[ApprovalHistoryEntry]: + """List[ApprovalHistoryEntry]: Returns the approval history of the plan setup.""" + ... + + @property + def ApprovalStatus(self) -> PlanSetupApprovalStatus: + """PlanSetupApprovalStatus: The approval status.""" + ... + + @property + def ApprovalStatusAsString(self) -> str: + """str: Returns the approval status as a string (localized).""" + ... + + @property + def BaseDosePlanningItem(self) -> PlanningItem: + """PlanningItem: BaseDose for the optimization, can be either plan or plan sum.""" + ... + + @BaseDosePlanningItem.setter + def BaseDosePlanningItem(self, value: PlanningItem) -> None: + """Set property value.""" + ... + + @property + def Beams(self) -> List[Beam]: + """List[Beam]: A collection of all the beams in the plan (including setup beams). Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan.""" + ... + + @property + def BeamsInTreatmentOrder(self) -> List[Beam]: + """List[Beam]: A collection of all the beams in the plan (including setup beams) in treatment order. Returns an empty collection if not applicable for the plan, for example, if the plan is a brachytherapy plan.""" + ... + + @property + def Comment(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] A comment about the Plan.""" + ... + + @Comment.setter + def Comment(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Course(self) -> Course: + """Course: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def CreationUserName(self) -> str: + """str: The name of the user who saved the plan for the first time.""" + ... + + @property + def DVHEstimates(self) -> List[EstimatedDVH]: + """List[EstimatedDVH]: Returns a list of DVH estimate objects for this plan""" + ... + + @property + def Dose(self) -> PlanningItemDose: + """PlanningItemDose: Property docstring.""" + ... + + @property + def DosePerFraction(self) -> DoseValue: + """DoseValue: The dose per fraction.""" + ... + + @property + def DosePerFractionInPrimaryRefPoint(self) -> DoseValue: + """DoseValue: The calculated fraction dose in the primary reference point.""" + ... + + @property + def DoseValuePresentation(self) -> DoseValuePresentation: + """DoseValuePresentation: Property docstring.""" + ... + + @DoseValuePresentation.setter + def DoseValuePresentation(self, value: DoseValuePresentation) -> None: + """Set property value.""" + ... + + @property + def ElectronCalculationModel(self) -> str: + """str: The name of the electron calculation model. Not applicable to brachytherapy plans.""" + ... + + @property + def ElectronCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: The electron calculation options. Not applicable to brachytherapy plans.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSetup.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def IntegrityHash(self) -> str: + """str: Returns the plan's integrity hash. Returns null if the plan's integrity hash has not been set.""" + ... + + @property + def IsDoseValid(self) -> bool: + """bool: Returns the value true if the plan dose is valid. This implies that the dose object returned from the dose property is not null and can therefore be used to query dose values.""" + ... + + @property + def IsTreated(self) -> bool: + """bool: Checks if the treatment plan has been delivered.""" + ... + + @property + def Name(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The name of the Plan.""" + ... + + @Name.setter + def Name(self, value: str) -> None: + """Set property value.""" + ... + + @property + def NumberOfFractions(self) -> Optional[int]: + """Optional[int]: The number of fractions.""" + ... + + @property + def OptimizationSetup(self) -> OptimizationSetup: + """OptimizationSetup: Provides access to optimization objectives and parameters.""" + ... + + @property + def PatientSupportDevice(self) -> PatientSupportDevice: + """PatientSupportDevice: Patient support device.""" + ... + + @property + def PhotonCalculationModel(self) -> str: + """str: The name of the photon calculation model. Not applicable to brachytherapy plans.""" + ... + + @property + def PhotonCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: The photon calculation options. Not applicable to brachytherapy plans.""" + ... + + @property + def PlanIntent(self) -> str: + """str: The plan intent as in DICOM, or an empty string. The defined terms are "CURATIVE", "PALLIATIVE", "PROPHYLACTIC", "VERIFICATION", "MACHINE_QA", "RESEARCH" and "SERVICE", but the value can be different for imported plans.""" + ... + + @property + def PlanIsInTreatment(self) -> bool: + """bool: Checks if plan is loaded into console.""" + ... + + @property + def PlanNormalizationMethod(self) -> str: + """str: The user interface name for the current normalization method.""" + ... + + @property + def PlanNormalizationPoint(self) -> VVector: + """VVector: The plan normalization point.""" + ... + + @property + def PlanNormalizationValue(self) -> float: + """float: [Availability of this property depends on your Eclipse Scripting API license] The plan normalization value in percentage. The plan is normalized according to the plan normalization value, for instance, 200%. The value is Double.NaN if it is not defined.""" + ... + + @PlanNormalizationValue.setter + def PlanNormalizationValue(self, value: float) -> None: + """Set property value.""" + ... + + @property + def PlanObjectiveStructures(self) -> List[str]: + """List[str]: The list of structure IDs that are present in the plan objectives (prescriptions and indices).""" + ... + + @property + def PlanType(self) -> PlanType: + """PlanType: The plan type.""" + ... + + @property + def PlanUncertainties(self) -> List[PlanUncertainty]: + """List[PlanUncertainty]: Plan uncertainties defined for the plan.""" + ... + + @property + def PlannedDosePerFraction(self) -> DoseValue: + """DoseValue: The calculated fraction dose in the primary reference point.""" + ... + + @property + def PlanningApprovalDate(self) -> str: + """str: The date when the plan was approved for planning.""" + ... + + @property + def PlanningApprover(self) -> str: + """str: The identifier of the user who approved the plan for planning.""" + ... + + @property + def PlanningApproverDisplayName(self) -> str: + """str: The display name of the user who approved the plan for planning.""" + ... + + @property + def PredecessorPlan(self) -> PlanSetup: + """PlanSetup: The prior revision of the plan""" + ... + + @property + def PredecessorPlanUID(self) -> str: + """str: The UID of the predecessor plan.""" + ... + + @property + def PrescribedDosePerFraction(self) -> DoseValue: + """DoseValue: The prescribed fraction dose.""" + ... + + @property + def PrescribedPercentage(self) -> float: + """float: The prescribed dose percentage as a decimal number. For example, if the prescribed dose percentage shown in the Eclipse user interface is 80 %, returns 0.8""" + ... + + @property + def PrimaryReferencePoint(self) -> ReferencePoint: + """ReferencePoint: The primary reference point.""" + ... + + @property + def ProtocolID(self) -> str: + """str: The protocol identifier.""" + ... + + @property + def ProtocolPhaseID(self) -> str: + """str: The protocol phase identifier.""" + ... + + @property + def ProtonCalculationModel(self) -> str: + """str: The name of the proton calculation model. Not applicable to brachytherapy plans.""" + ... + + @property + def ProtonCalculationOptions(self) -> Dict[str, str]: + """Dict[str, str]: The proton calculation options. Not applicable to brachytherapy plans.""" + ... + + @property + def RTPrescription(self) -> RTPrescription: + """RTPrescription: Used for navigating to the linked prescription.""" + ... + + @property + def ReferencePoints(self) -> List[ReferencePoint]: + """List[ReferencePoint]: Collection of reference points in the plan.""" + ... + + @property + def Series(self) -> Series: + """Series: The series that contains this plan. Null if the plan is not connected to a series.""" + ... + + @property + def SeriesUID(self) -> str: + """str: The DICOM UID of the series that contains this plan. Empty string if the plan is not connected to a series.""" + ... + + @property + def StructureSet(self) -> StructureSet: + """StructureSet: Property docstring.""" + ... + + @property + def StructuresSelectedForDvh(self) -> List[Structure]: + """List[Structure]: Property docstring.""" + ... + + @property + def TargetVolumeID(self) -> str: + """str: The target volume identifier.""" + ... + + @property + def TotalDose(self) -> DoseValue: + """DoseValue: Planned total dose.""" + ... + + @property + def TotalPrescribedDose(self) -> DoseValue: + """DoseValue: The total prescribed dose.""" + ... + + @property + def TreatmentApprovalDate(self) -> str: + """str: The date when the plan was approved for treatment.""" + ... + + @property + def TreatmentApprover(self) -> str: + """str: The identifier of the user who approved the plan for treatment.""" + ... + + @property + def TreatmentApproverDisplayName(self) -> str: + """str: The display name of the user who approved the plan for treatment.""" + ... + + @property + def TreatmentOrientation(self) -> PatientOrientation: + """PatientOrientation: The orientation of the treatment.""" + ... + + @property + def TreatmentOrientationAsString(self) -> str: + """str: The orientation of the treatment as a string (localized).""" + ... + + @property + def TreatmentPercentage(self) -> float: + """float: The treatment percentage as a decimal number. For example, if the treatment percentage shown in the Eclipse user interface is 80%, returns 0.8.""" + ... + + @property + def TreatmentSessions(self) -> List[PlanTreatmentSession]: + """List[PlanTreatmentSession]: Treatment sessions for the plan, either scheduled sessions or treated sessions.""" + ... + + @property + def UID(self) -> str: + """str: The DICOM UID of the plan.""" + ... + + @property + def UseGating(self) -> bool: + """bool: Boolean to mark if gating is used in the plan.""" + ... + + @UseGating.setter + def UseGating(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def VerifiedPlan(self) -> PlanSetup: + """PlanSetup: Returns the verified plan if this is a verification plan, otherwise returns null. The verified plan is the clinical plan that was used to create the verification plan.""" + ... + + def AddPlanUncertaintyWithParameters(self, uncertaintyType: PlanUncertaintyType, planSpecificUncertainty: bool, HUConversionError: float, isocenterShift: VVector) -> PlanUncertainty: + """Method docstring.""" + ... + + def AddReferencePoint(self, target: bool, location: Optional[VVector], id: str) -> ReferencePoint: + """Method docstring.""" + ... + + @overload + def AddReferencePoint(self, refPoint: ReferencePoint) -> None: + """Method docstring.""" + ... + + def ClearCalculationModel(self, calculationType: CalculationType) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetCalculationModel(self, calculationType: CalculationType) -> str: + """Method docstring.""" + ... + + def GetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """Method docstring.""" + ... + + def GetCalculationOptions(self, calculationModel: str) -> Dict[str, str]: + """Method docstring.""" + ... + + def GetClinicalGoals(self) -> List[ClinicalGoal]: + """Method docstring.""" + ... + + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """Method docstring.""" + ... + + def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: + """Method docstring.""" + ... + + def GetDvhEstimationModelName(self) -> str: + """Retrieves the name of DVH Estimation Model.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetProtocolPrescriptionsAndMeasures(self, prescriptions: List, measures: List) -> None: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: + """Method docstring.""" + ... + + def IsEntireBodyAndBolusesCoveredByCalculationArea(self) -> bool: + """Checks the limits of the current calculation area. + + Returns: + bool: True if calculation area covers entire body or, if no body defined, image.""" + ... + + def IsValidForPlanApproval(self, validationResults: List) -> bool: + """Method docstring.""" + ... + + def MoveToCourse(self, destinationCourse: Course) -> None: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemoveReferencePoint(self, refPoint: ReferencePoint) -> None: + """Method docstring.""" + ... + + def SetCalculationModel(self, calculationType: CalculationType, model: str) -> None: + """Method docstring.""" + ... + + def SetCalculationOption(self, calculationModel: str, optionName: str, optionValue: str) -> bool: + """Method docstring.""" + ... + + def SetPrescription(self, numberOfFractions: int, dosePerFraction: DoseValue, treatmentPercentage: float) -> None: + """Method docstring.""" + ... + + def SetTargetStructureIfNoDose(self, newTargetStructure: Structure, errorHint: StringBuilder) -> bool: + """Method docstring.""" + ... + + def SetTreatmentOrder(self, orderedBeams: List[Beam]) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class PlanSum(PlanningItem): + """A plan sum describes the cumulative dose summation of several treatment plans. It can be used, for example, to evaluate the dose the patient received from a treatment plan and boost plan together.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def Course(self) -> Course: + """Course: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def Dose(self) -> PlanningItemDose: + """PlanningItemDose: Property docstring.""" + ... + + @property + def DoseValuePresentation(self) -> DoseValuePresentation: + """DoseValuePresentation: Property docstring.""" + ... + + @DoseValuePresentation.setter + def DoseValuePresentation(self, value: DoseValuePresentation) -> None: + """Set property value.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The identifier of the PlanSum.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Name(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The name of the PlanSum.""" + ... + + @Name.setter + def Name(self, value: str) -> None: + """Set property value.""" + ... + + @property + def PlanSetups(self) -> List[PlanSetup]: + """List[PlanSetup]: A collection of plan setups.""" + ... + + @property + def PlanSumComponents(self) -> List[PlanSumComponent]: + """List[PlanSumComponent]: A collection of plans in a plan sum.""" + ... + + @property + def StructureSet(self) -> StructureSet: + """StructureSet: Property docstring.""" + ... + + @property + def StructuresSelectedForDvh(self) -> List[Structure]: + """List[Structure]: Property docstring.""" + ... + + def AddItem(self, pi: PlanningItem) -> None: + """Method docstring.""" + ... + + @overload + def AddItem(self, pi: PlanningItem, operation: PlanSumOperation, planWeight: float) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetClinicalGoals(self) -> List[ClinicalGoal]: + """Method docstring.""" + ... + + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """Method docstring.""" + ... + + def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetPlanSumOperation(self, planSetupInPlanSum: PlanSetup) -> PlanSumOperation: + """Method docstring.""" + ... + + def GetPlanWeight(self, planSetupInPlanSum: PlanSetup) -> float: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemoveItem(self, pi: PlanningItem) -> None: + """Method docstring.""" + ... + + def SetPlanSumOperation(self, planSetupInPlanSum: PlanSetup, operation: PlanSumOperation) -> None: + """Method docstring.""" + ... + + def SetPlanWeight(self, planSetupInPlanSum: PlanSetup, weight: float) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class PlanSumComponent(ApiDataObject): + """Represents a component plan of a plan sum.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanSetupId(self) -> str: + """str: The unique identification of the plan within the course.""" + ... + + @property + def PlanSumOperation(self) -> PlanSumOperation: + """PlanSumOperation: The summing operation (+ or -) that defines how the dose of a component plan contributes to the plan sum.""" + ... + + @property + def PlanWeight(self) -> float: + """float: The weight of a component plan included in the plan sum.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class PlanTreatmentSession(ApiDataObject): + """Plan in the treatment session.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def PlanSetup(self) -> PlanSetup: + """PlanSetup: Scheduled or treated plan.""" + ... + + @property + def Status(self) -> TreatmentSessionStatus: + """TreatmentSessionStatus: Plan status in the treatment session.""" + ... + + @property + def TreatmentSession(self) -> TreatmentSession: + """TreatmentSession: Treatment session.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class PlanUncertainty(ApiDataObject): + """Provides access to Plan Uncertainty parameters. For more information, see Eclipse Photon and Electron Instructions for Use.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def BeamUncertainties(self) -> List[BeamUncertainty]: + """List[BeamUncertainty]: Collection of beam uncertainty doses.""" + ... + + @property + def CalibrationCurveError(self) -> float: + """float: The calibration curve error of the plan uncertainty in percentage. Returns 100 for 100%. NaN if not defined.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def DisplayName(self) -> str: + """str: The display name of the plan variation, including the parameter values.""" + ... + + @property + def Dose(self) -> Dose: + """Dose: The dose of this plan variation.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def IsocenterShift(self) -> VVector: + """VVector: The isocenter shift of the plan uncertainty.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def UncertaintyType(self) -> PlanUncertaintyType: + """PlanUncertaintyType: Type of uncertainty, which determines how and in what context the defined parameters are to be used.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class PlanningItem(ApiDataObject): + """Common properties of a treatment plan and a plan sum.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def Course(self) -> Course: + """Course: Used for navigating to parent course.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The date when this object was created.""" + ... + + @property + def Dose(self) -> PlanningItemDose: + """PlanningItemDose: The total dose. The total dose is the dose of all planned fractions together.""" + ... + + @property + def DoseValuePresentation(self) -> DoseValuePresentation: + """DoseValuePresentation: The presentation of the dose as absolute or relative.""" + ... + + @DoseValuePresentation.setter + def DoseValuePresentation(self, value: DoseValuePresentation) -> None: + """Set property value.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def StructureSet(self) -> StructureSet: + """StructureSet: The structure set.""" + ... + + @property + def StructuresSelectedForDvh(self) -> List[Structure]: + """List[Structure]: The collection of the structures that have been selected for DVH evaluation in Eclipse.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetClinicalGoals(self) -> List[ClinicalGoal]: + """Get the list of clinical goals assigned to a planning item. + + Returns: + List[ClinicalGoal]: The list of clinical goals attached to the plan.""" + ... + + def GetDVHCumulativeData(self, structure: Structure, dosePresentation: DoseValuePresentation, volumePresentation: VolumePresentation, binWidth: float) -> DVHData: + """Method docstring.""" + ... + + def GetDoseAtVolume(self, structure: Structure, volume: float, volumePresentation: VolumePresentation, requestedDosePresentation: DoseValuePresentation) -> DoseValue: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetVolumeAtDose(self, structure: Structure, dose: DoseValue, requestedVolumePresentation: VolumePresentation) -> float: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class PlanningItemDose(Dose): + """Represents a dose that is connected to a plan setup or a plan sum.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def DoseMax3D(self) -> DoseValue: + """DoseValue: Property docstring.""" + ... + + @property + def DoseMax3DLocation(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Isodoses(self) -> List[Isodose]: + """List[Isodose]: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Origin(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def Series(self) -> Series: + """Series: Property docstring.""" + ... + + @property + def SeriesUID(self) -> str: + """str: Property docstring.""" + ... + + @property + def UID(self) -> str: + """str: Property docstring.""" + ... + + @property + def XDirection(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def XRes(self) -> float: + """float: Property docstring.""" + ... + + @property + def XSize(self) -> int: + """int: Property docstring.""" + ... + + @property + def YDirection(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def YRes(self) -> float: + """float: Property docstring.""" + ... + + @property + def YSize(self) -> int: + """int: Property docstring.""" + ... + + @property + def ZDirection(self) -> VVector: + """VVector: Property docstring.""" + ... + + @property + def ZRes(self) -> float: + """float: Property docstring.""" + ... + + @property + def ZSize(self) -> int: + """int: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetDoseProfile(self, start: VVector, stop: VVector, preallocatedBuffer: Array[float]) -> DoseProfile: + """Method docstring.""" + ... + + def GetDoseToPoint(self, at: VVector) -> DoseValue: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetVoxels(self, planeIndex: int, preallocatedBuffer: Array[int]) -> None: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def VoxelToDoseValue(self, voxelValue: int) -> DoseValue: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ProtocolPhaseMeasure(SerializableObject): + """Represents the plan measures (quality indices) of the clinical protocol.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ActualValue(self) -> float: + """float: The calculated actual value of this plan measure.""" + ... + + @property + def Modifier(self) -> MeasureModifier: + """MeasureModifier: Measure Modifier.""" + ... + + @property + def StructureId(self) -> str: + """str: ID of the structure to which this measure is applied.""" + ... + + @property + def TargetIsMet(self) -> Optional[bool]: + """Optional[bool]: Indicates whether the target is met. If this cannot be evaluated, the value is null.""" + ... + + @property + def TargetValue(self) -> float: + """float: The target value of this plan measure.""" + ... + + @property + def Type(self) -> MeasureType: + """MeasureType: Measure Type.""" + ... + + @property + def TypeText(self) -> str: + """str: Measure type as text, for instance, 'Conformity Index' in 'Conformity Index is more than 10.0'.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ProtocolPhasePrescription(SerializableObject): + """Represents the prescriptions (plan objectives) of the clinical protocol.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ActualTotalDose(self) -> DoseValue: + """DoseValue: Actual total dose for this prescription""" + ... + + @property + def PrescModifier(self) -> PrescriptionModifier: + """PrescriptionModifier: Prescription Modifier.""" + ... + + @property + def PrescParameter(self) -> float: + """float: Value of the prescription parameter, for instance, '80' in 'At least 80% receives more than 2 Gy'.""" + ... + + @property + def PrescType(self) -> PrescriptionType: + """PrescriptionType: Prescription Type.""" + ... + + @property + def StructureId(self) -> str: + """str: ID of structure to which this prescription is applied.""" + ... + + @property + def TargetFractionDose(self) -> DoseValue: + """DoseValue: Fraction dose in absolute units specified for this prescription.""" + ... + + @property + def TargetIsMet(self) -> Optional[bool]: + """Optional[bool]: Indicates whether the target is met. If this cannot be evaluated, the value is null.""" + ... + + @property + def TargetTotalDose(self) -> DoseValue: + """DoseValue: Total dose in absolute units specified for this prescription.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class RTPrescription(ApiDataObject): + """Represents a prescription.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def BolusFrequency(self) -> str: + """str: Bolus frequency (how often the bolus is present in the field). For example, daily.""" + ... + + @property + def BolusThickness(self) -> str: + """str: Thickness of the bolus to be used.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def Energies(self) -> List[str]: + """List[str]: The energies in the prescription.""" + ... + + @property + def EnergyModes(self) -> List[str]: + """List[str]: The energy modes in the prescription.""" + ... + + @property + def Gating(self) -> str: + """str: Gating information.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def LatestRevision(self) -> RTPrescription: + """RTPrescription: Gets the latest revision of the current RT prescription.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Notes(self) -> str: + """str: Additional notes.""" + ... + + @property + def NumberOfFractions(self) -> Optional[int]: + """Optional[int]: Number of fractions, optional.""" + ... + + @property + def OrgansAtRisk(self) -> List[RTPrescriptionOrganAtRisk]: + """List[RTPrescriptionOrganAtRisk]: Gets the organs at risk of the current RT prescription.""" + ... + + @property + def PhaseType(self) -> str: + """str: Type of the phase (primary/boost).""" + ... + + @property + def PredecessorPrescription(self) -> RTPrescription: + """RTPrescription: Gets the previous version of the RT prescription if it exists.""" + ... + + @property + def RevisionNumber(self) -> int: + """int: Revision number of the prescription.""" + ... + + @property + def SimulationNeeded(self) -> Optional[bool]: + """Optional[bool]: Indicates if simulations need to be done before treatment planning.""" + ... + + @property + def Site(self) -> str: + """str: The treatment site in the prescription.""" + ... + + @property + def Status(self) -> str: + """str: Prescription status.""" + ... + + @property + def TargetConstraintsWithoutTargetLevel(self) -> List[RTPrescriptionTargetConstraints]: + """List[RTPrescriptionTargetConstraints]: Coverage constraints for targets with no prescribed dose.""" + ... + + @property + def Targets(self) -> List[RTPrescriptionTarget]: + """List[RTPrescriptionTarget]: Gets the targets of the current prescription.""" + ... + + @property + def Technique(self) -> str: + """str: Treatment technique to be used.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class RTPrescriptionConstraint(SerializableObject): + """Represents a coverage constraint for an RT prescription.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ConstraintType(self) -> RTPrescriptionConstraintType: + """RTPrescriptionConstraintType: Type of the constraint.""" + ... + + @property + def Unit1(self) -> str: + """str: Gy, %, or null""" + ... + + @property + def Unit2(self) -> str: + """str: Gy, %, or null""" + ... + + @property + def Value1(self) -> str: + """str: First numerical (or free text) part of the constraint.""" + ... + + @property + def Value2(self) -> str: + """str: Second numerical (or free text) part of the constraint.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class RTPrescriptionOrganAtRisk(SerializableObject): + """Represents an organ at risk structure.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Constraints(self) -> List[RTPrescriptionConstraint]: + """List[RTPrescriptionConstraint]: Constraints.""" + ... + + @property + def OrganAtRiskId(self) -> str: + """str: Structure identifier of the organ at risk.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class RTPrescriptionTarget(ApiDataObject): + """Represents a prescription target.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def Constraints(self) -> List[RTPrescriptionConstraint]: + """List[RTPrescriptionConstraint]: Coverage constraints.""" + ... + + @property + def DosePerFraction(self) -> DoseValue: + """DoseValue: Dose per fraction for this target.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def NumberOfFractions(self) -> int: + """int: The number of fractions in the prescription.""" + ... + + @property + def TargetId(self) -> str: + """str: The ID of the target volume.""" + ... + + @property + def Type(self) -> RTPrescriptionTargetType: + """RTPrescriptionTargetType: Type of the prescription target. It can be Isocenter, IsodoseLine, Volume or Depth.""" + ... + + @property + def Value(self) -> float: + """float: Defined when the target type is IsodoseLine or Depth. Unit is % for IsodoseLine or mm for Depth. Not defined for other prescription types.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class RTPrescriptionTargetConstraints(SerializableObject): + """Represents target structure constraints.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Constraints(self) -> List[RTPrescriptionConstraint]: + """List[RTPrescriptionConstraint]: Constraints.""" + ... + + @property + def TargetId(self) -> str: + """str: Identifier of the target structure.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class RadioactiveSource(ApiDataObject): + """Represents a radioactive source installed into a""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def CalibrationDate(self) -> Optional[datetime]: + """Optional[datetime]: The calibration date for the strength of this radioactive source.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def NominalActivity(self) -> bool: + """bool: Defines whether source decay is accounted for in treatment planning. If the value is true, the dose calculation uses the source at its calibration activity (nominal activity). If the value is false, the source strength is decayed to the treatment activity based on the treatment date of the plan where the source is used.""" + ... + + @property + def RadioactiveSourceModel(self) -> RadioactiveSourceModel: + """RadioactiveSourceModel: The brachytherapy radioactive source model associated with this radioactive source.""" + ... + + @property + def SerialNumber(self) -> str: + """str: The serial number of this radioactive source.""" + ... + + @property + def Strength(self) -> float: + """float: The source strength for the radioactive source on the calibration date in cGy cm^2/h.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class RadioactiveSourceModel(ApiDataObject): + """The radioactive source model represents the details of the radioactive source used in brachytherapy. It encapsulates the source isotope, dimensions, and dose calculation parameters.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ActiveSize(self) -> VVector: + """VVector: The active size of the modeled radioactive source in x, y, and z dimensions in millimeters. x represents the source width, y represents the source height, and z the source length.""" + ... + + @property + def ActivityConversionFactor(self) -> float: + """float: The activity-kerma conversion factor is used for converting activity (in mCi) to air-kerma strength (in U = cGy cm^2 / h). The unit of the factor is [U / mCi].""" + ... + + @property + def CalculationModel(self) -> str: + """str: The dose calculation type used with this source model. Possible values are "Point source" and "Linear source".""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def DoseRateConstant(self) -> float: + """float: A conversion factor from the air-kerma strength to the dose rate in tissue. The unit of the dose rate constant is cGy / (h U).""" + ... + + @property + def HalfLife(self) -> float: + """float: The half life of the isotope in seconds.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def LiteratureReference(self) -> str: + """str: The reference to the scientific publications on which the source model is based.""" + ... + + @property + def Manufacturer(self) -> str: + """str: The manufacturer of the modeled radioactive source.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def SourceType(self) -> str: + """str: The DICOM source type. Possible values are "Point", "Line", "Cylinder", and "Sphere".""" + ... + + @property + def Status(self) -> str: + """str: The status of this source model. The status can be either "Unapproved", "Commissioning", "Approved", or "Retired".""" + ... + + @property + def StatusDate(self) -> Optional[datetime]: + """Optional[datetime]: The time when the status of the source model was set.""" + ... + + @property + def StatusUserName(self) -> str: + """str: The name of the user who last set the status of the source model.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class RangeModulator(AddOn): + """The range modulator device.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Type(self) -> RangeModulatorType: + """RangeModulatorType: The type of the device.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class RangeModulatorSettings(SerializableObject): + """Range modulator settings.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def IsocenterToRangeModulatorDistance(self) -> float: + """float: Distance from the isocenter to the downstream edge of the range modulator (mm) at the current control point.""" + ... + + @property + def RangeModulatorGatingStarWaterEquivalentThickness(self) -> float: + """float: Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Start Value.""" + ... + + @property + def RangeModulatorGatingStartValue(self) -> float: + """float: Start position defines the range modulator position at which the beam is switched on.""" + ... + + @property + def RangeModulatorGatingStopValue(self) -> float: + """float: Stop position defines the range modulator position at which the beam is switched off.""" + ... + + @property + def RangeModulatorGatingStopWaterEquivalentThickness(self) -> float: + """float: Water equivalent thickness (in mm) of the range modulator at the position specified by Range Modulator Gating Stop Value.""" + ... + + @property + def ReferencedRangeModulator(self) -> RangeModulator: + """RangeModulator: The referenced range modulator.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class RangeShifter(AddOn): + """The range shifter device.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Type(self) -> RangeShifterType: + """RangeShifterType: The type of the device.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class RangeShifterSettings(SerializableObject): + """Range shifter settings.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def IsocenterToRangeShifterDistance(self) -> float: + """float: Distance from the isocenter to the downstream edge of the range shifter (mm) at the current control point.""" + ... + + @property + def RangeShifterSetting(self) -> str: + """str: Machine-specific setting.""" + ... + + @property + def RangeShifterWaterEquivalentThickness(self) -> float: + """float: Water equivalent thickness (in mm) of the range shifter at the central axis for the beam energy incident upon the device.""" + ... + + @property + def ReferencedRangeShifter(self) -> RangeShifter: + """RangeShifter: The referenced range shifter.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ReferencePoint(ApiDataObject): + """A reference point associated with a patient.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def DailyDoseLimit(self) -> DoseValue: + """DoseValue: Daily dose limit of this reference point.""" + ... + + @DailyDoseLimit.setter + def DailyDoseLimit(self, value: DoseValue) -> None: + """Set property value.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Reference Point.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def SessionDoseLimit(self) -> DoseValue: + """DoseValue: Session dose limit of this reference point.""" + ... + + @SessionDoseLimit.setter + def SessionDoseLimit(self, value: DoseValue) -> None: + """Set property value.""" + ... + + @property + def TotalDoseLimit(self) -> DoseValue: + """DoseValue: Total dose limit of this reference point.""" + ... + + @TotalDoseLimit.setter + def TotalDoseLimit(self, value: DoseValue) -> None: + """Set property value.""" + ... + + def AddLocation(self, Image: Image, x: float, y: float, z: float, errorHint: StringBuilder) -> bool: + """Method docstring.""" + ... + + def ChangeLocation(self, Image: Image, x: float, y: float, z: float, errorHint: StringBuilder) -> bool: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetReferencePointLocation(self, Image: Image) -> VVector: + """Method docstring.""" + ... + + @overload + def GetReferencePointLocation(self, planSetup: PlanSetup) -> VVector: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def HasLocation(self, planSetup: PlanSetup) -> bool: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemoveLocation(self, Image: Image, errorHint: StringBuilder) -> bool: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Registration(ApiDataObject): + """Represents the spatial registration matrix between two frames of reference.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The date when this object was created.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def RegisteredFOR(self) -> str: + """str: The frame of reference UID of the registered coordinate system.""" + ... + + @property + def SourceFOR(self) -> str: + """str: The frame of reference UID of the source coordinate system.""" + ... + + @property + def Status(self) -> RegistrationApprovalStatus: + """RegistrationApprovalStatus: The current approval status of the registration.""" + ... + + @property + def StatusDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The approval status date and time.""" + ... + + @property + def StatusUserDisplayName(self) -> str: + """str: Full user name of user who changed the approval status.""" + ... + + @property + def StatusUserName(self) -> str: + """str: User ID of the user who changed the approval status.""" + ... + + @property + def TransformationMatrix(self) -> Array[float]: + """Array[float]: The elements of the 4x4 transformation matrix.""" + ... + + @property + def UID(self) -> str: + """str: The SOP Instance UID of this registration object.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def InverseTransformPoint(self, pt: VVector) -> VVector: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def TransformPoint(self, pt: VVector) -> VVector: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ScriptContext: + """Contains the runtime context information of the active application for the script.""" + + def __init__(self, context: Any, user: Any, dvhEstimation: Any, appName: str) -> None: + """Initialize instance.""" + ... + + @property + def ApplicationName(self) -> str: + """str: The name of the active application.""" + ... + + @property + def BrachyPlanSetup(self) -> BrachyPlanSetup: + """BrachyPlanSetup: The active brachytherapy plan setup. The value is null if the active object is not a brachytherapy plan setup.""" + ... + + @property + def BrachyPlansInScope(self) -> List[BrachyPlanSetup]: + """List[BrachyPlanSetup]: Retrieves a list of all brachytherapy plans in the Scope window.""" + ... + + @property + def Calculation(self) -> Calculation: + """Calculation: Calculation related functions""" + ... + + @property + def Course(self) -> Course: + """Course: The course. The value may be null if the context has no course.""" + ... + + @property + def CurrentUser(self) -> User: + """User: The current user of the application.""" + ... + + @property + def Equipment(self) -> Equipment: + """Equipment: Provides access to clinical devices and accessories.""" + ... + + @Equipment.setter + def Equipment(self, value: Equipment) -> None: + """Set property value.""" + ... + + @property + def ExternalPlanSetup(self) -> ExternalPlanSetup: + """ExternalPlanSetup: The active external beam plan setup. The value is null if the active object is not an external beam plan setup.""" + ... + + @property + def ExternalPlansInScope(self) -> List[ExternalPlanSetup]: + """List[ExternalPlanSetup]: Retrieves a list of all external beam plans in the Scope window.""" + ... + + @property + def Image(self) -> Image: + """Image: The 3D image. The value may be null if the context has no image.""" + ... + + @property + def IonPlanSetup(self) -> IonPlanSetup: + """IonPlanSetup: The active proton plan setup. The value is null if the active object is not a proton plan setup.""" + ... + + @property + def IonPlansInScope(self) -> List[IonPlanSetup]: + """List[IonPlanSetup]: Retrieves a list of all proton plans in the Scope window.""" + ... + + @property + def Patient(self) -> Patient: + """Patient: The patient. The value may be null if the context has no patient.""" + ... + + @property + def PlanSetup(self) -> PlanSetup: + """PlanSetup: The plan setup. The value may be null if the context has no plan setup.""" + ... + + @property + def PlanSum(self) -> PlanSum: + """PlanSum: Retrieves the active plan sum.""" + ... + + @property + def PlanSumsInScope(self) -> List[PlanSum]: + """List[PlanSum]: Retrieves a list of all plan sums in the Scope window.""" + ... + + @property + def PlansInScope(self) -> List[PlanSetup]: + """List[PlanSetup]: Retrieves a list of all plans in the Scope window.""" + ... + + @property + def StructureCodes(self) -> ActiveStructureCodeDictionaries: + """ActiveStructureCodeDictionaries: Provides access to the structure code dictionaries with the active structure codes.""" + ... + + @StructureCodes.setter + def StructureCodes(self, value: ActiveStructureCodeDictionaries) -> None: + """Set property value.""" + ... + + @property + def StructureSet(self) -> StructureSet: + """StructureSet: The structure set. The value may be null if the context has no structure set.""" + ... + + @property + def VersionInfo(self) -> str: + """str: The version number of Eclipse.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class ScriptEnvironment: + """Contains the runtime information of the application environment for the script.""" + + def __init__(self, appName: str, scripts: List[ApplicationScript], scriptExecutionEngine: Action[Assembly, Any, Window, Any]) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, appName: str, scripts: List[ApplicationScript], packages: List[ApplicationPackage], scriptExecutionEngine: Action[Assembly, Any, Window, Any]) -> None: + """Initialize instance.""" + ... + + @property + def ApiVersionInfo(self) -> str: + """str: The version number of Eclipse Scripting API.""" + ... + + @property + def ApplicationName(self) -> str: + """str: The name of the active application.""" + ... + + @property + def Packages(self) -> List[ApplicationPackage]: + """List[ApplicationPackage]: Retrieves a list of all packages known by the application.""" + ... + + @property + def Scripts(self) -> List[ApplicationScript]: + """List[ApplicationScript]: Retrieves a list of all scripts known by the application.""" + ... + + @property + def VersionInfo(self) -> str: + """str: The version number of Eclipse.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def ExecuteScript(self, scriptAssembly: Assembly, scriptContext: ScriptContext, window: Window) -> None: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class SearchBodyParameters(SerializableObject): + """Parameters for the Search Body feature.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def FillAllCavities(self) -> bool: + """bool: Defines whether all cavities are filled.""" + ... + + @FillAllCavities.setter + def FillAllCavities(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def KeepLargestParts(self) -> bool: + """bool: Defines whether the largest part(s) of the Body structure are kept.""" + ... + + @KeepLargestParts.setter + def KeepLargestParts(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def LowerHUThreshold(self) -> int: + """int: The lower threshold of the Hounsfield Unit value in the CT for the Search Body feature.""" + ... + + @LowerHUThreshold.setter + def LowerHUThreshold(self, value: int) -> None: + """Set property value.""" + ... + + @property + def MREdgeThresholdHigh(self) -> int: + """int: Higher edge threshold for MR images.""" + ... + + @MREdgeThresholdHigh.setter + def MREdgeThresholdHigh(self, value: int) -> None: + """Set property value.""" + ... + + @property + def MREdgeThresholdLow(self) -> int: + """int: Lower edge threshold for MR images.""" + ... + + @MREdgeThresholdLow.setter + def MREdgeThresholdLow(self, value: int) -> None: + """Set property value.""" + ... + + @property + def NumberOfLargestPartsToKeep(self) -> int: + """int: The number of the largest parts in the Body structure that are kept.""" + ... + + @NumberOfLargestPartsToKeep.setter + def NumberOfLargestPartsToKeep(self, value: int) -> None: + """Set property value.""" + ... + + @property + def PreCloseOpenings(self) -> bool: + """bool: Defines whether to connect structure parts before extraction.""" + ... + + @PreCloseOpenings.setter + def PreCloseOpenings(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def PreCloseOpeningsRadius(self) -> float: + """float: Radius setting for PreCloseOpenings.""" + ... + + @PreCloseOpeningsRadius.setter + def PreCloseOpeningsRadius(self, value: float) -> None: + """Set property value.""" + ... + + @property + def PreDisconnect(self) -> bool: + """bool: Defines whether to disconnect structure parts before extraction.""" + ... + + @PreDisconnect.setter + def PreDisconnect(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def PreDisconnectRadius(self) -> float: + """float: Radius setting for PreDisconnect.""" + ... + + @PreDisconnectRadius.setter + def PreDisconnectRadius(self, value: float) -> None: + """Set property value.""" + ... + + @property + def Smoothing(self) -> bool: + """bool: Whether to do smoothing.""" + ... + + @Smoothing.setter + def Smoothing(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def SmoothingLevel(self) -> int: + """int: Smoothing levels.""" + ... + + @SmoothingLevel.setter + def SmoothingLevel(self, value: int) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def LoadDefaults(self) -> None: + """Loads the default values of the Search Body parameters.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class SeedCollection(ApiDataObject): + """Represents a collection of brachytherapy""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def BrachyFieldReferencePoints(self) -> List[BrachyFieldReferencePoint]: + """List[BrachyFieldReferencePoint]: Obsolete.""" + ... + + @property + def Color(self) -> Color: + """Color: The color of the seeds in the seed collection in the views.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def SourcePositions(self) -> List[SourcePosition]: + """List[SourcePosition]: The source positions in this collection in creation order.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class SegmentVolume(SerializableObject): + """The volumetric representation of a structure. This object is used when defining margins for structures, or when performing Boolean operations on structures.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def And(self, other: SegmentVolume) -> SegmentVolume: + """Method docstring.""" + ... + + def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Margin(self, marginInMM: float) -> SegmentVolume: + """Method docstring.""" + ... + + def Not(self) -> SegmentVolume: + """Creates a combination of segment volumes. Does not modify this segment volume. The combination includes the area that covers everything else but this segment volume. + + Returns: + SegmentVolume: A new combined segment volume.""" + ... + + def Or(self, other: SegmentVolume) -> SegmentVolume: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def Sub(self, other: SegmentVolume) -> SegmentVolume: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + def Xor(self, other: SegmentVolume) -> SegmentVolume: + """Method docstring.""" + ... + + +class SerializableObject: + """Base class for objects that can be serialized.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @staticmethod + def ClearSerializationHistory() -> None: + """This member is internal to the Eclipse Scripting API.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """This member is internal to the Eclipse Scripting API. + + Returns: + XmlSchema: XmlSchema""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Series(ApiDataObject): + """A series is a collection of radiation therapy objects of a patient. The series is part of a study. See the definition of a DICOM Series for more information.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def FOR(self) -> str: + """str: The UID of the frame of reference.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Images(self) -> List[Image]: + """List[Image]: A collection of images that belong to the series.""" + ... + + @property + def ImagingDeviceDepartment(self) -> str: + """str: The assigned department of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device department is not defined.""" + ... + + @property + def ImagingDeviceId(self) -> str: + """str: The identifier of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device identifier is not defined.""" + ... + + @property + def ImagingDeviceManufacturer(self) -> str: + """str: The manufacturer of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device manufacturer is not defined.""" + ... + + @property + def ImagingDeviceModel(self) -> str: + """str: The model of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device model is not defined.""" + ... + + @property + def ImagingDeviceSerialNo(self) -> str: + """str: The serial number of the device that is used to scan the images into the system. Returns an empty string if the imaging device is not unique or the device serial number is not defined.""" + ... + + @property + def Modality(self) -> SeriesModality: + """SeriesModality: The modality of the series.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Study(self) -> Study: + """Study: Used for navigating to parent study.""" + ... + + @property + def UID(self) -> str: + """str: The DICOM UID.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def SetImagingDevice(self, imagingDeviceId: str) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class SingleThreadSynchronizationContext(SynchronizationContext): + """Provides a SynchronizationContext object that is single-threaded.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Complete(self) -> None: + """Notifies the context that no more work will arrive.""" + ... + + def CreateCopy(self) -> SynchronizationContext: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def IsWaitNotificationRequired(self) -> bool: + """Method docstring.""" + ... + + def OperationCompleted(self) -> None: + """Method docstring.""" + ... + + def OperationStarted(self) -> None: + """Method docstring.""" + ... + + def Post(self, d: SendOrPostCallback, state: Any) -> None: + """Method docstring.""" + ... + + def RunOnCurrentThread(self) -> None: + """Runs an loop to process all queued work items.""" + ... + + def Send(self, d: SendOrPostCallback, state: Any) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def Wait(self, waitHandles: Array[IntPtr], waitAll: bool, millisecondsTimeout: int) -> int: + """Method docstring.""" + ... + + +class SingleThreadSynchronizationContextSetter: + """Provides a temporary single-threaded environment until the diposal of this object (""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Complete(self) -> None: + """Method docstring.""" + ... + + def Dispose(self) -> None: + """Resets the SynchronizationContext.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def Run(self) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Slot(ApiDataObject): + """A slot is the location (typically on the collimator head of the gantry) where an add-on, such as a wedge or block, is mounted.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Number(self) -> int: + """int: The slot number is unique within an instance of a treatment machine.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class SourcePosition(ApiDataObject): + """Represents a brachytherapy source dwell position in a""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def DwellTime(self) -> float: + """float: Dwell time.""" + ... + + @property + def DwellTimeLock(self) -> Optional[bool]: + """Optional[bool]: Identifies if the dwell time is locked. Set dwell time either locked = true, or unlocked = false. Locked when not allowed to change the dwell time. If unlocked, the dwell time can be changed.""" + ... + + @DwellTimeLock.setter + def DwellTimeLock(self, value: Optional[bool]) -> None: + """Set property value.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def NominalDwellTime(self) -> float: + """float: The nominal dwell time associated with this source position in seconds.""" + ... + + @NominalDwellTime.setter + def NominalDwellTime(self, value: float) -> None: + """Set property value.""" + ... + + @property + def RadioactiveSource(self) -> RadioactiveSource: + """RadioactiveSource: The radioactive source associated with this dwell position.""" + ... + + @property + def Transform(self) -> Array[float]: + """Array[float]: The 4x4 transformation matrix represents the orientation and location of the source position in space. The matrix is composed of a 4x3 rotation submatrix and a 4x1 translation vector. Its bottom row indicates scaling and is always [0 0 0 1]. The translation vector indicates the coordinates of the source position center, in millimeters. The third column of the rotation matrix indicates the source axis direction.""" + ... + + @property + def Translation(self) -> VVector: + """VVector: The translation of this source position.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class StandardWedge(Wedge): + """A standard wedge is a physical piece of material with an angle that is static during treatment.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def Direction(self) -> float: + """float: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def WedgeAngle(self) -> float: + """float: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Structure(ApiDataObject): + """A structure is a geometrical representation of an anatomical organ, a treatment volume, a marker, or a support structure. See the definition of a DICOM Structure for more information.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApprovalHistory(self) -> List[StructureApprovalHistoryEntry]: + """List[StructureApprovalHistoryEntry]: Returns the approval history of the structure.""" + ... + + @property + def CenterPoint(self) -> VVector: + """VVector: The center point of the structure.""" + ... + + @property + def Color(self) -> Color: + """Color: The color of the structure.""" + ... + + @Color.setter + def Color(self, value: Color) -> None: + """Set property value.""" + ... + + @property + def Comment(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] A comment about the Structure.""" + ... + + @Comment.setter + def Comment(self, value: str) -> None: + """Set property value.""" + ... + + @property + def DicomType(self) -> str: + """str: The DICOM type of the structure, for example, PTV, MARKER, or ORGAN.""" + ... + + @property + def HasCalculatedPlans(self) -> bool: + """bool: Checks if a calculated plan exists for the structure""" + ... + + @property + def HasSegment(self) -> bool: + """bool: Checks if the structure has a segment.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The identifier of the Structure.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def IsApproved(self) -> bool: + """bool: Checks if the structure is approved""" + ... + + @property + def IsEmpty(self) -> bool: + """bool: Checks if the structure is empty.""" + ... + + @property + def IsHighResolution(self) -> bool: + """bool: true if this structure is a high-resolution structure. Otherwise false.""" + ... + + @property + def IsTarget(self) -> bool: + """bool: Checks if the structure is PTV, CTV or GTV""" + ... + + @property + def MeshGeometry(self) -> MeshGeometry3D: + """MeshGeometry3D: The mesh geometry.""" + ... + + @property + def Name(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The name of the Structure.""" + ... + + @Name.setter + def Name(self, value: str) -> None: + """Set property value.""" + ... + + @property + def ROINumber(self) -> int: + """int: The DICOM ROI Number of the structure.""" + ... + + @property + def SegmentVolume(self) -> SegmentVolume: + """SegmentVolume: Provides access to the segment volume of the structure.""" + ... + + @SegmentVolume.setter + def SegmentVolume(self, value: SegmentVolume) -> None: + """Set property value.""" + ... + + @property + def StructureCode(self) -> StructureCode: + """StructureCode: The structure code that identifies this structure.""" + ... + + @StructureCode.setter + def StructureCode(self, value: StructureCode) -> None: + """Set property value.""" + ... + + @property + def StructureCodeInfos(self) -> List[StructureCodeInfo]: + """List[StructureCodeInfo]: Property docstring.""" + ... + + @property + def Volume(self) -> float: + """float: The calculated volume.""" + ... + + def AddContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: + """Method docstring.""" + ... + + def And(self, other: SegmentVolume) -> SegmentVolume: + """Method docstring.""" + ... + + def AsymmetricMargin(self, margins: AxisAlignedMargins) -> SegmentVolume: + """Method docstring.""" + ... + + def CanConvertToHighResolution(self) -> bool: + """Returns true if this structure can be converted to a high-resolution structure. + + Returns: + bool: true if this structure can be converted to a high-resolution structure.""" + ... + + def CanEditSegmentVolume(self, errorMessage: str) -> bool: + """Method docstring.""" + ... + + def CanSetAssignedHU(self, errorMessage: str) -> bool: + """Method docstring.""" + ... + + def ClearAllContoursOnImagePlane(self, z: int) -> None: + """Method docstring.""" + ... + + def ConvertDoseLevelToStructure(self, dose: Dose, doseLevel: DoseValue) -> None: + """Method docstring.""" + ... + + def ConvertToHighResolution(self) -> None: + """[Availability of this method depends on your Eclipse Scripting API license] Converts this structure to a high-resolution structure. Increases the resolution of the segment volume in cases where the image size is larger than 256x256 voxels. + + Raises: + System.InvalidOperationException: Can not convert this structure.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetAssignedHU(self, huValue: float) -> bool: + """Method docstring.""" + ... + + def GetContoursOnImagePlane(self, z: int) -> Array[Array[VVector]]: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetNumberOfSeparateParts(self) -> int: + """If the structure has a segment, returns the number of separate parts. + + Returns: + int: Returns the number of separate parts in this structure""" + ... + + def GetReferenceLinePoints(self) -> Array[VVector]: + """If the structure is a reference line, gets its points. + + Returns: + Array[VVector]: An array that holds the points defining the reference line. If no reference line exists, the array is empty.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetSegmentProfile(self, start: VVector, stop: VVector, preallocatedBuffer: BitArray) -> SegmentProfile: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def IsPointInsideSegment(self, point: VVector) -> bool: + """Method docstring.""" + ... + + def Margin(self, marginInMM: float) -> SegmentVolume: + """Method docstring.""" + ... + + def Not(self) -> SegmentVolume: + """Boolean Not operation for structures that have a segment model. Provided here for convenience. + + Returns: + SegmentVolume: A new combined segment volume.""" + ... + + def Or(self, other: SegmentVolume) -> SegmentVolume: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ResetAssignedHU(self) -> bool: + """[Availability of this method depends on your Eclipse Scripting API license] Resets the HU value of the material to "undefined". + + Returns: + bool: Returns true if the HU value was set to "undefined". Returns false, if the value could not be reset. This can happen if the material has been set to a structure.""" + ... + + def SetAssignedHU(self, huValue: float) -> None: + """Method docstring.""" + ... + + def Sub(self, other: SegmentVolume) -> SegmentVolume: + """Method docstring.""" + ... + + def SubtractContourOnImagePlane(self, contour: Array[VVector], z: int) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + def Xor(self, other: SegmentVolume) -> SegmentVolume: + """Method docstring.""" + ... + + +class StructureCode(SerializableObject): + """Represents a structure code and its coding scheme.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Code(self) -> str: + """str: The structure code as defined in the associated coding scheme.""" + ... + + @property + def CodeMeaning(self) -> str: + """str: The meaning of the structure code.""" + ... + + @property + def CodingScheme(self) -> str: + """str: The coding scheme of the structure code.""" + ... + + @property + def DisplayName(self) -> str: + """str: The display name of the code.""" + ... + + @property + def IsEncompassStructureCode(self) -> bool: + """bool: Indicates whether the structure code is an encompass structure code.""" + ... + + def Equals(self, other: StructureCode) -> bool: + """Method docstring.""" + ... + + @overload + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Returns the hash code for this structure code.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Returns a string that represents this object. + + Returns: + str: A string that represents this object.""" + ... + + def ToStructureCodeInfo(self) -> StructureCodeInfo: + """Returns a StructureCodeInfo object with the same coding scheme and code as in the current structure code object.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class StructureCodeDictionary: + """Represents a set of structure codes as defined by a structure code scheme. The class exposes the structure codes that are available through the implemented""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: Gets the number of structure code object key/value pairs in this structure code dictionary.""" + ... + + @property + def Item(self) -> StructureCode: + """StructureCode: Property docstring.""" + ... + + @property + def Keys(self) -> List[str]: + """List[str]: Gets a collection containing the structure code identifiers in this structure code dictionary.""" + ... + + @property + def Name(self) -> str: + """str: The name of the structure code scheme.""" + ... + + @property + def Values(self) -> List[StructureCode]: + """List[StructureCode]: Gets a collection containing the structure codes in this structure code dictionary.""" + ... + + @property + def Version(self) -> str: + """str: The version of the structure code scheme. May be an empty string, if not applicable to the scheme.""" + ... + + def ContainsKey(self, key: str) -> bool: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator[KeyValuePair[str, StructureCode]]: + """Returns an enumerator that iterates through the collection.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Returns a string that represents this object. + + Returns: + str: A string that represents this object.""" + ... + + def TryGetValue(self, key: str, value: StructureCode) -> bool: + """Method docstring.""" + ... + + SchemeNameFma: str + SchemeNameRadLex: str + SchemeNameSrt: str + SchemeNameVmsStructCode: str + +class StructureSet(ApiDataObject): + """A structure set is a container for structures of a patient, including anatomical organs, treatment volumes and markers, and support structures.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def ApplicationScriptLogs(self) -> List[ApplicationScriptLog]: + """List[ApplicationScriptLog]: The log entries of the script executions that have modified the structure set.""" + ... + + @property + def Comment(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] A comment about the structure set.""" + ... + + @Comment.setter + def Comment(self, value: str) -> None: + """Set property value.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The identifier of the structure set.""" + ... + + @Id.setter + def Id(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Image(self) -> Image: + """Image: Used for navigating to the image.""" + ... + + @property + def Name(self) -> str: + """str: [Availability of this property depends on your Eclipse Scripting API license] The name of the structure set.""" + ... + + @Name.setter + def Name(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Patient(self) -> Patient: + """Patient: Used for navigating to the patient.""" + ... + + @property + def Series(self) -> Series: + """Series: The series that contains this plan. Null if the plan is not connected to a series.""" + ... + + @property + def SeriesUID(self) -> str: + """str: The DICOM UID of the series that contains this structure set. Empty string if the structure set is not connected to a series.""" + ... + + @property + def Structures(self) -> List[Structure]: + """List[Structure]: Used for navigating to the child structures.""" + ... + + @property + def UID(self) -> str: + """str: DICOM UID.""" + ... + + def AddCouchStructures(self, couchModel: str, orientation: PatientOrientation, railA: RailPosition, railB: RailPosition, surfaceHU: Optional[float], interiorHU: Optional[float], railHU: Optional[float], addedStructures: ReadOnlyList, imageResized: bool, error: str) -> bool: + """Method docstring.""" + ... + + def AddReferenceLine(self, name: str, id: str, referenceLinePoints: Array[VVector]) -> Structure: + """Method docstring.""" + ... + + def AddStructure(self, dicomType: str, id: str) -> Structure: + """Method docstring.""" + ... + + @overload + def AddStructure(self, code: StructureCodeInfo) -> Structure: + """Method docstring.""" + ... + + def CanAddCouchStructures(self, error: str) -> bool: + """Method docstring.""" + ... + + def CanAddStructure(self, dicomType: str, id: str) -> bool: + """Method docstring.""" + ... + + def CanRemoveCouchStructures(self, error: str) -> bool: + """Method docstring.""" + ... + + def CanRemoveStructure(self, structure: Structure) -> bool: + """Method docstring.""" + ... + + def Copy(self) -> StructureSet: + """[Availability of this method depends on your Eclipse Scripting API license] Creates a copy of this structure set. + + Returns: + StructureSet: The newly created copy of the structure set.""" + ... + + def CreateAndSearchBody(self, parameters: SearchBodyParameters) -> Structure: + """Method docstring.""" + ... + + def Delete(self) -> None: + """[Availability of this method depends on your Eclipse Scripting API license] Deletes this structure set.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetDefaultSearchBodyParameters(self) -> SearchBodyParameters: + """Gets a default set of Search Body parameters. + + Returns: + SearchBodyParameters: Parameters for the Search Body feature.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def RemoveCouchStructures(self, removedStructureIds: ReadOnlyList, error: str) -> bool: + """Method docstring.""" + ... + + def RemoveStructure(self, structure: Structure) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Study(ApiDataObject): + """A study is a collection of series.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: The date when this object was created.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Images3D(self) -> List[Image]: + """List[Image]: A collection of 3D images in a study.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Series(self) -> List[Series]: + """List[Series]: A collection of series.""" + ... + + @property + def UID(self) -> str: + """str: The DICOM UID.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Technique(ApiDataObject): + """Treatment technique used for a beam. Can be, for example, static or arc, or (for proton beams) modulated scanning.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def IsArc(self) -> bool: + """bool: Returns the value true if the beam technique is 'ARC' or 'SRS ARC'.""" + ... + + @property + def IsModulatedScanning(self) -> bool: + """bool: Returns the value true if the beam technique is 'MODULAT_SCANNING'.""" + ... + + @property + def IsProton(self) -> bool: + """bool: Returns the value true if it is a proton beam.""" + ... + + @property + def IsScanning(self) -> bool: + """bool: Returns the value true if the beam technique is 'MODULAT_SCANNING' or 'UNIFORM_SCANNING'.""" + ... + + @property + def IsStatic(self) -> bool: + """bool: Returns the value true if the beam technique is 'STATIC' or 'SRS STATIC'.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class TradeoffExplorationContext: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def CanCreatePlanCollection(self) -> bool: + """bool: True if a plan collection can be created.""" + ... + + @property + def CanLoadSavedPlanCollection(self) -> bool: + """bool: True if a previously saved plan collection can be loaded.""" + ... + + @property + def CanUseHybridOptimizationInPlanGeneration(self) -> bool: + """bool: True if VMAT-IMRT hybrid optimization can be used in""" + ... + + @property + def CanUsePlanDoseAsIntermediateDose(self) -> bool: + """bool: True if plan dose can be used as intermediate dose in""" + ... + + @property + def CurrentDose(self) -> Dose: + """Dose: Dose at the current location on the Pareto surface (the current trade-offs). Returns null if no valid dose exists.""" + ... + + @property + def HasPlanCollection(self) -> bool: + """bool: True if the trade-off exploration context has a plan collection, so that the trade-offs can be explored using the""" + ... + + @HasPlanCollection.setter + def HasPlanCollection(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def TargetStructures(self) -> List[Structure]: + """List[Structure]: Target structures in trade-off exploration. These structures cannot be selected for trade-off exploration at the structure level. Homogeneity indices only apply to the target structures.""" + ... + + @property + def TradeoffObjectiveCandidates(self) -> List[OptimizationObjective]: + """List[OptimizationObjective]: Available optimization objectives that can be selected for trade-off exploration in multi-criteria optimization.""" + ... + + @property + def TradeoffObjectives(self) -> IReadOnlyCollection[TradeoffObjective]: + """IReadOnlyCollection[TradeoffObjective]: Trade-off objectives. If""" + ... + + @property + def TradeoffStructureCandidates(self) -> List[Structure]: + """List[Structure]: Available structures that can be selected for trade-off exploration in multi-criteria optimization. Only organs at risk can be used for trade-off exploration at the structure level.""" + ... + + def AddTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: + """Method docstring.""" + ... + + def AddTradeoffObjective(self, structure: Structure) -> bool: + """Method docstring.""" + ... + + @overload + def AddTradeoffObjective(self, objective: OptimizationObjective) -> bool: + """Method docstring.""" + ... + + def ApplyTradeoffExplorationResult(self) -> None: + """[Availability of this method depends on your Eclipse Scripting API license] Saves the trade-off exploration result. Also applies the trade-off exploration result to the plan setup for IMRT plans. For VMAT plans, to apply the results to the plan setup, an additional call to the""" + ... + + def CreateDeliverableVmatPlan(self, useIntermediateDose: bool) -> bool: + """Method docstring.""" + ... + + def CreatePlanCollection(self, continueOptimization: bool, intermediateDoseMode: TradeoffPlanGenerationIntermediateDoseMode, useHybridOptimizationForVmat: bool = 'False') -> bool: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetObjectiveCost(self, objective: TradeoffObjective) -> float: + """Method docstring.""" + ... + + def GetObjectiveLowerLimit(self, objective: TradeoffObjective) -> float: + """Method docstring.""" + ... + + def GetObjectiveUpperLimit(self, objective: TradeoffObjective) -> float: + """Method docstring.""" + ... + + def GetObjectiveUpperRestrictor(self, objective: TradeoffObjective) -> float: + """Method docstring.""" + ... + + def GetStructureDvh(self, structure: Structure) -> DVHData: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def LoadSavedPlanCollection(self) -> bool: + """Loads a previously saved plan collection and sets + + Returns: + bool: True if the plan collection was successfully loaded from the database.""" + ... + + def RemoveAllTradeoffObjectives(self) -> None: + """[Availability of this method depends on your Eclipse Scripting API license] Removes all the trade-off objectives of the current plan collection. Removing all trade-off objectives invalidates the current plan collection and sets""" + ... + + def RemovePlanCollection(self) -> None: + """[Availability of this method depends on your Eclipse Scripting API license] Removes the plan collection from the plan setup and database. Removing the plan collection sets""" + ... + + def RemoveTargetHomogeneityObjective(self, targetStructure: Structure) -> bool: + """Method docstring.""" + ... + + def RemoveTradeoffObjective(self, tradeoffObjective: TradeoffObjective) -> bool: + """Method docstring.""" + ... + + @overload + def RemoveTradeoffObjective(self, structure: Structure) -> bool: + """Method docstring.""" + ... + + def ResetToBalancedPlan(self) -> None: + """[Availability of this method depends on your Eclipse Scripting API license] Resets the costs of a trade-off objective to correspond to the balanced plan. If""" + ... + + def SetObjectiveCost(self, tradeoffObjective: TradeoffObjective, cost: float) -> None: + """Method docstring.""" + ... + + def SetObjectiveUpperRestrictor(self, tradeoffObjective: TradeoffObjective, restrictorValue: float) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class TradeoffObjective: + """Trade-off objective interface that consists of a set of optimization objectives.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Id(self) -> int: + """int: Identifier of the trade-off objective.""" + ... + + @property + def OptimizationObjectives(self) -> List[OptimizationObjective]: + """List[OptimizationObjective]: The collection of objectives that this trade-off objective represents.""" + ... + + @property + def Structure(self) -> Structure: + """Structure: Structure that this trade-off objective represents.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class TradeoffPlanGenerationIntermediateDoseMode: + """Enumeration that specifies the use of intermediate dose when optimizing a plan collection for trade-off exploring.""" + + Calculate: TradeoffPlanGenerationIntermediateDoseMode + NotUsed: TradeoffPlanGenerationIntermediateDoseMode + UsePlanDose: TradeoffPlanGenerationIntermediateDoseMode + +class Tray(AddOn): + """A tray add-on is a plate where blocks, compensators, and other beam modifying materials can be fixed to. The tray is inserted into a slot during the treatment of a beam.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class TreatmentPhase(ApiDataObject): + """Treatment phase.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def OtherInfo(self) -> str: + """str: Other info (notes).""" + ... + + @property + def PhaseGapNumberOfDays(self) -> int: + """int: Number of days between phases.""" + ... + + @property + def Prescriptions(self) -> List[RTPrescription]: + """List[RTPrescription]: A collection of RT prescriptions in the course.""" + ... + + @property + def TimeGapType(self) -> str: + """str: Type of the time gap.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class TreatmentSession(ApiDataObject): + """Treatment session.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def SessionNumber(self) -> int: + """int: Treatment session number.""" + ... + + @property + def SessionPlans(self) -> List[PlanTreatmentSession]: + """List[PlanTreatmentSession]: Plans in this treatment session.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class TreatmentUnitOperatingLimit(ApiDataObject): + """Describes the limits of a treatment unit parameter and provides descriptive information related to it.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Label(self) -> str: + """str: Gets the descriptive name of the operating limit parameter.""" + ... + + @property + def MaxValue(self) -> float: + """float: Gets the maximum allowed value for the operating limit parameter.""" + ... + + @property + def MinValue(self) -> float: + """float: Gets the minimum allowed value for the operating limit parameter.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def Precision(self) -> Optional[int]: + """Optional[int]: Gets the number of decimal places to display for the operating limit parameter.""" + ... + + @property + def UnitString(self) -> str: + """str: Gets the string that describes the unit of the operating limit parameter.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class TreatmentUnitOperatingLimits(SerializableObject): + """Provides operating limit information for treatment unit parameters.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def CollimatorAngle(self) -> TreatmentUnitOperatingLimit: + """TreatmentUnitOperatingLimit: Gets the operating limit information for the collimator angle parameter.""" + ... + + @property + def GantryAngle(self) -> TreatmentUnitOperatingLimit: + """TreatmentUnitOperatingLimit: Gets the operating limit information for the gantry angle parameter.""" + ... + + @property + def MU(self) -> TreatmentUnitOperatingLimit: + """TreatmentUnitOperatingLimit: Gets the operating limit information for the monitor unit (MU) parameter.""" + ... + + @property + def PatientSupportAngle(self) -> TreatmentUnitOperatingLimit: + """TreatmentUnitOperatingLimit: Gets the operating limit information for the patient support angle parameter.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class TypeBasedIdValidator: + """A utility class for validating the data object identifier.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + @staticmethod + def IsValidId(id: str, dataObject: ApiDataObject, errorHint: StringBuilder) -> bool: + """Method docstring.""" + ... + + @staticmethod + def ThrowIfNotValidId(id: str, dataObject: ApiDataObject) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class User(SerializableObject): + """Represents a user.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Id(self) -> str: + """str: The identifier of the user.""" + ... + + @property + def Language(self) -> str: + """str: The language of the user.""" + ... + + @property + def Name(self) -> str: + """str: The display name of the user.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Serves as a hash function for this type. + + Returns: + int: A hash code for the current Object.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Returns a string that represents the current object. + + Returns: + str: A string that represents the current object.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class VMATProgressStatus(ValueType): + """Class docstring.""" + + def __init__(self, status: str, iteration: int, progress: int) -> None: + """Initialize instance.""" + ... + + @property + def Iteration(self) -> int: + """int: Property docstring.""" + ... + + @property + def Progress(self) -> int: + """int: Property docstring.""" + ... + + @property + def Status(self) -> str: + """str: Property docstring.""" + ... + + def Equals(self, other: VMATProgressStatus) -> bool: + """Method docstring.""" + ... + + @overload + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class Wedge(AddOn): + """A wedge is a beam modulating add-on that modifies the dose intensity over all or a part of a treatment beam. + + Use run-time type information via operator""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def Comment(self) -> str: + """str: Property docstring.""" + ... + + @property + def CreationDateTime(self) -> Optional[datetime]: + """Optional[datetime]: Property docstring.""" + ... + + @property + def Direction(self) -> float: + """float: The wedge orientation with respect to the beam orientation, in degrees.""" + ... + + @property + def HistoryDateTime(self) -> datetime: + """datetime: Property docstring.""" + ... + + @property + def HistoryUserDisplayName(self) -> str: + """str: Property docstring.""" + ... + + @property + def HistoryUserName(self) -> str: + """str: Property docstring.""" + ... + + @property + def Id(self) -> str: + """str: Property docstring.""" + ... + + @property + def Name(self) -> str: + """str: Property docstring.""" + ... + + @property + def WedgeAngle(self) -> float: + """float: The wedge angle.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + diff --git a/pyesapi/VMS/TPS/Common/__init__.pyi b/pyesapi/stubs/VMS/TPS/Common/Model/Types/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Common/__init__.pyi rename to pyesapi/stubs/VMS/TPS/Common/Model/Types/__init__.py diff --git a/pyesapi/stubs/VMS/TPS/Common/Model/Types/__init__.pyi b/pyesapi/stubs/VMS/TPS/Common/Model/Types/__init__.pyi new file mode 100644 index 0000000..b541974 --- /dev/null +++ b/pyesapi/stubs/VMS/TPS/Common/Model/Types/__init__.pyi @@ -0,0 +1,3091 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Array, Enum, Type, ValueType +from System.Collections import BitArray, IEnumerator +from System.Xml import XmlReader, XmlWriter +from System.Xml.Schema import XmlSchema +from Microsoft.Win32 import RegistryHive +from System import AggregateException, ApplicationException, Exception, IComparable, TypeCode +from System.Collections import DictionaryBase +from System.Globalization import CultureInfo +from System.Reflection import MethodBase +from System.Runtime.InteropServices import _Exception +from System.Runtime.Serialization import SerializationInfo, StreamingContext +from VMS.TPS.Common.Model.API import AddOn + +class ApplicationScriptApprovalStatus: + """The approval statuses of the application script.""" + + Approved: ApplicationScriptApprovalStatus + ApprovedForEvaluation: ApplicationScriptApprovalStatus + Retired: ApplicationScriptApprovalStatus + Unapproved: ApplicationScriptApprovalStatus + Undefined: ApplicationScriptApprovalStatus + +class ApplicationScriptType: + """The type of the application script.""" + + ESAPI: ApplicationScriptType + ESAPIActionPack: ApplicationScriptType + ESAPIApprovalHook: ApplicationScriptType + ESAPICustomExecutable: ApplicationScriptType + MIRS: ApplicationScriptType + Unknown: ApplicationScriptType + +class ApprovalHistoryEntry(ValueType): + """An entry in the plan approval history.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + ApprovalDateTime: datetime + ApprovalStatus: PlanSetupApprovalStatus + StatusComment: str + UserDisplayName: str + UserId: str + +class AxisAlignedMargins(ValueType): + """Represents margins aligned to the axes of the image coordinate system, in mm. Negative margins are not allowed, but it is possible to specify whether the margins represent an inner or outer margin.""" + + def __init__(self, geometry: StructureMarginGeometry, x1: float, y1: float, z1: float, x2: float, y2: float, z2: float) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """A string that represents the current object. + + Returns: + str: A string that represents the current object.""" + ... + + Geometry: StructureMarginGeometry + X1: float + X2: float + Y1: float + Y2: float + Z1: float + Z2: float + +class BeamNumber(ValueType): + """Represents a unique identifier for a beam of a plan. The identifier is unique within the scope of the plan.""" + + def __init__(self, number: int) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, other: BeamNumber) -> None: + """Initialize instance.""" + ... + + @property + def IsValid(self) -> bool: + """bool: Returns true if the given BeamNumber is valid. Otherwise false.""" + ... + + @property + def Number(self) -> int: + """int: The beam number.""" + ... + + def Equals(self, other: Any) -> bool: + """Method docstring.""" + ... + + @overload + def Equals(self, other: BeamNumber) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Provides a hash code for the item, see + + Returns: + int: The hash code for this instance.""" + ... + + def GetSchema(self) -> XmlSchema: + """This member is internal to the Eclipse Scripting API. + + Returns: + XmlSchema: XmlSchema.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + NotABeamNumber: BeamNumber + +class BeamTechnique: + """An enumeration of beam techniques.""" + + Arc: BeamTechnique + ConformalArc: BeamTechnique + Invalid: BeamTechnique + MLC: BeamTechnique + MLCArc: BeamTechnique + MultipleStaticSegmentIMRT: BeamTechnique + ScanningProton: BeamTechnique + ScatteringProton: BeamTechnique + SlidingWindowIMRT: BeamTechnique + Static: BeamTechnique + VMAT: BeamTechnique + +class BlockType: + """A type flag that tells whether a block is an aperture block or a shielding block. An aperture block is used to limit the radiated area while a shielding block is made to protect a sensitive organ.""" + + APERTURE: BlockType + SHIELDING: BlockType + +class BrachyTreatmentTechniqueType: + """The enumeration of Brachytherapy treatment techniques.""" + + CONTACT: BrachyTreatmentTechniqueType + INTERSTITIAL: BrachyTreatmentTechniqueType + INTRACAVITARY: BrachyTreatmentTechniqueType + INTRALUMENARY: BrachyTreatmentTechniqueType + INTRAVASCULAR: BrachyTreatmentTechniqueType + NONE: BrachyTreatmentTechniqueType + PERMANENT: BrachyTreatmentTechniqueType + +class CalculationType: + """Calculation type.""" + + DVHEstimation: CalculationType + PhotonIMRTOptimization: CalculationType + PhotonLeafMotions: CalculationType + PhotonOptimization: CalculationType + PhotonSRSDose: CalculationType + PhotonVMATOptimization: CalculationType + PhotonVolumeDose: CalculationType + ProtonBeamDeliveryDynamics: CalculationType + ProtonBeamLineModifiers: CalculationType + ProtonDDC: CalculationType + ProtonDVHEstimation: CalculationType + ProtonMSPostProcessing: CalculationType + ProtonOptimization: CalculationType + ProtonVolumeDose: CalculationType + +class ChangeBrachyTreatmentUnitResult: + """Return value for""" + + Failed: ChangeBrachyTreatmentUnitResult + FailedBecausePlanContainsSeedCollections: ChangeBrachyTreatmentUnitResult + Success: ChangeBrachyTreatmentUnitResult + SuccessButPdrDataMissing: ChangeBrachyTreatmentUnitResult + +class ClinicalGoal(ValueType): + """Represents a clinical goal.""" + + def __init__(self, measureType: MeasureType, structureId: str, objective: Objective, objAsString: str, priority: GoalPriority, tolerance: float, toleranceAsString: str, actual: float, actualAsString: str, evalResult: GoalEvalResult) -> None: + """Initialize instance.""" + ... + + @property + def ActualValue(self) -> float: + """float: Clinical goal actual value""" + ... + + @property + def ActualValueAsString(self) -> str: + """str: String representation of clinical goal actual value""" + ... + + @property + def EvaluationResult(self) -> GoalEvalResult: + """GoalEvalResult: Evaluation result.""" + ... + + @property + def MeasureType(self) -> MeasureType: + """MeasureType: Clinical goal measure type""" + ... + + @property + def Objective(self) -> Objective: + """Objective: Clinical goal objective""" + ... + + @property + def ObjectiveAsString(self) -> str: + """str: String representation of clinical goal objective""" + ... + + @property + def Priority(self) -> GoalPriority: + """GoalPriority: Goal priority (0-4), where 0 is Most Important""" + ... + + @property + def StructureId(self) -> str: + """str: Clinical goal structure Id""" + ... + + @property + def VariationAcceptable(self) -> float: + """float: Clinical goal Variation Acceptable (tolerance)""" + ... + + @property + def VariationAcceptableAsString(self) -> str: + """str: String representation of clinical goal Variation Acceptable (tolerance)""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """This member is internal to the Eclipse Scripting API. + + Returns: + XmlSchema: XmlSchema.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ClosedLeavesMeetingPoint: + """Specifies where the closed MLC leaf pairs are parked in an MLC leaf fit operation. Bank_One: Varian = B, IEC MLCX = X1, IEC MLCY = Y1; Bank_Two: Varian = A, IEC MLCX = X2, IEC MLCY = Y2""" + + ClosedLeavesMeetingPoint_BankOne: ClosedLeavesMeetingPoint + ClosedLeavesMeetingPoint_BankTwo: ClosedLeavesMeetingPoint + ClosedLeavesMeetingPoint_Center: ClosedLeavesMeetingPoint + +class Component: + """VVector component indexing.""" + + X: Component + Y: Component + Z: Component + +class CourseClinicalStatus: + """Clinical Status of Course""" + + Active: CourseClinicalStatus + Completed: CourseClinicalStatus + Null: CourseClinicalStatus + Restored: CourseClinicalStatus + +class DRRCalculationParameters: + """Parameters for DRR calculation.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, drrSize: float) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, drrSize: float, weight: float, ctFrom: float, ctTo: float) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, drrSize: float, weight: float, ctFrom: float, ctTo: float, geoFrom: float, geoTo: float) -> None: + """Initialize instance.""" + ... + + @property + def DRRSize(self) -> float: + """float: DRR size. Decreasing the size of the DRR effectively increases the resolution of the DRR. Value must be between 5 and 5120 mm.""" + ... + + @DRRSize.setter + def DRRSize(self, value: float) -> None: + """Set property value.""" + ... + + @property + def FieldOutlines(self) -> bool: + """bool: Defines if field outlines (MLC, CIAO etc.) are added as layers in the DRR.""" + ... + + @FieldOutlines.setter + def FieldOutlines(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def StructureOutlines(self) -> bool: + """bool: Defines if structure outlines are added as layers in the DRR.""" + ... + + @StructureOutlines.setter + def StructureOutlines(self, value: bool) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetLayerParameters(self, index: int) -> SingleLayerParameters: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def SetLayerParameters(self, index: int, weight: float, ctFrom: float, ctTo: float) -> None: + """Method docstring.""" + ... + + @overload + def SetLayerParameters(self, index: int, weight: float, ctFrom: float, ctTo: float, geoFrom: float, geoTo: float) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class DVHEstimateType: + """Represents the type of a DVH estimate curve""" + + Lower: DVHEstimateType + Undefined: DVHEstimateType + Upper: DVHEstimateType + +class DVHEstimationStructureType: + """Structure type as defined in Planning Model Library: PTV or OAR""" + + AVOIDANCE: DVHEstimationStructureType + Null: DVHEstimationStructureType + PTV: DVHEstimationStructureType + +class DVHPoint(ValueType): + """Represents a value on a Dose Volume Histogram (DVH) curve.""" + + def __init__(self, dose: DoseValue, volume: float, volumeUnit: str) -> None: + """Initialize instance.""" + ... + + @property + def DoseValue(self) -> DoseValue: + """DoseValue: The dose value of the point.""" + ... + + @property + def Volume(self) -> float: + """float: The volume value of the point.""" + ... + + @property + def VolumeUnit(self) -> str: + """str: The volume unit of the point.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """This member is internal to the Eclipse Scripting API. + + Returns: + XmlSchema: XmlSchema.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class DefaultDoseValueSettings: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Decimals(self, unit: DoseUnit) -> int: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class DefaultDoseValueSettings: + """Class docstring.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Decimals(self, unit: DoseUnit) -> int: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class DoseProfile(LineProfile): + """Represents a dose profile.""" + + def __init__(self, origin: VVector, step: VVector, data: Array[float], unit: DoseUnit) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: Property docstring.""" + ... + + @property + def Item(self) -> ProfilePoint: + """ProfilePoint: Property docstring.""" + ... + + @property + def Unit(self) -> DoseUnit: + """DoseUnit: The unit of the points on this dose profile.""" + ... + + @Unit.setter + def Unit(self, value: DoseUnit) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator[ProfilePoint]: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class DoseUnit: + """The unit of the dose value.""" + + Gy: DoseUnit + Percent: DoseUnit + Unknown: DoseUnit + cGy: DoseUnit + +class DoseUnit: + """The unit of the dose value.""" + + Gy: DoseUnit + Percent: DoseUnit + Unknown: DoseUnit + cGy: DoseUnit + +class DoseValue(ValueType): + """Represents a dose value. DoseValue semantics follows the semantics of System.Double, with DoseValue.Undefined corresponding to Double.NaN.""" + + def __init__(self, value: float, unitName: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, value: float, unit: DoseUnit) -> None: + """Initialize instance.""" + ... + + @property + def Decimals(self) -> int: + """int: The display precision of this value""" + ... + + @property + def Dose(self) -> float: + """float: The value of this instance.""" + ... + + @property + def IsAbsoluteDoseValue(self) -> bool: + """bool: Returns true if the unit of the dose value is absolute (Gy or cGy).""" + ... + + @property + def IsRelativeDoseValue(self) -> bool: + """bool: Returns true if the unit of the dose value is relative (%).""" + ... + + @property + def Unit(self) -> DoseUnit: + """DoseUnit: The unit of this instance.""" + ... + + @property + def UnitAsString(self) -> str: + """str: The unit of this instance as a string.""" + ... + + @property + def ValueAsString(self) -> str: + """str: The value of this instance as a string.""" + ... + + def CompareTo(self, other: DoseValue) -> int: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + @overload + def Equals(self, other: DoseValue) -> bool: + """Method docstring.""" + ... + + @overload + def Equals(self, other: DoseValue, epsilon: float) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """A hash code for the current object. + + Returns: + int: A hash code for the current object.""" + ... + + def GetSchema(self) -> XmlSchema: + """This member is internal to the Eclipse Scripting API. + + Returns: + XmlSchema: XmlSchema.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + @staticmethod + def IsAbsoluteDoseUnit(doseUnit: DoseUnit) -> bool: + """Method docstring.""" + ... + + @staticmethod + def IsRelativeDoseUnit(doseUnit: DoseUnit) -> bool: + """Method docstring.""" + ... + + def IsUndefined(self) -> bool: + """Returns true if this dose value is equal to DoseValue.Undefined, false otherwise. + + Returns: + bool: True if this dose value is not defined, false otherwise.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """A string that represents the current object. + + Returns: + str: A string that represents the current object.""" + ... + + @staticmethod + def UndefinedDose() -> DoseValue: + """A dose value, for which the value is Double.NaN and the unit is unknown. + + Returns: + DoseValue: Undefined dose value.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + Undefined: DoseValue + +class DoseValueDisplayConfig: + """Configure the settings related to the dose value display for the application. Defaults to the same settings as Eclipse.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @classmethod + @property + def DisplaySettings(cls) -> DefaultDoseValueSettings: + """DefaultDoseValueSettings: Get and set current dosevalue display settings. Set settings controller to null reverts to default display settings.""" + ... + + @classmethod + @DisplaySettings.setter + def DisplaySettings(cls, value: DefaultDoseValueSettings) -> None: + """Set property value.""" + ... + + @staticmethod + def Decimals(unit: DoseUnit) -> int: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class DoseValuePresentation: + """Types of presentation for dose values.""" + + Absolute: DoseValuePresentation + Relative: DoseValuePresentation + +class DosimeterUnit: + """The dosimeter unit.""" + + MU: DosimeterUnit + Minute: DosimeterUnit + Null: DosimeterUnit + Second: DosimeterUnit + +class ExternalBeamMachineParameters: + """The parameters for the external beam treatment unit.""" + + def __init__(self, machineId: str, energyModeId: str, doseRate: int, techniqueId: str, primaryFluenceModeId: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, machineId: str) -> None: + """Initialize instance.""" + ... + + @property + def DoseRate(self) -> int: + """int: Dose rate value.""" + ... + + @DoseRate.setter + def DoseRate(self, value: int) -> None: + """Set property value.""" + ... + + @property + def EnergyModeId(self) -> str: + """str: The energy mode identifier. For example, "6X", or "18X".""" + ... + + @EnergyModeId.setter + def EnergyModeId(self, value: str) -> None: + """Set property value.""" + ... + + @property + def MLCId(self) -> str: + """str: Optional MLC identifier. If null (which is the default) then the single MLC of the treatment unit is selected.""" + ... + + @MLCId.setter + def MLCId(self, value: str) -> None: + """Set property value.""" + ... + + @property + def MachineId(self) -> str: + """str: The treatment unit identifier.""" + ... + + @MachineId.setter + def MachineId(self, value: str) -> None: + """Set property value.""" + ... + + @property + def PrimaryFluenceModeId(self) -> str: + """str: Primary Fluence Mode identifier. Acceptable values are: null, empty string, "SRS","FFF".""" + ... + + @PrimaryFluenceModeId.setter + def PrimaryFluenceModeId(self, value: str) -> None: + """Set property value.""" + ... + + @property + def TechniqueId(self) -> str: + """str: Technique identifier. Typically "STATIC" or "ARC".""" + ... + + @TechniqueId.setter + def TechniqueId(self, value: str) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class FitToStructureMarginType: + """Margin type""" + + Circular: FitToStructureMarginType + Elliptical: FitToStructureMarginType + +class FitToStructureMargins(ValueType): + """Margins that are used when fitting a field device to a structure from the BEV perspective""" + + def __init__(self, x1: float, y1: float, x2: float, y2: float) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, margin: float) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """A string that represents the current object. + + Returns: + str: A string that represents the current object.""" + ... + + Type: FitToStructureMarginType + X1: float + X2: float + Y1: float + Y2: float + +class Fluence: + """Represents the fluence for a beam. The resolution in the fluence matrix is 2.5 mm in x and y directions. In the fluence matrix, x dimension is the number of columns, and y dimension is the number of rows.""" + + def __init__(self, fluenceMatrix: Array[float], xOrigin: float, yOrigin: float) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, fluenceMatrix: Array[float], xOrigin: float, yOrigin: float, mlcId: str) -> None: + """Initialize instance.""" + ... + + @property + def MLCId(self) -> str: + """str: The identifier of the MLC that is related to the fluence. The value can be empty or null.""" + ... + + @MLCId.setter + def MLCId(self, value: str) -> None: + """Set property value.""" + ... + + @classmethod + @property + def MaxSizePixel(cls) -> int: + """int: The maximum size of pixels for x or y dimension in the fluence.""" + ... + + @property + def XOrigin(self) -> float: + """float: The x coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system.""" + ... + + @XOrigin.setter + def XOrigin(self, value: float) -> None: + """Set property value.""" + ... + + @property + def XSizeMM(self) -> float: + """float: The size of x dimension in mm for the fluence. The resolution is 2.5 mm in x and y directions.""" + ... + + @property + def XSizePixel(self) -> int: + """int: The size of x dimension in pixels for the fluence. This corresponds to the number of columns in the pixels matrix.""" + ... + + @property + def YOrigin(self) -> float: + """float: The y coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system.""" + ... + + @YOrigin.setter + def YOrigin(self, value: float) -> None: + """Set property value.""" + ... + + @property + def YSizeMM(self) -> float: + """float: The size of y dimension in mm for the fluence. The resolution is 2.5 mm in x and y directions.""" + ... + + @property + def YSizePixel(self) -> int: + """int: The size of y dimension in pixels for the fluence. This corresponds to the number of rows in the pixels matrix.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetPixels(self) -> Array[float]: + """Returns the fluence matrix. + + Returns: + Array[float]: The pixel values for the fluence as described in""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class GantryDirection: + """The enumeration of gantry rotation directions.""" + + Clockwise: GantryDirection + CounterClockwise: GantryDirection + None_: GantryDirection + +class GoalEvalResult: + """Clinical Goal Evaluation Result""" + + Failed: GoalEvalResult + NA: GoalEvalResult + Passed: GoalEvalResult + WithinVariationAcceptable: GoalEvalResult + +class GoalPriority: + """Clinical Goal Priority""" + + Important: GoalPriority + LessImportant: GoalPriority + MostImportant: GoalPriority + ReportValueOnly: GoalPriority + VeryImportant: GoalPriority + +class IDoseValueDisplaySettings: + """Application specific dose value display settings.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Decimals(self, unit: DoseUnit) -> int: + """Method docstring.""" + ... + + +class ImageApprovalHistoryEntry(ValueType): + """An entry in the image approval history.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + ApprovalDateTime: datetime + ApprovalStatus: ImageApprovalStatus + StatusComment: str + UserDisplayName: str + UserId: str + +class ImageApprovalStatus: + """The enumeration of image approval statuses.""" + + ActionRequired: ImageApprovalStatus + Approved: ImageApprovalStatus + Disposed: ImageApprovalStatus + New: ImageApprovalStatus + Reviewed: ImageApprovalStatus + +class ImageProfile(LineProfile): + """Represents an image line profile.""" + + def __init__(self, origin: VVector, step: VVector, data: Array[float], unit: str) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: Property docstring.""" + ... + + @property + def Item(self) -> ProfilePoint: + """ProfilePoint: Property docstring.""" + ... + + @property + def Unit(self) -> str: + """str: The unit of the points on the image profile.""" + ... + + @Unit.setter + def Unit(self, value: str) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator[ProfilePoint]: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class ImagingBeamSetupParameters: + """Setup parameters for imaging fields.""" + + def __init__(self, imagingSetup: ImagingSetup, fitMarginX1_mm: float, fitMarginX2_mm: float, fitMarginY1_mm: float, fitMarginY2_mm: float, fieldSizeX_mm: float, fieldSizeY_mm: float) -> None: + """Initialize instance.""" + ... + + @property + def FieldSizeX(self) -> float: + """float: Field size in x-direction in mm.""" + ... + + @FieldSizeX.setter + def FieldSizeX(self, value: float) -> None: + """Set property value.""" + ... + + @property + def FieldSizeY(self) -> float: + """float: Field size in y-direction in mm.""" + ... + + @FieldSizeY.setter + def FieldSizeY(self, value: float) -> None: + """Set property value.""" + ... + + @property + def FitMarginX1(self) -> float: + """float: Fit margin in x-direction in mm.""" + ... + + @FitMarginX1.setter + def FitMarginX1(self, value: float) -> None: + """Set property value.""" + ... + + @property + def FitMarginX2(self) -> float: + """float: Fit margin in x-direction in mm.""" + ... + + @FitMarginX2.setter + def FitMarginX2(self, value: float) -> None: + """Set property value.""" + ... + + @property + def FitMarginY1(self) -> float: + """float: Fit margin in y-direction in mm.""" + ... + + @FitMarginY1.setter + def FitMarginY1(self, value: float) -> None: + """Set property value.""" + ... + + @property + def FitMarginY2(self) -> float: + """float: Fit margin in y-direction in mm.""" + ... + + @FitMarginY2.setter + def FitMarginY2(self, value: float) -> None: + """Set property value.""" + ... + + @property + def ImagingSetup(self) -> ImagingSetup: + """ImagingSetup: Identifier for the imaging setup.""" + ... + + @ImagingSetup.setter + def ImagingSetup(self, value: ImagingSetup) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class ImagingSetup: + """Set of available imaging setups.""" + + MVCBCT_High_Quality: ImagingSetup + MVCBCT_Low_Dose: ImagingSetup + MV_MV_High_Quality: ImagingSetup + MV_MV_Low_Dose: ImagingSetup + kVCBCT: ImagingSetup + +class IonBeamScanMode: + """The method of beam scanning to be used during treatment. Used with IonBeams.""" + + Line: IonBeamScanMode + Modulated: IonBeamScanMode + None_: IonBeamScanMode + Uniform: IonBeamScanMode + Unknown: IonBeamScanMode + Wobbling: IonBeamScanMode + +class IonPlanNormalizationParameters: + """The parameters for proton plan normalization.""" + + def __init__(self, normalizationMode: PlanNormalizationMode, normalizationValue: float, volumePercentage: float) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, normalizationMode: PlanNormalizationMode, normalizationValue: float) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, normalizationMode: PlanNormalizationMode) -> None: + """Initialize instance.""" + ... + + @property + def NormalizationMode(self) -> PlanNormalizationMode: + """PlanNormalizationMode: Normalization mode.""" + ... + + @property + def NormalizationValue(self) -> float: + """float: The treatment unit identifier.""" + ... + + @property + def VolumePercentage(self) -> float: + """float: Volume percentage factor.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class IonPlanOptimizationMode: + """Proton plan optimization mode.""" + + MultiFieldOptimization: IonPlanOptimizationMode + SingleFieldOptimization: IonPlanOptimizationMode + +class JawFitting: + """Specifies where collimator jaws are positioned in an MLC leaf fit operation.""" + + FitToRecommended: JawFitting + FitToStructure: JawFitting + None_: JawFitting + +class LMCMSSOptions: + """Options for calculating leaf motions using the non-Varian MSS Leaf Motion Calculator (LMCMSS) algorithm.""" + + def __init__(self, numberOfIterations: int) -> None: + """Initialize instance.""" + ... + + @property + def NumberOfIterations(self) -> int: + """int: The number of calculation iterations.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class LMCVOptions: + """Options for calculating leaf motions using the Varian Leaf Motion Calculator (LMCV) algorithm.""" + + def __init__(self, fixedJaws: bool) -> None: + """Initialize instance.""" + ... + + @property + def FixedJaws(self) -> bool: + """bool: Use the Fixed jaws option.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class LateralSpreadingDeviceType: + """Type of the lateral spreading device.""" + + Magnet: LateralSpreadingDeviceType + Scatterer: LateralSpreadingDeviceType + +class LineProfile: + """Represents values along a line segment.""" + + def __init__(self, origin: VVector, step: VVector, data: Array[float]) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: The number of points in the profile.""" + ... + + @property + def Item(self) -> ProfilePoint: + """ProfilePoint: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator[ProfilePoint]: + """An enumerator for the points in the profile. + + Returns: + IEnumerator[ProfilePoint]: Enumerator for points in the profile.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class LogSeverity: + """The enumeration of log severities.""" + + Alert: LogSeverity + Debug: LogSeverity + Emergency: LogSeverity + Error: LogSeverity + Info: LogSeverity + Warning: LogSeverity + +class MLCPlanType: + """The enumeration of Multileaf Collimator (MLC) techniques.""" + + ArcDynamic: MLCPlanType + DoseDynamic: MLCPlanType + NotDefined: MLCPlanType + ProtonLayerStacking: MLCPlanType + Static: MLCPlanType + VMAT: MLCPlanType + +class MeasureModifier: + """Measure modifier""" + + MeasureModifierAtLeast: MeasureModifier + MeasureModifierAtMost: MeasureModifier + MeasureModifierNone: MeasureModifier + MeasureModifierTarget: MeasureModifier + +class MeasureType: + """Enumeration of plan measure types.""" + + MeasureTypeDQP_DXXX: MeasureType + MeasureTypeDQP_DXXXcc: MeasureType + MeasureTypeDQP_VXXX: MeasureType + MeasureTypeDQP_VXXXGy: MeasureType + MeasureTypeDoseConformity: MeasureType + MeasureTypeDoseMax: MeasureType + MeasureTypeDoseMean: MeasureType + MeasureTypeDoseMin: MeasureType + MeasureTypeGradient: MeasureType + MeasureTypeNone: MeasureType + +class MetersetValue(ValueType): + """Represents a meterset value.""" + + def __init__(self, value: float, unit: DosimeterUnit) -> None: + """Initialize instance.""" + ... + + @property + def Unit(self) -> DosimeterUnit: + """DosimeterUnit: The unit of this instance.""" + ... + + @Unit.setter + def Unit(self, value: DosimeterUnit) -> None: + """Set property value.""" + ... + + @property + def Value(self) -> float: + """float: The value of this instance.""" + ... + + @Value.setter + def Value(self, value: float) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """This member is internal to the Eclipse Scripting API. + + Returns: + XmlSchema: XmlSchema.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class Objective(ValueType): + """Represents a clinical goal objective.""" + + def __init__(self, type: ObjectiveGoalType, value: float, valueUnit: ObjectiveUnit, oper: ObjectiveOperator, limit: float, limitUnit: ObjectiveUnit) -> None: + """Initialize instance.""" + ... + + @property + def Limit(self) -> float: + """float: Objective limit""" + ... + + @property + def LimitUnit(self) -> ObjectiveUnit: + """ObjectiveUnit: Objective limit unit""" + ... + + @property + def Operator(self) -> ObjectiveOperator: + """ObjectiveOperator: Objective operator""" + ... + + @property + def Type(self) -> ObjectiveGoalType: + """ObjectiveGoalType: Objective type""" + ... + + @property + def Value(self) -> float: + """float: Objective value""" + ... + + @property + def ValueUnit(self) -> ObjectiveUnit: + """ObjectiveUnit: Objective value""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetSchema(self) -> XmlSchema: + """This member is internal to the Eclipse Scripting API. + + Returns: + XmlSchema: XmlSchema.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class ObjectiveGoalType: + """Clinical goal Objective type""" + + ConformityIndex: ObjectiveGoalType + Dose: ObjectiveGoalType + GradientMeasure: ObjectiveGoalType + Invalid: ObjectiveGoalType + Maximum_Dose: ObjectiveGoalType + Mean_Dose: ObjectiveGoalType + Minimum_Dose: ObjectiveGoalType + Prescription: ObjectiveGoalType + Volume: ObjectiveGoalType + +class ObjectiveOperator: + """Clinical goal Objective operator""" + + Equals: ObjectiveOperator + GreaterThan: ObjectiveOperator + GreaterThanOrEqual: ObjectiveOperator + LessThan: ObjectiveOperator + LessThanOrEqual: ObjectiveOperator + None_: ObjectiveOperator + +class ObjectiveUnit: + """Clinical goal Objective Unit""" + + Absolute: ObjectiveUnit + None_: ObjectiveUnit + Relative: ObjectiveUnit + +class OpenLeavesMeetingPoint: + """Specifies where the open MLC leaves meet the structure outline in an MLC leaf fit operation.""" + + OpenLeavesMeetingPoint_Inside: OpenLeavesMeetingPoint + OpenLeavesMeetingPoint_Middle: OpenLeavesMeetingPoint + OpenLeavesMeetingPoint_Outside: OpenLeavesMeetingPoint + +class OptimizationAvoidanceSector(ValueType): + """Avoidance sector details.""" + + def __init__(self, startAngle: float, stopAngle: float) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, startAngle: float, stopAngle: float, isValid: bool, validationError: str) -> None: + """Initialize instance.""" + ... + + @property + def IsDefined(self) -> bool: + """bool: Is Avoidance Sector defined. True if either startAngle or stopAngle is defined.""" + ... + + @property + def StartAngle(self) -> float: + """float: Start angle.""" + ... + + @property + def StopAngle(self) -> float: + """float: Stop angle.""" + ... + + @property + def Valid(self) -> bool: + """bool: Is Avoidance Sector valid.""" + ... + + @property + def ValidationError(self) -> str: + """str: Validation error.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class OptimizationConvergenceOption: + """Options for terminating optimization upon convergence.""" + + NoEarlyTermination: OptimizationConvergenceOption + TerminateIfConverged: OptimizationConvergenceOption + +class OptimizationIntermediateDoseOption: + """Options for using intermediate dose in optimization.""" + + NoIntermediateDose: OptimizationIntermediateDoseOption + UseIntermediateDose: OptimizationIntermediateDoseOption + +class OptimizationObjectiveOperator: + """Optimization Objective Operator, which is used for setting the upper and lower optimization objectives.""" + + Exact: OptimizationObjectiveOperator + Lower: OptimizationObjectiveOperator + None_: OptimizationObjectiveOperator + Upper: OptimizationObjectiveOperator + +class OptimizationOption: + """Options for Optimization.""" + + ContinueOptimization: OptimizationOption + ContinueOptimizationWithPlanDoseAsIntermediateDose: OptimizationOption + RestartOptimization: OptimizationOption + +class OptimizationOptionsBase: + """Abstract base class for IMRT and VMAT optimization options.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def IntermediateDoseOption(self) -> OptimizationIntermediateDoseOption: + """OptimizationIntermediateDoseOption: Use of intermediate dose in optimization.""" + ... + + @property + def MLC(self) -> str: + """str: Identifier for the Multileaf Collimator (MLC). This can be left empty if there is exactly one MLC configured.""" + ... + + @property + def StartOption(self) -> OptimizationOption: + """OptimizationOption: The state at the beginning of the optimization.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class OptimizationOptionsIMPT(OptimizationOptionsBase): + """Options for IMPT optimization.""" + + def __init__(self, maxIterations: int, initialState: OptimizationOption) -> None: + """Initialize instance.""" + ... + + @property + def IntermediateDoseOption(self) -> OptimizationIntermediateDoseOption: + """OptimizationIntermediateDoseOption: Property docstring.""" + ... + + @property + def MLC(self) -> str: + """str: Property docstring.""" + ... + + @property + def MaximumNumberOfIterations(self) -> int: + """int: Maximum number of iterations for the IMPT optimizer.""" + ... + + @property + def StartOption(self) -> OptimizationOption: + """OptimizationOption: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class OptimizationOptionsIMRT(OptimizationOptionsBase): + """Options for IMRT optimization.""" + + def __init__(self, maxIterations: int, initialState: OptimizationOption, numberOfStepsBeforeIntermediateDose: int, convergenceOption: OptimizationConvergenceOption, mlcId: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, maxIterations: int, initialState: OptimizationOption, convergenceOption: OptimizationConvergenceOption, intermediateDoseOption: OptimizationIntermediateDoseOption, mlcId: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, maxIterations: int, initialState: OptimizationOption, convergenceOption: OptimizationConvergenceOption, mlcId: str) -> None: + """Initialize instance.""" + ... + + @property + def ConvergenceOption(self) -> OptimizationConvergenceOption: + """OptimizationConvergenceOption: Terminate the optimization early if it is converged.""" + ... + + @property + def IntermediateDoseOption(self) -> OptimizationIntermediateDoseOption: + """OptimizationIntermediateDoseOption: Property docstring.""" + ... + + @property + def MLC(self) -> str: + """str: Property docstring.""" + ... + + @property + def MaximumNumberOfIterations(self) -> int: + """int: Maximum number of iterations for the IMRT optimizer.""" + ... + + @property + def NumberOfStepsBeforeIntermediateDose(self) -> int: + """int: Number of steps before the intermediate dose is calculated.""" + ... + + @property + def StartOption(self) -> OptimizationOption: + """OptimizationOption: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class OptimizationOptionsVMAT(OptimizationOptionsBase): + """Options for VMAT optimization.""" + + def __init__(self, startOption: OptimizationOption, mlcId: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, intermediateDoseOption: OptimizationIntermediateDoseOption, mlcId: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, numberOfCycles: int, mlcId: str) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, options: OptimizationOptionsVMAT) -> None: + """Initialize instance.""" + ... + + @property + def IntermediateDoseOption(self) -> OptimizationIntermediateDoseOption: + """OptimizationIntermediateDoseOption: Property docstring.""" + ... + + @property + def MLC(self) -> str: + """str: Property docstring.""" + ... + + @property + def NumberOfOptimizationCycles(self) -> int: + """int: Number of VMAT optimization cycles.""" + ... + + @property + def StartOption(self) -> OptimizationOption: + """OptimizationOption: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class ParticleType: + """Particle types""" + + Photon: ParticleType + Proton: ParticleType + +class PatientOrientation: + """The enumeration of patient orientations.""" + + FeetFirstDecubitusLeft: PatientOrientation + FeetFirstDecubitusRight: PatientOrientation + FeetFirstProne: PatientOrientation + FeetFirstSupine: PatientOrientation + HeadFirstDecubitusLeft: PatientOrientation + HeadFirstDecubitusRight: PatientOrientation + HeadFirstProne: PatientOrientation + HeadFirstSupine: PatientOrientation + NoOrientation: PatientOrientation + Sitting: PatientOrientation + +class PatientSupportType: + """Patient support type.""" + + Chair: PatientSupportType + Table: PatientSupportType + +class PlanNormalizationMode: + """Plan normalization options for SetPlanNormalization""" + + NoNormalization: PlanNormalizationMode + TargetDVH: PlanNormalizationMode + TargetMax: PlanNormalizationMode + TargetMean: PlanNormalizationMode + TargetMin: PlanNormalizationMode + UserDefined: PlanNormalizationMode + +class PlanSetupApprovalStatus: + """The enumeration of plan approval statuses.""" + + Completed: PlanSetupApprovalStatus + CompletedEarly: PlanSetupApprovalStatus + ExternallyApproved: PlanSetupApprovalStatus + PlanningApproved: PlanSetupApprovalStatus + Rejected: PlanSetupApprovalStatus + Retired: PlanSetupApprovalStatus + Reviewed: PlanSetupApprovalStatus + TreatmentApproved: PlanSetupApprovalStatus + UnApproved: PlanSetupApprovalStatus + UnPlannedTreatment: PlanSetupApprovalStatus + Unknown: PlanSetupApprovalStatus + +class PlanSumOperation: + """PlanSum operation for PlanSetups in PlanSum. Indicates whether the plan is summed with (“+”) or subtracted from (“-”) the other plans in the sum.""" + + Addition: PlanSumOperation + Subtraction: PlanSumOperation + Undefined: PlanSumOperation + +class PlanType: + """The enumeration of plan types.""" + + Brachy: PlanType + ExternalBeam: PlanType + ExternalBeam_IRREG: PlanType + ExternalBeam_Proton: PlanType + +class PlanUncertaintyType: + """Plan uncertainty type indicates the usage of associated uncertainty parameters, see""" + + BaselineShiftUncertainty: PlanUncertaintyType + IsocenterShiftUncertainty: PlanUncertaintyType + RangeUncertainty: PlanUncertaintyType + RobustOptimizationUncertainty: PlanUncertaintyType + UncertaintyTypeNotDefined: PlanUncertaintyType + +class PlanValidationResult: + """Represents plan validatation result""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @overload + def __init__(self, details: List[PlanValidationResultDetail]) -> None: + """Initialize instance.""" + ... + + @property + def Details(self) -> List[PlanValidationResultDetail]: + """List[PlanValidationResultDetail]: The validation details of this instance.""" + ... + + @Details.setter + def Details(self, value: List[PlanValidationResultDetail]) -> None: + """Set property value.""" + ... + + @property + def ErrorCount(self) -> int: + """int: The error count of this instance.""" + ... + + @ErrorCount.setter + def ErrorCount(self, value: int) -> None: + """Set property value.""" + ... + + @property + def InfoCount(self) -> int: + """int: The info count of this instance.""" + ... + + @InfoCount.setter + def InfoCount(self, value: int) -> None: + """Set property value.""" + ... + + @property + def StringPresentation(self) -> str: + """str: String representation of this instance.""" + ... + + @property + def WarningCount(self) -> int: + """int: The warning count of this instance.""" + ... + + @WarningCount.setter + def WarningCount(self, value: int) -> None: + """Set property value.""" + ... + + def Add(self, detail: PlanValidationResultDetail) -> None: + """Method docstring.""" + ... + + @overload + def Add(self, componentResult: PlanValidationResult) -> None: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class PlanValidationResultDetail: + """Represents plan validation detail.""" + + def __init__(self, plan: str, messageForUser: str, classification: ResultClassification, code: str) -> None: + """Initialize instance.""" + ... + + @property + def Classification(self) -> ResultClassification: + """ResultClassification: Result classification of this instance.""" + ... + + @Classification.setter + def Classification(self, value: ResultClassification) -> None: + """Set property value.""" + ... + + @property + def Code(self) -> str: + """str: Unique validation detail code of this instance.""" + ... + + @Code.setter + def Code(self, value: str) -> None: + """Set property value.""" + ... + + @property + def MessageForUser(self) -> str: + """str: Localized message for user of this instance.""" + ... + + @MessageForUser.setter + def MessageForUser(self, value: str) -> None: + """Set property value.""" + ... + + @property + def Plan(self) -> str: + """str: Identifies the plan of this instance.""" + ... + + @Plan.setter + def Plan(self, value: str) -> None: + """Set property value.""" + ... + + @property + def StringPresentation(self) -> str: + """str: String representation of this instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + @staticmethod + def GetClassification(detail: PlanValidationResultDetail) -> ResultClassification: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class PlanValidationResultEsapiDetail: + """A class for detailed plan validation result""" + + def __init__(self, messageForUser: str, isError: bool, code: str) -> None: + """Initialize instance.""" + ... + + @property + def Code(self) -> str: + """str: Detail code.""" + ... + + @Code.setter + def Code(self, value: str) -> None: + """Set property value.""" + ... + + @property + def IsError(self) -> bool: + """bool: Check if the result is a error (true) or a warning (false).""" + ... + + @IsError.setter + def IsError(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def MessageForUser(self) -> str: + """str: Message for the user about the validation result detail.""" + ... + + @MessageForUser.setter + def MessageForUser(self, value: str) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class PrescriptionModifier: + """Prescription modifier.""" + + PrescriptionModifierAtLeast: PrescriptionModifier + PrescriptionModifierAtMost: PrescriptionModifier + PrescriptionModifierDMax: PrescriptionModifier + PrescriptionModifierEUD: PrescriptionModifier + PrescriptionModifierIsodose: PrescriptionModifier + PrescriptionModifierMaxDose: PrescriptionModifier + PrescriptionModifierMaxDoseAtMost: PrescriptionModifier + PrescriptionModifierMeanDose: PrescriptionModifier + PrescriptionModifierMeanDoseAtLeast: PrescriptionModifier + PrescriptionModifierMeanDoseAtMost: PrescriptionModifier + PrescriptionModifierMidPoint: PrescriptionModifier + PrescriptionModifierMinDose: PrescriptionModifier + PrescriptionModifierMinDoseAtLeast: PrescriptionModifier + PrescriptionModifierNone: PrescriptionModifier + PrescriptionModifierRefPoint: PrescriptionModifier + PrescriptionModifierUser: PrescriptionModifier + +class PrescriptionType: + """Enumeration of prescription types.""" + + PrescriptionTypeDepth: PrescriptionType + PrescriptionTypeIsodose: PrescriptionType + PrescriptionTypeNone: PrescriptionType + PrescriptionTypeVolume: PrescriptionType + +class ProfilePoint(ValueType): + """Represents a point of a line profile.""" + + def __init__(self, position: VVector, value: float) -> None: + """Initialize instance.""" + ... + + @property + def Position(self) -> VVector: + """VVector: The position of the point.""" + ... + + @Position.setter + def Position(self, value: VVector) -> None: + """Set property value.""" + ... + + @property + def Value(self) -> float: + """float: The value of the point.""" + ... + + @Value.setter + def Value(self, value: float) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class ProtonBeamLineStatus: + """Status of proton beam line""" + + Invalid: ProtonBeamLineStatus + Outdated: ProtonBeamLineStatus + Valid: ProtonBeamLineStatus + +class ProtonBeamMachineParameters: + """The parameters for the proton beam treatment unit.""" + + def __init__(self, machineId: str, techniqueId: str, toleranceId: str) -> None: + """Initialize instance.""" + ... + + @property + def MachineId(self) -> str: + """str: The treatment unit identifier.""" + ... + + @MachineId.setter + def MachineId(self, value: str) -> None: + """Set property value.""" + ... + + @property + def TechniqueId(self) -> str: + """str: Technique identifier. For example, "MODULAT_SCANNING", or "UNIFORM_SCANNING".""" + ... + + @TechniqueId.setter + def TechniqueId(self, value: str) -> None: + """Set property value.""" + ... + + @property + def ToleranceId(self) -> str: + """str: Tolerance identifier.""" + ... + + @ToleranceId.setter + def ToleranceId(self, value: str) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class ProtonDeliveryTimeStatus: + """The enumeration of proton delivery time statuses.""" + + Deliverable: ProtonDeliveryTimeStatus + NotCalculated: ProtonDeliveryTimeStatus + Undeliverable: ProtonDeliveryTimeStatus + +class RTPrescriptionConstraintType: + """Type of the RT prescription constraint.""" + + FreeText: RTPrescriptionConstraintType + MaximumDose: RTPrescriptionConstraintType + MaximumDvhDose: RTPrescriptionConstraintType + MaximumMeanDose: RTPrescriptionConstraintType + MinimumDose: RTPrescriptionConstraintType + MinimumDvhDose: RTPrescriptionConstraintType + +class RTPrescriptionTargetType: + """The type of the prescription target definition""" + + Depth: RTPrescriptionTargetType + Isocenter: RTPrescriptionTargetType + IsodoseLine: RTPrescriptionTargetType + Undefined: RTPrescriptionTargetType + Volume: RTPrescriptionTargetType + +class RailPosition: + """Setting for the moveable rail position (in or out) used for couch modeling in Eclipse.""" + + In: RailPosition + Out: RailPosition + +class RangeModulatorType: + """Type of the range modulator.""" + + Fixed: RangeModulatorType + Whl_FixedWeights: RangeModulatorType + Whl_ModWeights: RangeModulatorType + +class RangeShifterType: + """Type of the range shifter.""" + + Analog: RangeShifterType + Binary: RangeShifterType + +class RegistrationApprovalStatus: + """The enumeration of registration approval statuses.""" + + Approved: RegistrationApprovalStatus + Retired: RegistrationApprovalStatus + Reviewed: RegistrationApprovalStatus + Unapproved: RegistrationApprovalStatus + +class RendererStrings: + """Class docstring.""" + + Applicators: RendererStrings + BrachyFractions: RendererStrings + Catheters: RendererStrings + CumulativeDVH: RendererStrings + DoseZRes: RendererStrings + FinalSpotList: RendererStrings + Isodoses: RendererStrings + LengthUnit: RendererStrings + NormalizationInvalid: RendererStrings + OrientationLabelAnterior: RendererStrings + OrientationLabelFeet: RendererStrings + OrientationLabelHead: RendererStrings + OrientationLabelLeft: RendererStrings + OrientationLabelPosterior: RendererStrings + OrientationLabelRight: RendererStrings + PlanInTreatment: RendererStrings + Seeds: RendererStrings + WarningAddOns: RendererStrings + WarningArc: RendererStrings + WarningCAXOnly: RendererStrings + WarningConcurrency: RendererStrings + WarningPlanWeights: RendererStrings + +class ResetSourcePositionsResult: + """Return value for""" + + NoSideEffects: ResetSourcePositionsResult + TotalDwellTimeChanged: ResetSourcePositionsResult + +class ResultClassification: + """Classification of plan validation detail.""" + + ValidationError: ResultClassification + ValidationInfo: ResultClassification + ValidationWarning: ResultClassification + +class ResultClassification: + """Classification of plan validation detail.""" + + ValidationError: ResultClassification + ValidationInfo: ResultClassification + ValidationWarning: ResultClassification + +class SegmentProfile: + """Represents the segment values along a line segment.""" + + def __init__(self, origin: VVector, step: VVector, data: BitArray) -> None: + """Initialize instance.""" + ... + + @property + def Count(self) -> int: + """int: The number of points in the profile.""" + ... + + @property + def EdgeCoordinates(self) -> List[VVector]: + """List[VVector]: Returns the coordinates of the edges of the segment along the segment profile.""" + ... + + @property + def Item(self) -> SegmentProfilePoint: + """SegmentProfilePoint: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetEnumerator(self) -> IEnumerator[SegmentProfilePoint]: + """An enumerator for points in the profile. + + Returns: + IEnumerator[SegmentProfilePoint]: Enumerator for points in the profile.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class SegmentProfilePoint(ValueType): + """Represents a point of a segment profile.""" + + def __init__(self, position: VVector, value: bool) -> None: + """Initialize instance.""" + ... + + @property + def Position(self) -> VVector: + """VVector: The position of the point.""" + ... + + @Position.setter + def Position(self, value: VVector) -> None: + """Set property value.""" + ... + + @property + def Value(self) -> bool: + """bool: The value of the point: true if the point is inside the segment, false otherwise.""" + ... + + @Value.setter + def Value(self, value: bool) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class SeriesModality: + """The enumeration of series modalities.""" + + CT: SeriesModality + MR: SeriesModality + Other: SeriesModality + PT: SeriesModality + REG: SeriesModality + RTDOSE: SeriesModality + RTIMAGE: SeriesModality + RTPLAN: SeriesModality + RTSTRUCT: SeriesModality + +class SetSourcePositionsResult(ValueType): + """Return value for""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + InputRoundedToMachineResolution: bool + SourcePositionsUpdated: bool + TotalDwellTimeChanged: bool + +class SetupTechnique: + """The enumeration of setup techniques for a beam.""" + + BreastBridge: SetupTechnique + FixedSSD: SetupTechnique + HyperArc: SetupTechnique + Isocentric: SetupTechnique + SkinApposition: SetupTechnique + TBI: SetupTechnique + Unknown: SetupTechnique + +class SingleLayerParameters: + """One layer or group of DRR calculation parameters.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + @property + def CTFrom(self) -> float: + """float: Lower end of the CT window. Value must be between -1024.0 and 6000.0.""" + ... + + @CTFrom.setter + def CTFrom(self, value: float) -> None: + """Set property value.""" + ... + + @property + def CTTo(self) -> float: + """float: Upper end of the CT window. Value must be between -1024.0 and 6000.0.""" + ... + + @CTTo.setter + def CTTo(self, value: float) -> None: + """Set property value.""" + ... + + @property + def GeoClipping(self) -> bool: + """bool: Image volume type on which the DRR calculation is based. If calculation is based on partial image volume as specified by""" + ... + + @GeoClipping.setter + def GeoClipping(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def GeoFrom(self) -> float: + """float: Starting distance from the isocenter. Value must be between -10000 and 10000 mm.""" + ... + + @GeoFrom.setter + def GeoFrom(self, value: float) -> None: + """Set property value.""" + ... + + @property + def GeoTo(self) -> float: + """float: Ending distance from the isocenter. Value must be between -10000 and 10000 mm.""" + ... + + @GeoTo.setter + def GeoTo(self, value: float) -> None: + """Set property value.""" + ... + + @property + def LayerOn(self) -> bool: + """bool: Defines whether the layer of parameters are selected.""" + ... + + @LayerOn.setter + def LayerOn(self, value: bool) -> None: + """Set property value.""" + ... + + @property + def Weight(self) -> float: + """float: Weight factor of the DRR layer. Value must be between -100.0 and 100.0.""" + ... + + @Weight.setter + def Weight(self, value: float) -> None: + """Set property value.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class SmartLMCOptions: + """Options for calculating leaf motions using the Varian Smart LMC algorithm.""" + + def __init__(self, fixedFieldBorders: bool, jawTracking: bool) -> None: + """Initialize instance.""" + ... + + @property + def FixedFieldBorders(self) -> bool: + """bool: Use the Fixed field borders option. See details in Eclipse Photon and Electron Algorithms Reference Guide.""" + ... + + @property + def JawTracking(self) -> bool: + """bool: Use the Jaw tracking option. See details in Eclipse Photon and Electron Algorithms Reference Guide.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class StructureApprovalHistoryEntry(ValueType): + """An entry in the structure approval history.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + ApprovalDateTime: datetime + ApprovalStatus: StructureApprovalStatus + StatusComment: str + UserDisplayName: str + UserId: str + +class StructureApprovalStatus: + """The enumeration of structure approval statuses.""" + + Approved: StructureApprovalStatus + Rejected: StructureApprovalStatus + Reviewed: StructureApprovalStatus + UnApproved: StructureApprovalStatus + +class StructureCodeInfo(ValueType): + """Represents structure code information.""" + + def __init__(self, codingScheme: str, code: str) -> None: + """Initialize instance.""" + ... + + @property + def Code(self) -> str: + """str: The structure code as defined in the associated coding scheme.""" + ... + + @property + def CodingScheme(self) -> str: + """str: The coding scheme of the structure code.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + @overload + def Equals(self, other: StructureCodeInfo) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Returns the hash code for this instance. Overrides Object.GetHashCode. + + Returns: + int: The hash code for this instance.""" + ... + + def GetSchema(self) -> XmlSchema: + """This member is internal to the Eclipse Scripting API. + + Returns: + XmlSchema: XmlSchema.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ReadXml(self, reader: XmlReader) -> None: + """Method docstring.""" + ... + + def ToString(self) -> str: + """A string that represents the current object. + + Returns: + str: A string that represents the current object.""" + ... + + def WriteXml(self, writer: XmlWriter) -> None: + """Method docstring.""" + ... + + +class StructureMarginGeometry: + """Specifies whether a margin operation expands (outer margin) or shrinks (inner margin) the volume.""" + + Inner: StructureMarginGeometry + Outer: StructureMarginGeometry + +class TreatmentSessionStatus: + """Status of the treatment session.""" + + Completed: TreatmentSessionStatus + CompletedPartially: TreatmentSessionStatus + InActiveResume: TreatmentSessionStatus + InActiveTreat: TreatmentSessionStatus + Null: TreatmentSessionStatus + Resume: TreatmentSessionStatus + Treat: TreatmentSessionStatus + +class UserIdentity(ValueType): + """Represents the identity of an user, including the identifier (username) and the display name.""" + + def __init__(self, id: str, displayName: str) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + DisplayName: str + Id: str + +class VRect(Generic[T], ValueType): + """Represents a rectangle. + + Currently limited to value types.""" + + def __init__(self, x1: T, y1: T, x2: T, y2: T) -> None: + """Initialize instance.""" + ... + + @property + def X1(self) -> T: + """T: The X1-coordinate of the rectangle.""" + ... + + @property + def X2(self) -> T: + """T: The X2-coordinate of the rectangle.""" + ... + + @property + def Y1(self) -> T: + """T: The Y1-coordinate of the rectangle.""" + ... + + @property + def Y2(self) -> T: + """T: The Y2-coordinate of the rectangle.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + @overload + def Equals(self, other: VRect[T]) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Returns the hash code for this instance. Overrides Object.GetHashCode. + + Returns: + int: The hash code for this instance.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """A string that represents the current object. + + Returns: + str: A string that represents the current object.""" + ... + + +class VVector(ValueType): + """Represents a displacement in 3D space.""" + + def __init__(self, xi: float, yi: float, zi: float) -> None: + """Initialize instance.""" + ... + + @property + def Item(self) -> float: + """float: Property docstring.""" + ... + + @property + def Length(self) -> float: + """float: The length of the VVector.""" + ... + + @property + def LengthSquared(self) -> float: + """float: The square of the length of the VVector.""" + ... + + @property + def x(self) -> float: + """float: The X component of the VVector.""" + ... + + @x.setter + def x(self, value: float) -> None: + """Set property value.""" + ... + + @property + def y(self) -> float: + """float: The Y component of the VVector.""" + ... + + @y.setter + def y(self, value: float) -> None: + """Set property value.""" + ... + + @property + def z(self) -> float: + """float: The Z component of the VVector.""" + ... + + @z.setter + def z(self, value: float) -> None: + """Set property value.""" + ... + + @staticmethod + def Distance(left: VVector, right: VVector) -> float: + """Method docstring.""" + ... + + def EpsilonEqual(self, other: VVector, epsilon: float) -> bool: + """Method docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + @overload + def Equals(self, other: VVector) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """A hash code for the current object. + + Returns: + int: A hash code for the current object.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def GetUnitLengthScaledVector(self) -> VVector: + """Scales this VVector so that its length becomes equal to unity.""" + ... + + def IsUndefined(self) -> bool: + """Returns true if at least one of this vector components are equal to double.IsNaN or double.IsInfinity, false otherwise. + + Returns: + bool: True if at least one of the vector component is not defined or is infinity, false otherwise.""" + ... + + def ScalarProduct(self, left: VVector) -> float: + """Method docstring.""" + ... + + def ScaleToUnitLength(self) -> None: + """Scales this VVector so that its length becomes equal to unity.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + def Update(self, vc: Component, value: float) -> VVector: + """Method docstring.""" + ... + + DefaultEpsilon: float + Undefined: VVector + +class ValidationException(ApplicationException): + """ValidationException.""" + + def __init__(self, reason: str) -> None: + """Initialize instance.""" + ... + + @property + def Data(self) -> DictionaryBase: + """DictionaryBase: Property docstring.""" + ... + + @property + def HResult(self) -> int: + """int: Property docstring.""" + ... + + @HResult.setter + def HResult(self, value: int) -> None: + """Set property value.""" + ... + + @property + def HelpLink(self) -> str: + """str: Property docstring.""" + ... + + @HelpLink.setter + def HelpLink(self, value: str) -> None: + """Set property value.""" + ... + + @property + def InnerException(self) -> Exception: + """Exception: Property docstring.""" + ... + + @property + def Message(self) -> str: + """str: Property docstring.""" + ... + + @property + def Source(self) -> str: + """str: Property docstring.""" + ... + + @Source.setter + def Source(self, value: str) -> None: + """Set property value.""" + ... + + @property + def StackTrace(self) -> str: + """str: Property docstring.""" + ... + + @property + def TargetSite(self) -> MethodBase: + """MethodBase: Property docstring.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetBaseException(self) -> Exception: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetObjectData(self, info: SerializationInfo, context: StreamingContext) -> None: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + @overload + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + +class VolumePresentation: + """Types of presentation for volume values.""" + + AbsoluteCm3: VolumePresentation + Relative: VolumePresentation diff --git a/pyesapi/VMS/TPS/Version/__init__.pyi b/pyesapi/stubs/VMS/TPS/Common/Model/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/Version/__init__.pyi rename to pyesapi/stubs/VMS/TPS/Common/Model/__init__.py diff --git a/pyesapi/VMS/TPS/__init__.pyi b/pyesapi/stubs/VMS/TPS/Common/__init__.py similarity index 100% rename from pyesapi/VMS/TPS/__init__.pyi rename to pyesapi/stubs/VMS/TPS/Common/__init__.py diff --git a/pyesapi/VMS/__init__.pyi b/pyesapi/stubs/VMS/TPS/Version/__init__.py similarity index 100% rename from pyesapi/VMS/__init__.pyi rename to pyesapi/stubs/VMS/TPS/Version/__init__.py diff --git a/pyesapi/stubs/VMS/TPS/Version/__init__.pyi b/pyesapi/stubs/VMS/TPS/Version/__init__.pyi new file mode 100644 index 0000000..660a697 --- /dev/null +++ b/pyesapi/stubs/VMS/TPS/Version/__init__.pyi @@ -0,0 +1,46 @@ +from typing import Any, Dict, Generic, List, Optional, Union, overload +from datetime import datetime +from System import Type + +class VersionInfo: + """This class is a set of constants that specify build version information. Generated automatically from TpsNetVersion.in - do not edit by hand. The logic is copied from the VFC equivalents in TpsVersion.in. Names and identifiers are kept exactly the same as in the original VFC version to help in maintenance.""" + + def __init__(self) -> None: + """Initialize instance.""" + ... + + def Equals(self, obj: Any) -> bool: + """Method docstring.""" + ... + + def GetHashCode(self) -> int: + """Method docstring.""" + ... + + def GetType(self) -> Type: + """Method docstring.""" + ... + + def ToString(self) -> str: + """Method docstring.""" + ... + + CORE_BUILD_STRING: str + CORE_CHANGESET: str + CORE_COMPANY_NAME: str + CORE_EDITION_STRING: str + CORE_FILE_VERSION_STRING: str + CORE_LEGAL_COPYRIGHT: str + CORE_LEGAL_TRADEMARKS: str + CORE_PRODUCT_NAME: str + CORE_PRODUCT_VERSION_NUMERIC: str + CORE_PRODUCT_VERSION_STRING: str + CORE_TPSNET_INTERFACE_VERSION_STRING: str + CORE_TPSNET_SERVICES_INTERFACE_VERSION_STRING: str + CORE_VERSION_BUILD: str + CORE_VERSION_MAJOR: str + CORE_VERSION_MICRO: str + CORE_VERSION_MINOR: str + CORE_VERSION_STRING: str + CORE_YEAR: str + CORE_YEAR_STRING: str diff --git a/pyesapi/VMS/py.typed b/pyesapi/stubs/VMS/TPS/__init__.py similarity index 100% rename from pyesapi/VMS/py.typed rename to pyesapi/stubs/VMS/TPS/__init__.py diff --git a/pyesapi/stubs/VMS/__init__.py b/pyesapi/stubs/VMS/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/pyesapi/stubs/py.typed b/pyesapi/stubs/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/stubgen/dotnet_stubs.py b/stubgen/dotnet_stubs.py new file mode 100644 index 0000000..a72fa64 --- /dev/null +++ b/stubgen/dotnet_stubs.py @@ -0,0 +1,1891 @@ +#!/usr/bin/env python3 +""" +DLL-First .NET Stub Generator + +This version prioritizes DLL introspection using pythonnet reflection as the primary +source for all type information, with XML documentation only used for docstrings. + +ARCHITECTURE: +1. Load DLL assemblies using pythonnet +2. Enumerate all types using .NET reflection +3. Extract complete type information (properties, methods, fields) from DLL +4. Parse XML documentation to match and enhance with docstrings +5. Generate Python stub files with accurate type annotations + +CORE PRINCIPLES: +- DLL reflection is the source of truth for all type information +- XML provides documentation only (summary, remarks, examples, parameter descriptions) +- No hardcoded type mappings - use actual .NET reflection properties +- Direct conversion from .NET Type objects to Python type strings +- Preserve actual pythonnet runtime behavior in generated stubs + +Usage: + python dotnet_stubsv3.py [output_folder] + +Example: + python dotnet_stubsv3.py "C:\Program Files\Varian\RTM\18.0\esapi\API" stubs_v3 +""" + +import sys +import logging +import sys +import logging +import xml.etree.ElementTree as ET +import re +from pathlib import Path +from typing import Dict, List, Set, Optional, Any, Union +from dataclasses import dataclass, field +from collections import defaultdict +import xml.etree.ElementTree as ET + +# Configure logging +logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s') +logger = logging.getLogger(__name__) + +try: + import clr + import System + from System import Type, Array + from System.Reflection import Assembly, BindingFlags + HAS_PYTHONNET = True + logger.info("pythonnet available - DLL introspection enabled") +except ImportError: + HAS_PYTHONNET = False + logger.error("pythonnet not available - DLL introspection disabled") + sys.exit(1) + + +# ============================================================================= +# Data Structures +# ============================================================================= + +@dataclass +class TypeInfo: + """Complete type information extracted from DLL""" + full_name: str + simple_name: str + namespace: str + is_class: bool = False + is_interface: bool = False + is_enum: bool = False + is_struct: bool = False + base_type: Optional[str] = None + interfaces: List[str] = field(default_factory=list) + properties: Dict[str, 'PropertyInfo'] = field(default_factory=dict) + methods: Dict[str, List['MethodInfo']] = field(default_factory=dict) + fields: Dict[str, 'FieldInfo'] = field(default_factory=dict) + constructors: List['MethodInfo'] = field(default_factory=list) + is_generic: bool = False + generic_parameters: List[str] = field(default_factory=list) + + +@dataclass +class PropertyInfo: + """Property information from DLL""" + name: str + type_str: str + can_read: bool + can_write: bool + is_static: bool = False + + +@dataclass +class MethodInfo: + """Method information from DLL""" + name: str + return_type_str: str + parameters: List['ParameterInfo'] = field(default_factory=list) + is_static: bool = False + is_constructor: bool = False + is_generic: bool = False + generic_parameters: List[str] = field(default_factory=list) + + +@dataclass +class ParameterInfo: + """Parameter information from DLL""" + name: str + type_str: str + is_optional: bool = False + default_value: Any = None + + +@dataclass +class FieldInfo: + """Field information from DLL""" + name: str + type_str: str + is_static: bool = False + is_readonly: bool = False + + +@dataclass +class DocumentationInfo: + """Documentation extracted from XML""" + summary: str = "" + remarks: str = "" + returns_doc: str = "" + example: str = "" + param_descriptions: Dict[str, str] = field(default_factory=dict) + exceptions: Dict[str, str] = field(default_factory=dict) + + +# ============================================================================= +# .NET Type to Python Type Conversion +# ============================================================================= + +class NetTypeToPythonConverter: + """Converts .NET Type objects directly to Python type strings using reflection""" + + # Cache for interface-to-implementation mappings + _interface_implementations = {} + _available_types = {} + + @classmethod + def set_available_types(cls, available_types: Dict[str, Any]): + """Set the available types for interface resolution""" + cls._available_types = available_types + cls._interface_implementations.clear() # Clear cache when types change + + @classmethod + def _find_implementation_for_interface(cls, interface_name: str) -> Optional[str]: + """Find a concrete implementation for an interface type using reflection""" + if not interface_name or not interface_name.startswith('I'): + return None + + # Check cache first + if interface_name in cls._interface_implementations: + return cls._interface_implementations[interface_name] + + # Look for implementation by removing 'I' prefix + impl_name = interface_name[1:] # Remove 'I' prefix + + # Search in available types + for full_name, net_type in cls._available_types.items(): + try: + # Check if this type implements the interface + if hasattr(net_type, 'GetInterfaces'): + for implemented_interface in net_type.GetInterfaces(): + if hasattr(implemented_interface, 'Name') and implemented_interface.Name == interface_name: + # Found an implementation - prefer the one with matching name + if hasattr(net_type, 'Name') and net_type.Name == impl_name: + cls._interface_implementations[interface_name] = impl_name + return impl_name + # Fallback to any implementation + elif hasattr(net_type, 'Name'): + cls._interface_implementations[interface_name] = net_type.Name + return net_type.Name + + # Also check by simple name matching + if hasattr(net_type, 'Name') and net_type.Name == impl_name: + # Verify it's not an interface itself + if hasattr(net_type, 'IsInterface') and not net_type.IsInterface: + cls._interface_implementations[interface_name] = impl_name + return impl_name + + except Exception: + continue + + # Cache negative result + cls._interface_implementations[interface_name] = None + return None + + # Basic type mappings for common .NET types + BASIC_MAPPINGS = { + 'System.String': 'str', + 'System.Int32': 'int', + 'System.Int64': 'int', + 'System.Int16': 'int', + 'System.UInt32': 'int', + 'System.UInt64': 'int', + 'System.UInt16': 'int', + 'System.Byte': 'int', + 'System.SByte': 'int', + 'System.Double': 'float', + 'System.Single': 'float', + 'System.Decimal': 'float', + 'System.Boolean': 'bool', + 'System.DateTime': 'datetime', + 'System.TimeSpan': 'timedelta', + 'System.Guid': 'str', + 'System.Void': 'None', + 'System.Object': 'Any', + 'System.Collections.Generic.Dictionary': 'Dict', + 'System.Collections.Generic.List': 'List', + 'System.Collections.Generic.IEnumerable': 'Iterable', + 'System.Collections.Generic.IList': 'List', + 'System.Collections.Generic.IDictionary': 'Dict', + 'System.Collections.Generic.IReadOnlyList': 'List', + 'System.Collections.Generic.ICollection': 'List', + # Keep System types as-is for pythonnet compatibility + 'System.Array': 'Array', + 'System.Type': 'Type', + 'System.ValueType': 'ValueType', + 'System.Enum': 'Enum', + 'System.MulticastDelegate': 'MulticastDelegate', + 'System.Xml.Schema.XmlSchema': 'XmlSchema', + 'System.Xml.XmlReader': 'XmlReader', + 'System.Xml.XmlWriter': 'XmlWriter', + 'System.Collections.BitArray': 'BitArray', + 'System.Collections.IEnumerator': 'IEnumerator', + 'Windows.Media.Color': 'Color', + # Pointer types - convert to Any for Python compatibility + 'System.Void*': 'Any', + 'System.Int32*': 'Any', + 'System.Byte*': 'Any', + } + + @classmethod + def convert_type(cls, net_type) -> str: + """Convert .NET Type object to Python type string using pure reflection""" + if net_type is None: + return 'Any' + + try: + # Handle string representations that come from ToString() rather than actual Type objects + if isinstance(net_type, str): + return cls._convert_type_string(net_type) + + # Handle proper .NET Type objects + # Check for reference types (ending with &) + type_str = str(net_type) + if type_str.endswith('&'): + # Remove the & and process the underlying type + underlying_type_str = type_str[:-1] + return cls._convert_type_string(underlying_type_str) + + if hasattr(net_type, 'IsArray') and net_type.IsArray: + element_type = net_type.GetElementType() + element_python_type = cls.convert_type(element_type) + return f'Array[{element_python_type}]' + + # Handle generic types using reflection + if hasattr(net_type, 'IsGenericType') and net_type.IsGenericType: + return cls._convert_generic_type(net_type) + + # Get full name using reflection + full_name = net_type.FullName if hasattr(net_type, 'FullName') and net_type.FullName else str(net_type) + + # Handle nested types (replace + with .) + if '+' in full_name: + full_name = full_name.replace('+', '.') + + # Handle pointer types + if full_name.endswith('*'): + return 'Any' + + # Check basic mappings + if full_name in cls.BASIC_MAPPINGS: + return cls.BASIC_MAPPINGS[full_name] + + # Handle enums + if hasattr(net_type, 'IsEnum') and net_type.IsEnum: + return cls._get_simple_name(full_name) + + # For other types, return simple name and check for interface implementation + simple_name = cls._get_simple_name(full_name) + clean_name = cls._clean_assembly_references(simple_name) + + # Check if it's an interface and find implementation + if hasattr(net_type, 'IsInterface') and net_type.IsInterface: + impl_name = cls._find_implementation_for_interface(clean_name) + if impl_name: + return impl_name + + return clean_name + + except Exception as e: + logger.debug(f"Type conversion failed for {net_type}: {e}") + return 'Any' + + @classmethod + def _convert_type_string(cls, type_str: str) -> str: + """Convert string representation of a type to Python type string""" + if not type_str: + return 'Any' + + # Handle array notation T[], T1[], etc. + if type_str.endswith('[]'): + element_type_name = type_str[:-2] + # For generic type parameters like T, T1, just use Array[T] + if element_type_name in {'T', 'T1', 'T2', 'T3', 'T4', 'TKey', 'TValue'}: + return f'Array[{element_type_name}]' + else: + element_python_type = cls._convert_type_string(element_type_name) + return f'Array[{element_python_type}]' + + # Handle pointer types + if type_str.endswith('*'): + return 'Any' + + # Check basic mappings + if type_str in cls.BASIC_MAPPINGS: + return cls.BASIC_MAPPINGS[type_str] + + # Handle generic notation T`1, T`2 etc by extracting base name + if '`' in type_str: + base_name = type_str.split('`')[0] + simple_name = cls._get_simple_name(base_name) + # Check for interface implementation + impl_name = cls._find_implementation_for_interface(simple_name) + return impl_name or simple_name + + # Get simple name and check for interface implementation + simple_name = cls._get_simple_name(type_str) + impl_name = cls._find_implementation_for_interface(simple_name) + return impl_name or simple_name + + @classmethod + def convert_type_string(cls, type_name: str) -> str: + """Convert a type name string to Python type string""" + if not type_name: + return 'Any' + + # Check basic mappings + if type_name in cls.BASIC_MAPPINGS: + return cls.BASIC_MAPPINGS[type_name] + + # Get simple name and check for interface implementation + simple_name = cls._get_simple_name(type_name) + impl_name = cls._find_implementation_for_interface(simple_name) + return impl_name or simple_name + + @classmethod + def _clean_assembly_references(cls, type_str: str) -> str: + """Clean assembly references from type strings as a final step""" + if not type_str: + return 'Any' # Return Any for empty types + + import re + + # Remove assembly information patterns + type_str = re.sub(r'\s*,\s*Culture=neutral,\s*PublicKeyToken=[a-f0-9]+\]\]&?', '', type_str) + type_str = re.sub(r'\s*\[\[\s*', '', type_str) + type_str = re.sub(r'\s*\]\]\s*', '', type_str) + type_str = re.sub(r'\s*&\s*$', '', type_str) + + # Clean up malformed patterns like "0, Culture=..." + type_str = re.sub(r'^\s*\d+\s*,?\s*Culture=.*$', 'Any', type_str) + + # Clean up numbers that might be left from malformed conversions at the start + type_str = re.sub(r'^\s*\d+\s*,?\s*', '', type_str) + + # If after cleaning we have nothing meaningful, return Any + cleaned = type_str.strip() + if not cleaned or cleaned in ['0', '194']: # Common leftover numbers + return 'Any' + + return cleaned + + @classmethod + def _convert_generic_type(cls, net_type) -> str: + """Convert generic .NET type using reflection""" + try: + # Get generic type definition and arguments + generic_def = net_type.GetGenericTypeDefinition() + generic_args = net_type.GetGenericArguments() + + # Get the base name + def_name = generic_def.FullName if hasattr(generic_def, 'FullName') else str(generic_def) + base_name = cls._get_simple_name(def_name).split('`')[0] # Remove `1, `2 etc. + + # Convert arguments + converted_args = [cls.convert_type(arg) for arg in generic_args] + + # Handle common generic types + if 'Nullable' in base_name: + if converted_args: + return f'Optional[{converted_args[0]}]' + else: + return 'Optional[Any]' + elif any(name in base_name for name in ['List', 'IList', 'IEnumerable', 'ICollection']): + if converted_args: + return f'List[{converted_args[0]}]' + else: + return 'List[Any]' + elif any(name in base_name for name in ['Dictionary', 'IDictionary']): + if len(converted_args) >= 2: + return f'Dict[{converted_args[0]}, {converted_args[1]}]' + elif len(converted_args) == 1: + return f'Dict[str, {converted_args[0]}]' + else: + return 'Dict[str, Any]' + else: + # Generic type we don't specifically handle + if converted_args: + args_str = ', '.join(converted_args) + return f'{base_name}[{args_str}]' + else: + return f'{base_name}[Any]' + + except Exception as e: + logger.debug(f"Generic type conversion failed for {net_type}: {e}") + return 'Any' + + @classmethod + def _get_simple_name(cls, full_name: str) -> str: + """Extract simple class name from full name""" + if '.' in full_name: + return full_name.split('.')[-1] + return full_name + + +# ============================================================================= +# DLL Type Introspector +# ============================================================================= + +class DllIntrospector: + """Introspects DLL assemblies to extract complete type information""" + + def __init__(self, dll_paths: List[str], docs: Optional[Dict[str, DocumentationInfo]] = None): + self.dll_paths = dll_paths + self.target_assemblies = [] # Only assemblies from input DLLs + self.all_assemblies = [] # All loaded assemblies + self.type_info_cache: Dict[str, TypeInfo] = {} + self.referenced_types: Set[str] = set() # All types referenced by target types + self.available_types: Dict[str, Any] = {} # All available .NET types by full name + self.types_to_stub: Dict[str, TypeInfo] = {} # All types that need stubs generated + self.docs = docs or {} # XML documentation for filtering + + def load_assemblies(self): + """Load all DLL assemblies""" + target_assembly_names = set() + + for dll_path in self.dll_paths: + try: + # Load assembly using pythonnet + clr.AddReference(str(dll_path)) + + # Extract assembly name from path for identification + dll_name = Path(dll_path).stem + target_assembly_names.add(dll_name) + + logger.info(f"Loaded assembly: {dll_path}") + except Exception as e: + logger.warning(f"Failed to load {dll_path}: {e}") + + # Get all loaded assemblies and identify target ones + self.all_assemblies = list(System.AppDomain.CurrentDomain.GetAssemblies()) + + # Build a map of all available types for dependency resolution + self._build_available_types_map() + + # Filter to only target assemblies (those from input DLL files) + for assembly in self.all_assemblies: + try: + assembly_name = assembly.GetName().Name + if assembly_name in target_assembly_names: + self.target_assemblies.append(assembly) + logger.info(f"Target assembly identified: {assembly_name}") + except Exception as e: + logger.debug(f"Failed to get assembly name for {assembly}: {e}") + + logger.info(f"Total assemblies loaded: {len(self.all_assemblies)}") + logger.info(f"Target assemblies for stub generation: {len(self.target_assemblies)}") + logger.info(f"Available types for dependency resolution: {len(self.available_types)}") + + def _build_available_types_map(self): + """Build a map of all available .NET types for dependency resolution""" + for assembly in self.all_assemblies: + try: + for net_type in assembly.GetTypes(): + if hasattr(net_type, 'FullName') and net_type.FullName: + self.available_types[net_type.FullName] = net_type + except Exception as e: + logger.debug(f"Failed to build type map for assembly {assembly}: {e}") + + # Pass available types to converter for interface resolution + NetTypeToPythonConverter.set_available_types(self.available_types) + + def extract_all_types(self) -> Dict[str, TypeInfo]: + """Extract type information from target assemblies and all their dependencies""" + # Step 1: Extract target types from input DLLs + target_types = {} + + for assembly in self.target_assemblies: + try: + assembly_types = self._extract_assembly_types(assembly) + target_types.update(assembly_types) + logger.info(f"Extracted {len(assembly_types)} types from {assembly.GetName().Name}") + except Exception as e: + logger.debug(f"Failed to extract types from assembly {assembly}: {e}") + + logger.info(f"Target types extracted from input DLLs: {len(target_types)}") + + # Step 2: Discover all referenced types + self._discover_referenced_types(target_types) + logger.info(f"Total referenced types discovered: {len(self.referenced_types)}") + + # Step 3: Generate stubs for all referenced types + all_types_to_stub = {} + + # Add target types + all_types_to_stub.update(target_types) + + # Add referenced types that we can resolve + for referenced_type_name in self.referenced_types: + if referenced_type_name not in all_types_to_stub and referenced_type_name in self.available_types: + try: + net_type = self.available_types[referenced_type_name] + type_info = self._extract_type_info(net_type) + if type_info: + all_types_to_stub[referenced_type_name] = type_info + logger.debug(f"Added referenced type for stubbing: {referenced_type_name}") + except Exception as e: + logger.debug(f"Failed to extract referenced type {referenced_type_name}: {e}") + + logger.info(f"Total types to generate stubs for: {len(all_types_to_stub)}") + return all_types_to_stub + + def _discover_referenced_types(self, target_types: Dict[str, TypeInfo]): + """Discover all types referenced by target types""" + self.referenced_types.clear() + + for type_info in target_types.values(): + self._collect_type_references(type_info) + + def _collect_type_references(self, type_info: TypeInfo): + """Recursively collect all type references from a type""" + # Base type + if type_info.base_type: + self._add_type_reference(type_info.base_type) + + # Interfaces + for interface in type_info.interfaces: + self._add_type_reference(interface) + + # Properties + for prop_info in type_info.properties.values(): + self._add_type_reference(prop_info.type_str) + + # Methods + for method_overloads in type_info.methods.values(): + for method_info in method_overloads: + self._add_type_reference(method_info.return_type_str) + for param in method_info.parameters: + self._add_type_reference(param.type_str) + + # Fields + for field_info in type_info.fields.values(): + self._add_type_reference(field_info.type_str) + + # Constructors + for ctor_info in type_info.constructors: + for param in ctor_info.parameters: + self._add_type_reference(param.type_str) + + def _add_type_reference(self, type_str: str): + """Add a type reference, extracting the actual type name""" + if not type_str or type_str in {'Any', 'None', 'str', 'int', 'float', 'bool'}: + return + + # Extract base type from generics like List[SomeType] -> SomeType + import re + + # Handle generic types - extract both container and arguments + generic_match = re.match(r'(\w+)\[(.*)\]', type_str) + if generic_match: + container_type = generic_match.group(1) + args_str = generic_match.group(2) + + # Add container type if it's not a basic Python type + if container_type not in {'List', 'Dict', 'Optional', 'Union', 'Iterable', 'Any', 'Callable', 'Tuple', 'Set'}: + self._resolve_and_add_type(container_type) + + # Parse and add argument types + if args_str: + # Split by comma, but handle nested generics + args = self._parse_generic_args(args_str) + for arg in args: + self._add_type_reference(arg.strip()) + else: + # Simple type + self._resolve_and_add_type(type_str) + + def _parse_generic_args(self, args_str: str) -> List[str]: + """Parse generic arguments, handling nested generics""" + args = [] + current_arg = "" + bracket_depth = 0 + + for char in args_str: + if char == ',' and bracket_depth == 0: + args.append(current_arg.strip()) + current_arg = "" + else: + if char == '[': + bracket_depth += 1 + elif char == ']': + bracket_depth -= 1 + current_arg += char + + if current_arg.strip(): + args.append(current_arg.strip()) + + return args + + def _resolve_and_add_type(self, type_name: str): + """Resolve type name to full name and add to references""" + if not type_name or type_name in self.referenced_types: + return + + # Try exact match first + if type_name in self.available_types: + self.referenced_types.add(type_name) + return + + # Try to find by simple name + for full_name, net_type in self.available_types.items(): + try: + if hasattr(net_type, 'Name') and net_type.Name == type_name: + self.referenced_types.add(full_name) + return + # Also check simple name extraction + if full_name.split('.')[-1] == type_name: + self.referenced_types.add(full_name) + return + except: + continue + + def _extract_assembly_types(self, assembly) -> Dict[str, TypeInfo]: + """Extract types from a single assembly""" + types = {} + + try: + # Get all types from assembly + assembly_types = assembly.GetTypes() + + for net_type in assembly_types: + try: + # Skip compiler-generated and private types + if self._should_skip_type(net_type): + continue + + type_info = self._extract_type_info(net_type) + if type_info: + types[type_info.full_name] = type_info + + except Exception as e: + logger.debug(f"Failed to extract type info for {net_type}: {e}") + + except Exception as e: + logger.debug(f"Failed to get types from assembly {assembly}: {e}") + + return types + + def _clean_generic_type_name(self, simple_name: str, net_type) -> str: + """Clean up generic type names by extracting actual generic type parameters from C# reflection""" + if '`' not in simple_name: + return simple_name + + # Split on backtick to get base name and parameter count + parts = simple_name.split('`') + base_name = parts[0] + + if len(parts) < 2: + return simple_name + + try: + param_count = int(parts[1]) + except ValueError: + # If not a number, return as-is + return simple_name + + # For zero parameters, just return base name + if param_count == 0: + return base_name + + # Extract actual generic type parameters from C# reflection + if hasattr(net_type, 'IsGenericTypeDefinition') and net_type.IsGenericTypeDefinition: + try: + # For generic type definitions, get the generic parameters + if hasattr(net_type, 'GetGenericArguments'): + generic_args = net_type.GetGenericArguments() + if generic_args and len(generic_args) > 0: + # Use actual parameter names from C# reflection + param_names = [] + for arg in generic_args: + if hasattr(arg, 'Name'): + param_names.append(arg.Name) + else: + param_names.append(f'T{len(param_names)}') + + # Store the generic parameter info for later use in class generation + if not hasattr(net_type, '_extracted_generic_params'): + net_type._extracted_generic_params = param_names + + return base_name # Return just base name for class definition + except Exception as e: + logger.debug(f"Failed to extract generic parameters for {net_type}: {e}") + + # For non-generic type definitions or if extraction fails, return just the base name + return base_name + + def _should_skip_type(self, net_type) -> bool: + """Determine if we should skip this type""" + if not hasattr(net_type, 'FullName') or not net_type.FullName: + return True + + full_name = net_type.FullName + + # Skip compiler-generated types + if any(marker in full_name for marker in ['<', '>', '+<', 'c__DisplayClass', 'd__']): + return True + + # Skip some system types that aren't useful in stubs + if full_name.startswith('System.') and any(marker in full_name for marker in [ + 'Runtime.CompilerServices', 'Diagnostics', 'ComponentModel' + ]): + return True + + return False + + def _extract_type_info(self, net_type) -> Optional[TypeInfo]: + """Extract complete information for a single type""" + try: + full_name = net_type.FullName + simple_name = net_type.Name + namespace = net_type.Namespace or "" + + # Handle nested types + if '+' in full_name: + full_name = full_name.replace('+', '.') + + # Clean up generic type names - remove backtick notation + if '`' in simple_name: + simple_name = self._clean_generic_type_name(simple_name, net_type) + + # Determine type category + is_class = hasattr(net_type, 'IsClass') and net_type.IsClass + is_interface = hasattr(net_type, 'IsInterface') and net_type.IsInterface + is_enum = hasattr(net_type, 'IsEnum') and net_type.IsEnum + is_struct = hasattr(net_type, 'IsValueType') and net_type.IsValueType and not is_enum + + # Get base type + base_type = None + if hasattr(net_type, 'BaseType') and net_type.BaseType: + base_type = NetTypeToPythonConverter.convert_type(net_type.BaseType) + + # Get interfaces + interfaces = [] + if hasattr(net_type, 'GetInterfaces'): + for interface in net_type.GetInterfaces(): + interfaces.append(NetTypeToPythonConverter.convert_type(interface)) + + # Handle generic types + is_generic = hasattr(net_type, 'IsGenericType') and net_type.IsGenericType + generic_parameters = [] + if is_generic and hasattr(net_type, 'GetGenericArguments'): + for arg in net_type.GetGenericArguments(): + generic_parameters.append(arg.Name if hasattr(arg, 'Name') else str(arg)) + + type_info = TypeInfo( + full_name=full_name, + simple_name=simple_name, + namespace=namespace, + is_class=is_class, + is_interface=is_interface, + is_enum=is_enum, + is_struct=is_struct, + base_type=base_type, + interfaces=interfaces, + is_generic=is_generic, + generic_parameters=generic_parameters + ) + + # Extract members + self._extract_properties(net_type, type_info) + self._extract_methods(net_type, type_info) + self._extract_fields(net_type, type_info) + self._extract_constructors(net_type, type_info) + + return type_info + + except Exception as e: + logger.debug(f"Failed to extract type info for {net_type}: {e}") + return None + + def _extract_properties(self, net_type, type_info: TypeInfo): + """Extract property information""" + try: + # Get all properties (public only, including inherited properties for complete API surface) + binding_flags = BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static + properties = net_type.GetProperties(binding_flags) + + for prop in properties: + try: + # Skip compiler-generated properties + if '<' in prop.Name or '>' in prop.Name: + continue + + # Skip explicit interface implementations (properties with dots in their names) + if '.' in prop.Name: + continue + + prop_info = PropertyInfo( + name=prop.Name, + type_str=NetTypeToPythonConverter.convert_type(prop.PropertyType), + can_read=prop.CanRead, + can_write=prop.CanWrite, + is_static=hasattr(prop, 'GetMethod') and prop.GetMethod and prop.GetMethod.IsStatic + ) + + type_info.properties[prop.Name] = prop_info + + except Exception as e: + logger.debug(f"Failed to extract property {prop.Name}: {e}") + + except Exception as e: + logger.debug(f"Failed to extract properties for {net_type}: {e}") + + def _should_include_method(self, method, type_info: TypeInfo, docs: Dict[str, DocumentationInfo]) -> bool: + """Determine if a method should be included in the stub (simplified for public methods only)""" + method_name = method.Name + + # Always skip special methods and property accessors + if method.IsSpecialName or method_name.startswith('get_') or method_name.startswith('set_'): + return False + + # Skip compiler-generated methods + if '<' in method_name or '>' in method_name: + return False + + # Skip explicit interface implementations (methods with dots in their names) + if '.' in method_name and not method_name.startswith('op_'): + return False + + # Since we're only getting public methods now, include all remaining methods + return True + + def _extract_methods(self, net_type, type_info: TypeInfo): + """Extract method information""" + try: + # Get all methods (public only, including inherited methods for complete API surface) + binding_flags = BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static + methods = net_type.GetMethods(binding_flags) + + for method in methods: + try: + # Use the filtering method to determine if this method should be included + if not self._should_include_method(method, type_info, self.docs): + continue + + method_info = MethodInfo( + name=method.Name, + return_type_str=NetTypeToPythonConverter.convert_type(method.ReturnType), + is_static=method.IsStatic, + is_generic=method.IsGenericMethod + ) + + # Extract parameters + for param in method.GetParameters(): + param_name = param.Name or f"param{param.Position}" + param_type = NetTypeToPythonConverter.convert_type(param.ParameterType) + + param_info = ParameterInfo( + name=self._sanitize_identifier(param_name), + type_str=param_type, + is_optional=param.IsOptional, + default_value=self._format_default_value(param.DefaultValue, param_type) if param.IsOptional else None + ) + method_info.parameters.append(param_info) + + # Handle generic methods + if method_info.is_generic and hasattr(method, 'GetGenericArguments'): + for arg in method.GetGenericArguments(): + method_info.generic_parameters.append(arg.Name if hasattr(arg, 'Name') else str(arg)) + + # Group methods by name (for overloads) + if method.Name not in type_info.methods: + type_info.methods[method.Name] = [] + type_info.methods[method.Name].append(method_info) + + except Exception as e: + logger.debug(f"Failed to extract method {method.Name}: {e}") + + except Exception as e: + logger.debug(f"Failed to extract methods for {net_type}: {e}") + + def _extract_fields(self, net_type, type_info: TypeInfo): + """Extract field information""" + try: + # Get all fields (public only, including inherited fields for complete API surface) + binding_flags = BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static + fields = net_type.GetFields(binding_flags) + + for field in fields: + try: + # Skip compiler-generated fields + if '<' in field.Name or '>' in field.Name or field.Name.startswith('k__BackingField'): + continue + + field_info = FieldInfo( + name=field.Name, + type_str=NetTypeToPythonConverter.convert_type(field.FieldType), + is_static=field.IsStatic, + is_readonly=field.IsInitOnly + ) + + type_info.fields[field.Name] = field_info + + except Exception as e: + logger.debug(f"Failed to extract field {field.Name}: {e}") + + except Exception as e: + logger.debug(f"Failed to extract fields for {net_type}: {e}") + + def _extract_constructors(self, net_type, type_info: TypeInfo): + """Extract constructor information""" + try: + constructors = net_type.GetConstructors() + + for ctor in constructors: + try: + ctor_info = MethodInfo( + name='__init__', + return_type_str='None', + is_constructor=True, + is_static=False + ) + + # Extract parameters + for param in ctor.GetParameters(): + param_info = ParameterInfo( + name=param.Name or f"param{param.Position}", + type_str=NetTypeToPythonConverter.convert_type(param.ParameterType), + is_optional=param.IsOptional, + default_value=param.DefaultValue if param.IsOptional else None + ) + ctor_info.parameters.append(param_info) + + type_info.constructors.append(ctor_info) + + except Exception as e: + logger.debug(f"Failed to extract constructor: {e}") + + except Exception as e: + logger.debug(f"Failed to extract constructors for {net_type}: {e}") + + def _sanitize_identifier(self, name: str) -> str: + """Sanitize identifiers that conflict with Python reserved keywords""" + # Python reserved keywords that cannot be used as identifiers + PYTHON_KEYWORDS = { + 'False', 'None', 'True', 'and', 'as', 'assert', 'async', 'await', + 'break', 'class', 'continue', 'def', 'del', 'elif', 'else', 'except', + 'finally', 'for', 'from', 'global', 'if', 'import', 'in', 'is', + 'lambda', 'nonlocal', 'not', 'or', 'pass', 'raise', 'return', 'try', + 'while', 'with', 'yield' + } + + # Add underscore suffix if it's a reserved keyword + if name in PYTHON_KEYWORDS: + return f"{name}_" + + return name + + def _format_default_value(self, default_value, param_type: str): + """Format default values for Python stubs""" + if default_value is None: + return None + + # Handle enum values + if hasattr(default_value, '__class__') and hasattr(default_value.__class__, '__name__'): + class_name = default_value.__class__.__name__ + if hasattr(default_value, 'name'): # It's an enum + return f"{class_name}.{default_value.name}" + + # Handle basic types + if isinstance(default_value, str): + return repr(default_value) + elif isinstance(default_value, bool): + return str(default_value) + elif isinstance(default_value, (int, float)): + return str(default_value) + else: + # For complex types, just use None or a simple representation + return None + + +# ============================================================================= +# XML Documentation Parser +# ============================================================================= + +class XmlDocParser: + """Parses XML documentation files to extract docstrings""" + + def __init__(self): + self.doc_cache: Dict[str, DocumentationInfo] = {} + + def parse_xml_files(self, xml_files: List[str]) -> Dict[str, DocumentationInfo]: + """Parse all XML files and return documentation mapping""" + docs = {} + + for xml_file in xml_files: + try: + file_docs = self._parse_xml_file(xml_file) + docs.update(file_docs) + logger.info(f"Parsed documentation from {xml_file}: {len(file_docs)} entries") + except Exception as e: + logger.error(f"Failed to parse {xml_file}: {e}") + + return docs + + def _parse_xml_file(self, xml_file: str) -> Dict[str, DocumentationInfo]: + """Parse a single XML documentation file""" + docs = {} + + try: + tree = ET.parse(xml_file) + root = tree.getroot() + + for member in root.findall('.//member'): + name_attr = member.get('name', '') + if not name_attr or len(name_attr) < 2: + continue + + # Extract member identifier (remove T:, M:, P:, F: prefix) + member_id = name_attr[2:] if name_attr[1] == ':' else name_attr + + doc_info = self._extract_documentation(member) + docs[member_id] = doc_info + + except ET.ParseError as e: + logger.error(f"XML parsing error in {xml_file}: {e}") + except Exception as e: + logger.error(f"Unexpected error parsing {xml_file}: {e}") + + return docs + + def _extract_documentation(self, member_element) -> DocumentationInfo: + """Extract documentation from a member element""" + doc_info = DocumentationInfo() + + # Extract summary + summary_elem = member_element.find('summary') + if summary_elem is not None and summary_elem.text: + doc_info.summary = self._clean_text(summary_elem.text) + + # Extract remarks + remarks_elem = member_element.find('remarks') + if remarks_elem is not None and remarks_elem.text: + doc_info.remarks = self._clean_text(remarks_elem.text) + + # Extract returns documentation + returns_elem = member_element.find('returns') + if returns_elem is not None and returns_elem.text: + doc_info.returns_doc = self._clean_text(returns_elem.text) + + # Extract example + example_elem = member_element.find('example') + if example_elem is not None and example_elem.text: + doc_info.example = self._clean_text(example_elem.text) + + # Extract parameter descriptions + for param_elem in member_element.findall('param'): + param_name = param_elem.get('name', '') + if param_name and param_elem.text: + doc_info.param_descriptions[param_name] = self._clean_text(param_elem.text) + + # Extract exception documentation + for exception_elem in member_element.findall('exception'): + exception_type = exception_elem.get('cref', '') + if exception_type and exception_elem.text: + # Clean up the exception type (remove T: prefix if present) + if exception_type.startswith('T:'): + exception_type = exception_type[2:] + doc_info.exceptions[exception_type] = self._clean_text(exception_elem.text) + + return doc_info + + def _clean_text(self, text: str) -> str: + """Clean up XML text content""" + if not text: + return "" + + # Remove excessive whitespace while preserving line breaks + lines = text.strip().split('\n') + cleaned_lines = [line.strip() for line in lines if line.strip()] + return ' '.join(cleaned_lines) + + +# ============================================================================= +# Docstring Generator +# ============================================================================= + +class DocstringGenerator: + """Generates Google-style docstrings from documentation info""" + + @staticmethod + def generate_class_docstring(type_info: TypeInfo, doc_info: Optional[DocumentationInfo] = None) -> str: + """Generate docstring for a class""" + if not doc_info or not doc_info.summary: + return '"""Class docstring."""' + + lines = [doc_info.summary] + + if doc_info.remarks: + lines.append("") + lines.append(doc_info.remarks) + + if doc_info.example: + lines.append("") + lines.append("Example:") + lines.append(f" {doc_info.example}") + + if len(lines) == 1: + return f'"""{lines[0]}"""' + else: + content = '\n '.join(lines) + return f'"""{content}"""' + + @staticmethod + def generate_method_docstring(method_info: MethodInfo, doc_info: Optional[DocumentationInfo] = None) -> str: + """Generate docstring for a method""" + if not doc_info or not doc_info.summary: + # For constructors, provide a basic but helpful docstring + if method_info.is_constructor: + return '"""Initialize instance."""' + else: + return '"""Method docstring."""' + + lines = [doc_info.summary] + + if doc_info.remarks: + lines.append("") + lines.append(doc_info.remarks) + + # Add Args section + if method_info.parameters and doc_info.param_descriptions: + lines.append("") + lines.append("Args:") + for param in method_info.parameters: + param_doc = doc_info.param_descriptions.get(param.name, "") + param_line = f" {param.name} ({param.type_str}): {param_doc}" + lines.append(param_line) + + # Add Returns section + if method_info.return_type_str != 'None' and doc_info.returns_doc: + lines.append("") + lines.append(f"Returns:") + lines.append(f" {method_info.return_type_str}: {doc_info.returns_doc}") + + # Add Raises section + if doc_info.exceptions: + lines.append("") + lines.append("Raises:") + for exc_type, exc_desc in doc_info.exceptions.items(): + lines.append(f" {exc_type}: {exc_desc}") + + if len(lines) == 1: + return f'"""{lines[0]}"""' + else: + content = '\n '.join(lines) + return f'"""{content}"""' + + @staticmethod + def generate_property_docstring(prop_info: PropertyInfo, doc_info: Optional[DocumentationInfo] = None) -> str: + """Generate docstring for a property""" + if not doc_info or not doc_info.summary: + return f'"""{prop_info.type_str}: Property docstring."""' + + return f'"""{prop_info.type_str}: {doc_info.summary}"""' + + +# ============================================================================= +# Import Tracking +# ============================================================================= + +class ImportTracker: + """Tracks imports needed for a specific namespace during stub generation""" + + def __init__(self, current_namespace: str): + self.current_namespace = current_namespace + self.typing_imports = set() + self.datetime_imports = set() + self.system_imports = {} # System namespace -> set of types + self.external_namespaces = {} # external namespace -> set of types + + def add_type_reference(self, type_str: str, available_types: Dict[str, TypeInfo]): + """Add a type reference and track necessary imports""" + if not type_str or type_str in {'None', 'str', 'int', 'float', 'bool'}: + return + + # Handle typing imports + if type_str in {'Any', 'List', 'Dict', 'Optional', 'Union', 'Generic', 'Callable', 'Tuple', 'Set'}: + self.typing_imports.add(type_str) + return + + # Handle datetime imports + if type_str in {'datetime', 'timedelta'}: + self.datetime_imports.add(type_str) + return + + # Handle generic types + import re + generic_match = re.match(r'(\w+)\[(.*)\]', type_str) + if generic_match: + container_type = generic_match.group(1) + args_str = generic_match.group(2) + + # Add container type + self.add_type_reference(container_type, available_types) + + # Add argument types + if args_str: + args = self._parse_generic_args(args_str) + for arg in args: + self.add_type_reference(arg.strip(), available_types) + return + + # Find the type's namespace + type_namespace = self._find_type_namespace(type_str, available_types) + + if type_namespace is None: + # Unknown type, might be System type + if type_str in {'Array', 'Type', 'ValueType', 'Enum', 'MulticastDelegate', 'Action', 'Func'}: + self.system_imports.setdefault('System', set()).add(type_str) + elif type_str in {'IEnumerable', 'IList', 'IDictionary', 'ICollection'}: + self.system_imports.setdefault('System.Collections', set()).add(type_str) + elif type_str in {'XmlReader', 'XmlWriter'}: + self.system_imports.setdefault('System.Xml', set()).add(type_str) + elif type_str in {'XmlSchema'}: + self.system_imports.setdefault('System.Xml.Schema', set()).add(type_str) + return + + # If it's from a different namespace, add to external imports + if type_namespace != self.current_namespace: + self.external_namespaces.setdefault(type_namespace, set()).add(type_str) + + def _parse_generic_args(self, args_str: str) -> List[str]: + """Parse generic arguments, handling nested generics""" + args = [] + current_arg = "" + bracket_depth = 0 + + for char in args_str: + if char == ',' and bracket_depth == 0: + args.append(current_arg.strip()) + current_arg = "" + else: + if char == '[': + bracket_depth += 1 + elif char == ']': + bracket_depth -= 1 + current_arg += char + + if current_arg.strip(): + args.append(current_arg.strip()) + + return args + + def _find_type_namespace(self, type_name: str, available_types: Dict[str, TypeInfo]) -> Optional[str]: + """Find which namespace a type belongs to""" + for type_info in available_types.values(): + if type_info.simple_name == type_name: + return type_info.namespace + return None + + def generate_import_lines(self) -> List[str]: + """Generate the import statements for this namespace""" + lines = [] + + # Always include essential typing imports for stubs + essential_typing = {'Any', 'overload'} + self.typing_imports.update(essential_typing) + + # Typing imports + if self.typing_imports: + lines.append(f"from typing import {', '.join(sorted(self.typing_imports))}") + + # Datetime imports + if self.datetime_imports: + lines.append(f"from datetime import {', '.join(sorted(self.datetime_imports))}") + + # System imports + for sys_namespace, types in sorted(self.system_imports.items()): + if types: + lines.append(f"from {sys_namespace} import {', '.join(sorted(types))}") + + # External namespace imports + for ext_namespace, types in sorted(self.external_namespaces.items()): + if types: + lines.append(f"from {ext_namespace} import {', '.join(sorted(types))}") + + return lines + + +# ============================================================================= +# Python Stub Generator +# ============================================================================= + +class PythonStubGenerator: + """Generates Python stub files from type information""" + + def __init__(self, type_infos: Dict[str, TypeInfo], docs: Dict[str, DocumentationInfo]): + self.type_infos = type_infos + self.docs = docs + self.output_dir = None + # Per-namespace import tracking + self.namespace_imports = {} # namespace -> ImportTracker + self.namespace_to_types: Dict[str, Set[str]] = {} # namespace -> set of type names in that namespace + self.cross_references: Dict[str, Set[str]] = {} # namespace -> set of external types it references + + def _build_namespace_maps(self): + """Build maps of which types are in which namespaces and what they reference""" + self.namespace_to_types.clear() + self.cross_references.clear() + + # Build namespace -> types map + for type_info in self.type_infos.values(): + namespace = type_info.namespace or "" + if namespace not in self.namespace_to_types: + self.namespace_to_types[namespace] = set() + self.namespace_to_types[namespace].add(type_info.simple_name) + + # Build cross-reference map + for type_info in self.type_infos.values(): + namespace = type_info.namespace or "" + if namespace not in self.cross_references: + self.cross_references[namespace] = set() + + # Collect all referenced types + referenced_types = set() + self._collect_referenced_types_from_type_info(type_info, referenced_types) + + # Filter to external references (not in same namespace) + for ref_type in referenced_types: + # Find which namespace this referenced type belongs to + ref_namespace = self._find_type_namespace(ref_type) + if ref_namespace != namespace and ref_namespace is not None: + # This is a cross-reference + self.cross_references[namespace].add(ref_type) + + def _collect_referenced_types_from_type_info(self, type_info: TypeInfo, referenced_types: set): + """Collect all types referenced by this type info""" + # Base type + if type_info.base_type: + self._extract_type_names_from_string(type_info.base_type, referenced_types) + + # Interfaces + for interface in type_info.interfaces: + self._extract_type_names_from_string(interface, referenced_types) + + # Properties + for prop_info in type_info.properties.values(): + self._extract_type_names_from_string(prop_info.type_str, referenced_types) + + # Methods + for method_overloads in type_info.methods.values(): + for method_info in method_overloads: + self._extract_type_names_from_string(method_info.return_type_str, referenced_types) + for param in method_info.parameters: + self._extract_type_names_from_string(param.type_str, referenced_types) + + # Fields + for field_info in type_info.fields.values(): + self._extract_type_names_from_string(field_info.type_str, referenced_types) + + # Constructors + for ctor_info in type_info.constructors: + for param in ctor_info.parameters: + self._extract_type_names_from_string(param.type_str, referenced_types) + + def _extract_type_names_from_string(self, type_str: str, type_names: set): + """Extract all type names from a type string""" + if not type_str: + return + + import re + + # Skip basic Python types + if type_str in {'Any', 'None', 'str', 'int', 'float', 'bool', 'object'}: + return + + # Handle generic types + generic_match = re.match(r'(\w+)\[(.*)\]', type_str) + if generic_match: + container_type = generic_match.group(1) + args_str = generic_match.group(2) + + # Add container if it's not a basic typing type + if container_type not in {'List', 'Dict', 'Optional', 'Union', 'Iterable', 'Callable', 'Tuple', 'Set', 'Generic'}: + type_names.add(container_type) + + # Recursively parse arguments + if args_str: + args = self._parse_generic_args(args_str) + for arg in args: + self._extract_type_names_from_string(arg.strip(), type_names) + else: + # Simple type + type_names.add(type_str) + + def _parse_generic_args(self, args_str: str) -> List[str]: + """Parse generic arguments, handling nested generics""" + args = [] + current_arg = "" + bracket_depth = 0 + + for char in args_str: + if char == ',' and bracket_depth == 0: + args.append(current_arg.strip()) + current_arg = "" + else: + if char == '[': + bracket_depth += 1 + elif char == ']': + bracket_depth -= 1 + current_arg += char + + if current_arg.strip(): + args.append(current_arg.strip()) + + return args + + def _find_type_namespace(self, type_name: str) -> Optional[str]: + """Find which namespace a type belongs to""" + for namespace, types in self.namespace_to_types.items(): + if type_name in types: + return namespace + + # Check if it's a full type name that we have info for + for full_name, type_info in self.type_infos.items(): + if type_info.simple_name == type_name: + return type_info.namespace + + return None + + def _generate_imports_for_namespace(self, namespace: str, types: List[TypeInfo]) -> List[str]: + """Generate import statements for a specific namespace based on actual dependencies""" + lines = [] + + # Comprehensive typing imports needed for stubs + typing_imports = {'Any', 'List', 'Dict', 'Optional', 'Union', 'Generic', 'overload'} + datetime_imports = {'datetime'} + system_imports = {} # namespace -> set of types + cross_namespace_imports = {} # namespace -> set of types + + # Always include essential typing imports + lines.append(f"from typing import {', '.join(sorted(typing_imports))}") + lines.append(f"from datetime import {', '.join(sorted(datetime_imports))}") + + # Get cross-references for this namespace + cross_refs = self.cross_references.get(namespace, set()) + + # Analyze what we actually need from cross-references + for ref_type in cross_refs: + # Check if it's a System type + if ref_type in {'Array', 'Type', 'ValueType', 'Enum', 'MulticastDelegate'}: + system_imports.setdefault('System', set()).add(ref_type) + elif ref_type in {'XmlSchema'}: + system_imports.setdefault('System.Xml.Schema', set()).add(ref_type) + elif ref_type in {'XmlReader', 'XmlWriter'}: + system_imports.setdefault('System.Xml', set()).add(ref_type) + elif ref_type in {'BitArray', 'IEnumerator'}: + system_imports.setdefault('System.Collections', set()).add(ref_type) + elif ref_type in {'Color'}: + system_imports.setdefault('Windows.Media', set()).add(ref_type) + else: + # Check if it's a cross-namespace reference + ref_namespace = self._find_type_namespace(ref_type) + if ref_namespace and ref_namespace != namespace: + # Map interfaces to implementations where available + mapped_type = self._map_interface_to_implementation(ref_type) + cross_namespace_imports.setdefault(ref_namespace, set()).add(mapped_type) + + # Generate import lines for System types + for sys_namespace, sys_types in sorted(system_imports.items()): + lines.append(f"from {sys_namespace} import {', '.join(sorted(sys_types))}") + + # Generate import lines for cross-namespace types + for cross_namespace, cross_types in sorted(cross_namespace_imports.items()): + # Convert namespace to import path + import_path = cross_namespace.replace('.', '.') + lines.append(f"from {import_path} import {', '.join(sorted(cross_types))}") + + return lines + + def _map_interface_to_implementation(self, type_name: str) -> str: + """Map interface types to their implementation equivalents where available""" + interface_mappings = { + 'IStructureCode': 'StructureCode', + 'IExternalPlanSetup': 'ExternalPlanSetup', + 'IPhotonCalculation': 'Calculation', + 'IPhotonOptimizationClient': 'OptimizationClient', + 'IProtonPlanSetup': 'IonPlanSetup', + 'IProtonCalculation': 'Calculation', + 'IProtonOptimizationClient': 'OptimizationClient', + # Add more mappings as needed + } + return interface_mappings.get(type_name, type_name) + + def generate_stubs(self, output_dir: str): + """Generate all stub files""" + self.output_dir = Path(output_dir) + self.output_dir.mkdir(parents=True, exist_ok=True) + + # Build namespace relationship maps + self._build_namespace_maps() + + # Organize types by namespace + types_by_namespace = defaultdict(list) + for type_info in self.type_infos.values(): + types_by_namespace[type_info.namespace].append(type_info) + + # Generate stub files per namespace + for namespace, types in types_by_namespace.items(): + if namespace: # Skip empty namespace for now + self._generate_namespace_stub(namespace, types) + + logger.info(f"Generated stubs in {output_dir}") + + def _generate_namespace_stub(self, namespace: str, types: List[TypeInfo]): + """Generate stub file for a namespace""" + # Create module path + module_parts = namespace.split('.') + current_dir = self.output_dir + + for part in module_parts: + current_dir = current_dir / part + current_dir.mkdir(exist_ok=True) + + # Create __init__.py if it doesn't exist + init_file = current_dir / '__init__.py' + if not init_file.exists(): + init_file.write_text("") + + # Generate stub file + stub_file = current_dir / '__init__.pyi' + content = self._generate_module_content(namespace, types) + stub_file.write_text(content, encoding='utf-8') + + logger.info(f"Generated stub: {stub_file}") + + def _generate_module_content(self, namespace: str, types: List[TypeInfo]) -> str: + """Generate content for a module stub file""" + lines = [] + + # Add imports dynamically based on actual dependencies + import_lines = self._generate_imports_for_namespace(namespace, types) + lines.extend(import_lines) + lines.append("") + + # Generate type stubs + for type_info in sorted(types, key=lambda t: t.simple_name): + if type_info.is_class: + lines.extend(self._generate_class_stub(type_info)) + elif type_info.is_interface: + lines.extend(self._generate_interface_stub(type_info)) + elif type_info.is_enum: + lines.extend(self._generate_enum_stub(type_info)) + elif type_info.is_struct: + lines.extend(self._generate_struct_stub(type_info)) + + lines.append("") + + return '\n'.join(lines) + + def _generate_class_stub(self, type_info: TypeInfo) -> List[str]: + """Generate stub for a class""" + lines = [] + + # Class definition + class_def = f"class {type_info.simple_name}" + + # Handle inheritance + base_classes = [] + if type_info.base_type and type_info.base_type != 'Any': + base_classes.append(type_info.base_type) + + # Add Generic for generic types + if type_info.is_generic and type_info.generic_parameters: + # Create type parameter list + type_params = [] + for i, param in enumerate(type_info.generic_parameters): + if i == 0: + type_params.append('T') + else: + type_params.append(f'T{i}') + base_classes.insert(0, f"Generic[{', '.join(type_params)}]") + + if base_classes: + class_def += f"({', '.join(base_classes)})" + class_def += ":" + + lines.append(class_def) + + # Class docstring + class_doc_key = type_info.full_name + doc_info = self.docs.get(class_doc_key) + docstring = DocstringGenerator.generate_class_docstring(type_info, doc_info) + lines.append(f" {docstring}") + lines.append("") + + # Generate constructors + if type_info.constructors: + for i, ctor in enumerate(type_info.constructors): + lines.extend(self._generate_constructor_stub(ctor, i > 0)) + lines.append("") + else: + # Default constructor + lines.append(" def __init__(self) -> None:") + lines.append(" \"\"\"Initialize instance.\"\"\"") + lines.append(" ...") + lines.append("") + + # Generate properties + for prop_name, prop_info in sorted(type_info.properties.items()): + lines.extend(self._generate_property_stub(type_info, prop_info)) + lines.append("") + + # Generate methods + for method_name, method_overloads in sorted(type_info.methods.items()): + for i, method_info in enumerate(method_overloads): + lines.extend(self._generate_method_stub(type_info, method_info, i > 0)) + lines.append("") + + # Generate fields as class variables + for field_name, field_info in sorted(type_info.fields.items()): + lines.extend(self._generate_field_stub(field_info)) + + # Ensure class has at least one member + if len(lines) <= 3: # Just class def, docstring, and empty line + lines.append(" pass") + + return lines + + def _generate_interface_stub(self, type_info: TypeInfo) -> List[str]: + """Generate stub for an interface (same as class for now)""" + return self._generate_class_stub(type_info) + + def _generate_enum_stub(self, type_info: TypeInfo) -> List[str]: + """Generate stub for an enum""" + lines = [] + + lines.append(f"class {type_info.simple_name}:") + + # Enum docstring + enum_doc_key = type_info.full_name + doc_info = self.docs.get(enum_doc_key) + docstring = DocstringGenerator.generate_class_docstring(type_info, doc_info) + lines.append(f" {docstring}") + lines.append("") + + # Generate enum values as class variables + for field_name, field_info in sorted(type_info.fields.items()): + if field_info.is_static: + sanitized_field_name = self._sanitize_identifier(field_name) + lines.append(f" {sanitized_field_name}: {type_info.simple_name}") + + if not type_info.fields: + lines.append(" pass") + + return lines + + def _generate_struct_stub(self, type_info: TypeInfo) -> List[str]: + """Generate stub for a struct (same as class for now)""" + return self._generate_class_stub(type_info) + + def _generate_constructor_stub(self, ctor_info: MethodInfo, is_overload: bool) -> List[str]: + """Generate constructor stub""" + lines = [] + + if is_overload: + lines.append(" @overload") + + # Build parameter list + params = ["self"] + for param in ctor_info.parameters: + param_name = self._sanitize_identifier(param.name) + param_str = f"{param_name}: {param.type_str}" + if param.is_optional and param.default_value is not None: + param_str += f" = {repr(param.default_value)}" + params.append(param_str) + + params_str = ", ".join(params) + lines.append(f" def __init__({params_str}) -> None:") + + # Constructor docstring + doc_key = f"{ctor_info.name}" # Constructor docs are usually on the type + doc_info = self.docs.get(doc_key) + docstring = DocstringGenerator.generate_method_docstring(ctor_info, doc_info) + lines.append(f" {docstring}") + lines.append(" ...") + + return lines + + def _generate_property_stub(self, type_info: TypeInfo, prop_info: PropertyInfo) -> List[str]: + """Generate property stub""" + lines = [] + + # Sanitize property name for Python keywords + prop_name = self._sanitize_identifier(prop_info.name) + + if prop_info.is_static: + lines.append(" @classmethod") + lines.append(" @property") + lines.append(f" def {prop_name}(cls) -> {prop_info.type_str}:") + else: + lines.append(" @property") + lines.append(f" def {prop_name}(self) -> {prop_info.type_str}:") + + # Property docstring + prop_doc_key = f"{type_info.full_name}.{prop_info.name}" + doc_info = self.docs.get(prop_doc_key) + docstring = DocstringGenerator.generate_property_docstring(prop_info, doc_info) + lines.append(f" {docstring}") + lines.append(" ...") + + # Add setter if writable + if prop_info.can_write: + lines.append("") + if prop_info.is_static: + lines.append(" @classmethod") + lines.append(f" @{prop_name}.setter") + if prop_info.is_static: + lines.append(f" def {prop_name}(cls, value: {prop_info.type_str}) -> None:") + else: + lines.append(f" def {prop_name}(self, value: {prop_info.type_str}) -> None:") + lines.append(" \"\"\"Set property value.\"\"\"") + lines.append(" ...") + + return lines + + def _sanitize_identifier(self, name: str) -> str: + """Sanitize identifiers that conflict with Python reserved keywords""" + # Python reserved keywords that cannot be used as identifiers + PYTHON_KEYWORDS = { + 'False', 'None', 'True', 'and', 'as', 'assert', 'async', 'await', + 'break', 'class', 'continue', 'def', 'del', 'elif', 'else', 'except', + 'finally', 'for', 'from', 'global', 'if', 'import', 'in', 'is', + 'lambda', 'nonlocal', 'not', 'or', 'pass', 'raise', 'return', 'try', + 'while', 'with', 'yield' + } + + # Add underscore suffix if it's a reserved keyword + if name in PYTHON_KEYWORDS: + return f"{name}_" + + return name + + def _generate_method_stub(self, type_info: TypeInfo, method_info: MethodInfo, is_overload: bool) -> List[str]: + """Generate method stub""" + lines = [] + + if is_overload: + lines.append(" @overload") + + if method_info.is_static: + lines.append(" @staticmethod") + + # Sanitize method name + method_name = self._sanitize_identifier(method_info.name) + + # Build parameter list + params = [] if method_info.is_static else ["self"] + for param in method_info.parameters: + param_name = self._sanitize_identifier(param.name) + param_str = f"{param_name}: {param.type_str}" + if param.is_optional and param.default_value is not None: + param_str += f" = {repr(param.default_value)}" + params.append(param_str) + + params_str = ", ".join(params) + lines.append(f" def {method_name}({params_str}) -> {method_info.return_type_str}:") + + # Method docstring + method_doc_key = f"{type_info.full_name}.{method_info.name}" + doc_info = self.docs.get(method_doc_key) + docstring = DocstringGenerator.generate_method_docstring(method_info, doc_info) + lines.append(f" {docstring}") + lines.append(" ...") + + return lines + + def _generate_field_stub(self, field_info: FieldInfo) -> List[str]: + """Generate field stub as class variable""" + lines = [] + + field_name = self._sanitize_identifier(field_info.name) + + if field_info.is_static: + lines.append(f" {field_name}: {field_info.type_str}") + else: + # Instance fields become annotations + lines.append(f" {field_name}: {field_info.type_str}") + + return lines + + +# ============================================================================= +# Main Application +# ============================================================================= + +def find_dll_files(folder: str) -> List[str]: + """Find all DLL files in the folder""" + dll_files = [] + folder_path = Path(folder) + + if folder_path.is_dir(): + for dll_file in folder_path.glob("*.dll"): + dll_files.append(str(dll_file)) + + return dll_files + + +def find_xml_files(folder: str) -> List[str]: + """Find all XML files in the folder""" + xml_files = [] + folder_path = Path(folder) + + if folder_path.is_dir(): + for xml_file in folder_path.glob("*.xml"): + xml_files.append(str(xml_file)) + + return xml_files + + +def main(): + """Main entry point""" + if len(sys.argv) < 2: + print("Usage: python dotnet_stubsv3.py [output_folder]") + sys.exit(1) + + dll_folder = sys.argv[1] + output_folder = sys.argv[2] if len(sys.argv) > 2 else "stubs_v3" + + if not Path(dll_folder).exists(): + logger.error(f"DLL folder not found: {dll_folder}") + sys.exit(1) + + # Find DLL and XML files + dll_files = find_dll_files(dll_folder) + xml_files = find_xml_files(dll_folder) + + logger.info(f"Found {len(dll_files)} DLL files and {len(xml_files)} XML files") + + if not dll_files: + logger.error("No DLL files found") + sys.exit(1) + + # Step 1: Parse XML documentation first (needed for method filtering) + logger.info("Step 1: Parsing XML documentation...") + xml_parser = XmlDocParser() + docs = xml_parser.parse_xml_files(xml_files) + + # Step 2: Load DLLs and extract type information (with documentation-based filtering) + logger.info("Step 2: Loading DLLs and extracting type information...") + introspector = DllIntrospector(dll_files, docs) + introspector.load_assemblies() + type_infos = introspector.extract_all_types() + + # Step 3: Generate Python stubs + logger.info("Step 3: Generating Python stub files...") + stub_generator = PythonStubGenerator(type_infos, docs) + stub_generator.generate_stubs(output_folder) + + logger.info(f"Stub generation completed. Output: {output_folder}") + + +if __name__ == "__main__": + main() diff --git a/stubgen/dotnet_to_stubs.py b/stubgen/dotnet_to_stubs.py deleted file mode 100644 index cb347d0..0000000 --- a/stubgen/dotnet_to_stubs.py +++ /dev/null @@ -1,1576 +0,0 @@ -#!/usr/bin/env python3 -""" -XML Documentation to Python Stub Generator -Generates Python type stubs (.pyi) from .NET XML documentation files - -Usage: - python dotnet_to_stubs.py [output_folder] - -Arguments: - library_folder: Folder containing XML documentation and DLL files (will be searched recursively) - output_folder: Output folder for generated stubs (default: stubs) - -Example: - python dotnet_to_stubs.py "C:\Program Files\Varian\RTM\18.0\esapi\API" stubs -""" - -import os -import sys -import re -import xml.etree.ElementTree as ET -from pathlib import Path -from typing import Dict, List, Set, Optional, Tuple -from collections import defaultdict - -try: - import clr - import System - HAS_PYTHONNET = True -except ImportError: - HAS_PYTHONNET = False - print("Warning: pythonnet not available. Type introspection will be limited.") - -def detect_pythonnet_conversions() -> Dict[str, str]: - """ - Detect which .NET types pythonnet automatically converts to Python types. - Returns a mapping of .NET type names to their Python equivalents. - """ - if not HAS_PYTHONNET: - return {} - - conversions = {} - - # Test basic types by creating instances and checking their Python types - test_cases = [ - ('System.String', 'hello'), - ('System.Boolean', True), - ('System.Int32', 42), - ('System.Int64', 42), - ('System.Double', 3.14), - ('System.Single', 3.14), - ('System.Byte', 255), - ] - - for net_type_name, test_value in test_cases: - try: - # Get the .NET type - net_type = getattr(System, net_type_name.replace('System.', '')) - - # Create an instance (this may get converted by pythonnet) - if net_type_name == 'System.String': - instance = System.String(test_value) - else: - instance = net_type(test_value) - - # Check what Python type we actually get - python_type = type(instance) - - if python_type == str: - conversions[net_type_name] = 'str' - elif python_type == bool: - conversions[net_type_name] = 'bool' - elif python_type == int: - conversions[net_type_name] = 'int' - elif python_type == float: - conversions[net_type_name] = 'float' - else: - # If it's still a .NET type, don't convert it in stubs - print(f"Type {net_type_name} remains as .NET type: {python_type}") - - except Exception as e: - print(f"Could not test {net_type_name}: {e}") - - return conversions - -# Type mappings from C# to Python -TYPE_MAPPINGS = { - 'System.String': 'str', - 'string': 'str', - 'String': 'str', - 'System.Int32': 'int', - 'int': 'int', - 'Int32': 'int', - 'System.Double': 'float', - 'double': 'float', - 'Double': 'Double', # Keep as .NET type for array handling - 'System.Single': 'float', - 'single': 'float', - 'Single': 'Single', # Keep as .NET type for array handling - 'System.Boolean': 'bool', - 'bool': 'bool', - 'Boolean': 'Boolean', # Keep as .NET type for array handling - 'void': 'None', - 'System.Void': 'None', - 'object': 'Any', - 'System.Object': 'Any', - 'Object': 'Any', - 'System.DateTime': 'datetime', - 'DateTime': 'datetime', - 'System.Collections.Generic.IEnumerable': 'List', - 'IEnumerable': 'List', - 'System.Collections.Generic.ICollection': 'List', - 'ICollection': 'List', - 'System.Collections.Generic.List': 'List', - 'List': 'List', - 'System.Array': 'Array', - 'Array': 'Array', -} - -class DllTypeIntrospector: - """Uses pythonnet to introspect DLL types for accurate type information""" - - def __init__(self, dll_paths: List[str] = None): - self.dll_paths = dll_paths or [] - self.loaded_assemblies = {} - self.type_cache = {} - self.method_cache = {} - - # Detect what pythonnet actually converts - self.pythonnet_conversions = detect_pythonnet_conversions() if HAS_PYTHONNET else {} - - if HAS_PYTHONNET: - self._load_dlls() - - def _load_dlls(self): - """Load DLLs using pythonnet""" - if not HAS_PYTHONNET: - return - - for dll_path in self.dll_paths: - try: - clr.AddReference(str(dll_path)) - print(f"Loaded DLL: {dll_path}") - except Exception as e: - print(f"Failed to load {dll_path}: {e}") - continue - - def get_method_signature(self, class_full_name: str, method_name: str) -> Optional[Dict]: - """Get method signature information from the DLL""" - if not HAS_PYTHONNET: - return None - - cache_key = f"{class_full_name}.{method_name}" - if cache_key in self.method_cache: - return self.method_cache[cache_key] - - try: - # Try to import the type directly using pythonnet - namespace_parts = class_full_name.split('.') - if len(namespace_parts) < 2: - return None - - module_name = '.'.join(namespace_parts[:-1]) - class_name = namespace_parts[-1] - - # Import the namespace module - exec(f"import {module_name}") - namespace_module = eval(module_name) - - if not hasattr(namespace_module, class_name): - self.method_cache[cache_key] = None - return None - - type_obj = getattr(namespace_module, class_name) - clr_type = clr.GetClrType(type_obj) - - if not clr_type: - self.method_cache[cache_key] = None - return None - - signature = { - 'parameters': [], - 'return_type': 'Any' - } - - if method_name == '__init__': - # Get constructors - constructors = clr_type.GetConstructors() - constructor_sigs = [] - - for ctor in constructors: - ctor_sig = { - 'parameters': [], - 'return_type': 'None' - } - - parameters = ctor.GetParameters() - for param in parameters: - param_type = self._convert_net_type_to_python(param.ParameterType) - ctor_sig['parameters'].append({ - 'name': param.Name, - 'type': param_type - }) - - constructor_sigs.append(ctor_sig) - - result = {'constructors': constructor_sigs} - self.method_cache[cache_key] = result - return result - else: - # Get regular methods - methods = clr_type.GetMethods() - for method in methods: - if method.Name == method_name: - parameters = method.GetParameters() - for param in parameters: - param_type = self._convert_net_type_to_python(param.ParameterType) - signature['parameters'].append({ - 'name': param.Name, - 'type': param_type - }) - - # Get return type - return_type = self._convert_net_type_to_python(method.ReturnType) - signature['return_type'] = return_type - - self.method_cache[cache_key] = signature - return signature - - except Exception as e: - # Silently fail for now - we'll use XML fallback - pass - - self.method_cache[cache_key] = None - return None - - def _extract_method_signature(self, method_info) -> Optional[Dict]: - """Extract signature information from a method object""" - try: - signature = { - 'parameters': [], - 'return_type': 'Any' - } - - # Try to get parameter information - if hasattr(method_info, '__annotations__'): - annotations = method_info.__annotations__ - for param_name, param_type in annotations.items(): - if param_name != 'return': - signature['parameters'].append({ - 'name': param_name, - 'type': self._convert_net_type_to_python(param_type) - }) - - if 'return' in annotations: - signature['return_type'] = self._convert_net_type_to_python(annotations['return']) - - # Try to get from .NET reflection if available - if hasattr(method_info, 'GetParameters'): - params = method_info.GetParameters() - signature['parameters'] = [] - for param in params: - signature['parameters'].append({ - 'name': param.Name, - 'type': self._convert_net_type_to_python(param.ParameterType) - }) - - if hasattr(method_info, 'ReturnType'): - signature['return_type'] = self._convert_net_type_to_python(method_info.ReturnType) - - return signature - - except Exception: - return None - - def _convert_net_type_to_python(self, net_type) -> str: - """Convert .NET type to Python type string""" - if net_type is None: - return 'Any' - - # Get the full type name - if hasattr(net_type, 'FullName') and net_type.FullName: - type_name = net_type.FullName - elif hasattr(net_type, 'Name') and net_type.Name: - type_name = net_type.Name - else: - type_name = str(net_type) - - # First, check if pythonnet automatically converts this type - if type_name in self.pythonnet_conversions: - return self.pythonnet_conversions[type_name] - - # Handle types that we know pythonnet converts (fallback if detection failed) - known_conversions = { - # Basic types that pythonnet typically converts - 'System.String': 'str', - 'System.Boolean': 'bool', - 'System.Int32': 'int', - 'System.Int64': 'int', - 'System.Int16': 'int', - 'System.UInt32': 'int', - 'System.UInt64': 'int', - 'System.UInt16': 'int', - 'System.Byte': 'int', - 'System.SByte': 'int', - 'System.Double': 'float', - 'System.Single': 'float', - 'System.Decimal': 'float', - 'System.DateTime': 'datetime', - 'System.TimeSpan': 'timedelta', - 'System.Guid': 'str', - 'System.Void': 'None', - 'System.Object': 'Any', - - # Nullable types - these get converted to Optional - 'System.Nullable`1[System.Int32]': 'Optional[int]', - 'System.Nullable`1[System.Double]': 'Optional[float]', - 'System.Nullable`1[System.Boolean]': 'Optional[bool]', - 'System.Nullable`1[System.DateTime]': 'Optional[datetime]', - - # Collections - these typically stay as .NET types but we provide Python-like interfaces - 'System.Collections.Generic.IEnumerable': 'Iterable[Any]', - 'System.Collections.Generic.ICollection': 'Collection[Any]', - 'System.Collections.Generic.IList': 'List[Any]', - 'System.Collections.Generic.IDictionary': 'Dict[Any, Any]', - 'System.Array': 'Array[Any]', - } - - if type_name in known_conversions: - return known_conversions[type_name] - - # Handle arrays - if hasattr(net_type, 'IsArray') and net_type.IsArray: - element_type = net_type.GetElementType() - element_python_type = self._convert_net_type_to_python(element_type) - - # .NET Array is already multidimensional, so Array[float] can represent - # both 1D and multidimensional arrays of float - return f'Array[{element_python_type}]' - - # Handle generic types - if hasattr(net_type, 'IsGenericType') and net_type.IsGenericType: - generic_def = net_type.GetGenericTypeDefinition() - generic_args = net_type.GetGenericArguments() - - generic_def_name = generic_def.FullName if hasattr(generic_def, 'FullName') else str(generic_def) - - # Handle VRect specifically - if 'VRect' in generic_def_name: - if len(generic_args) > 0: - arg_type = self._convert_net_type_to_python(generic_args[0]) - return f'VRect[{arg_type}]' # Preserve the generic type parameter - return 'VRect' - - # Handle KeyValuePair - if 'KeyValuePair' in generic_def_name: - if len(generic_args) >= 2: - key_type = self._convert_net_type_to_python(generic_args[0]) - value_type = self._convert_net_type_to_python(generic_args[1]) - return f'KeyValuePair[{key_type}, {value_type}]' - return 'KeyValuePair[Any, Any]' - - # Handle IEnumerator - if 'IEnumerator' in generic_def_name: - if len(generic_args) > 0: - arg_type = self._convert_net_type_to_python(generic_args[0]) - return f'Iterable[{arg_type}]' - return 'Iterable[Any]' - - # Handle IReadOnlyCollection - if 'IReadOnlyCollection' in generic_def_name: - if len(generic_args) > 0: - arg_type = self._convert_net_type_to_python(generic_args[0]) - return f'Collections.Generic.IReadOnlyCollection[{arg_type}]' - return 'Collections.Generic.IReadOnlyCollection[Any]' - - # Handle ICollection - if 'ICollection' in generic_def_name and 'IReadOnlyCollection' not in generic_def_name: - if len(generic_args) > 0: - arg_type = self._convert_net_type_to_python(generic_args[0]) - return f'Collections.Generic.ICollection[{arg_type}]' - return 'Collections.Generic.ICollection[Any]' - - # Handle other VMS generic types - if generic_def_name and 'VMS.TPS.Common.Model' in generic_def_name: - # Extract just the class name from the generic definition - simple_name = generic_def_name.split('.')[-1].split('`')[0] # Remove `1 suffix - - # For specific VMS types that should preserve generic parameters - if simple_name in ['VRect', 'VVector'] and len(generic_args) > 0: - converted_args = [self._convert_net_type_to_python(arg) for arg in generic_args] - return f'{simple_name}[{", ".join(converted_args)}]' - - # For other VMS types, just return the simple name - return simple_name - - if 'List' in generic_def_name or 'IEnumerable' in generic_def_name: - if len(generic_args) > 0: - arg_type = self._convert_net_type_to_python(generic_args[0]) - return f'List[{arg_type}]' - return 'List[Any]' - elif 'Dictionary' in generic_def_name: - if len(generic_args) >= 2: - key_type = self._convert_net_type_to_python(generic_args[0]) - value_type = self._convert_net_type_to_python(generic_args[1]) - return f'Dict[{key_type}, {value_type}]' - return 'Dict[str, Any]' - elif 'Nullable' in generic_def_name: - if len(generic_args) > 0: - arg_type = self._convert_net_type_to_python(generic_args[0]) - return f'Optional[{arg_type}]' - - # Handle VMS types - these remain as .NET objects, so keep class names - if type_name and type_name.startswith('VMS.TPS.Common.Model'): - return type_name.split('.')[-1] - - # Handle System types - if type_name and type_name.startswith('System.'): - system_type = type_name.replace('System.', '') - return known_conversions.get(f'System.{system_type}', system_type) - - # For unknown types, extract the last part (class name) - # These are likely complex .NET types that don't get converted - if '.' in type_name: - return type_name.split('.')[-1] - - return type_name or 'Any' - - def get_property_type(self, class_full_name: str, property_name: str) -> Optional[str]: - """Get property type information from the DLL""" - if not HAS_PYTHONNET: - return None - - cache_key = f"{class_full_name}.{property_name}" - if cache_key in self.type_cache: - return self.type_cache[cache_key] - - try: - # Try to import the type directly using pythonnet - namespace_parts = class_full_name.split('.') - if len(namespace_parts) < 2: - return None - - module_name = '.'.join(namespace_parts[:-1]) - class_name = namespace_parts[-1] - - # Import the namespace module - exec(f"import {module_name}") - namespace_module = eval(module_name) - - if not hasattr(namespace_module, class_name): - self.type_cache[cache_key] = None - return None - - type_obj = getattr(namespace_module, class_name) - clr_type = clr.GetClrType(type_obj) - - if not clr_type: - self.type_cache[cache_key] = None - return None - - # Get property info - properties = clr_type.GetProperties() - for prop in properties: - if prop.Name == property_name: - prop_type = self._convert_net_type_to_python(prop.PropertyType) - self.type_cache[cache_key] = prop_type - return prop_type - - # Also check fields - fields = clr_type.GetFields() - for field in fields: - if field.Name == property_name: - field_type = self._convert_net_type_to_python(field.FieldType) - self.type_cache[cache_key] = field_type - return field_type - - except Exception: - pass - - self.type_cache[cache_key] = None - return None - -class XmlApiElement: - """Represents a .NET API element parsed from XML documentation""" - - def __init__(self, member_name: str, element_type: str): - self.member_name = member_name # Full member name like "T:VMS.TPS.Common.Model.API.AddOn" - self.element_type = element_type # T, P, M, F, E - self.namespace = "" - self.class_name = "" - self.name = "" - self.return_type = "Any" - self.parameters: List[Dict] = [] - self.summary = "" - self.remarks = "" - self.inheritance = [] - self.param_descriptions = {} # Parameter descriptions from XML - - self._parse_member_name() - - def _parse_member_name(self): - """Parse the member name to extract namespace, class, and element info""" - # Remove the prefix (T:, P:, M:, F:) - full_name = self.member_name[2:] # Remove "T:", "P:", etc. - - if self.element_type == 'T': # Type (class, interface, enum) - # For types, the last part is the class name - parts = full_name.split('.') - self.namespace = '.'.join(parts[:-1]) - self.class_name = parts[-1] - self.name = parts[-1] - elif self.element_type == 'M': # Method - # Methods have parameters in parentheses - if '(' in full_name: - method_part, params_part = full_name.split('(', 1) - params_part = params_part.rstrip(')') - - # Parse method name and class - method_parts = method_part.split('.') - self.name = method_parts[-1] - - # Handle constructor first (before interface cleanup) - if self.name == '#ctor': - self.name = '__init__' - elif '#' in self.name: - # Clean up explicit interface implementation names (remove Interface#Method -> Method) - # For explicit interface implementations like "System#Collections#IEnumerable#GetEnumerator" - # Extract just the method name after the last # - # Special case: #ctor should become __init__, not ctor - method_name = self.name.split('#')[-1] - if method_name == 'ctor': - self.name = '__init__' - else: - self.name = method_name - - # Remove C# method overload suffixes (``1, ``2, etc.) - if '``' in self.name: - self.name = self.name.split('``')[0] - - if len(method_parts) > 1: - self.class_name = method_parts[-2] - self.namespace = '.'.join(method_parts[:-2]) - - # Parse parameters - if params_part.strip(): - param_types = self._parse_parameter_types(params_part) - for i, param_type in enumerate(param_types): - self.parameters.append({ - 'name': f'param{i+1}', - 'type': self._convert_csharp_type_to_python(param_type), - 'csharp_type': param_type - }) - else: - # Method without parameters - parts = full_name.split('.') - self.name = parts[-1] - - # Handle constructor first (before interface cleanup) - if self.name == '#ctor': - self.name = '__init__' - elif '#' in self.name: - # Clean up explicit interface implementation names (remove Interface#Method -> Method) - # For explicit interface implementations like "System#Collections#IEnumerable#GetEnumerator" - # Extract just the method name after the last # - # Special case: #ctor should become __init__, not ctor - method_name = self.name.split('#')[-1] - if method_name == 'ctor': - self.name = '__init__' - else: - self.name = method_name - - # Remove C# method overload suffixes (``1, ``2, etc.) - if '``' in self.name: - self.name = self.name.split('``')[0] - - if len(parts) > 1: - self.class_name = parts[-2] - self.namespace = '.'.join(parts[:-2]) - else: - # Properties and Fields - parts = full_name.split('.') - self.name = parts[-1] - - # Handle constructor first (before interface cleanup) - if self.name == '#ctor': - self.name = '__init__' - elif '#' in self.name: - # Clean up explicit interface implementation names (remove Interface#Method -> Method) - # For explicit interface implementations like "System#Collections#IEnumerable#GetEnumerator" - # Extract just the method name after the last # - # Special case: #ctor should become __init__, not ctor - method_name = self.name.split('#')[-1] - if method_name == 'ctor': - self.name = '__init__' - else: - self.name = method_name - - # Remove C# method overload suffixes (``1, ``2, etc.) - if '``' in self.name: - self.name = self.name.split('``')[0] - - if len(parts) > 1: - self.class_name = parts[-2] - self.namespace = '.'.join(parts[:-2]) - - def _parse_parameter_types(self, params_str: str) -> List[str]: - """Parse parameter types from method signature""" - if not params_str.strip(): - return [] - - # Handle generic types, arrays, and nested commas - params = [] - current_param = "" - bracket_depth = 0 - - for char in params_str + ',': # Add comma at end to process last param - if char in '<{[': - bracket_depth += 1 - current_param += char - elif char in '>}]': - bracket_depth -= 1 - current_param += char - elif char == ',' and bracket_depth == 0: - # Only split on comma if we're not inside brackets/braces - # This handles cases like System.Single[0:,0:] where the comma is part of array bounds - if current_param.strip(): - params.append(current_param.strip()) - current_param = "" - else: - current_param += char - - return params - - def _convert_csharp_type_to_python(self, csharp_type: str, preserve_net_types: bool = False) -> str: - """Convert C# type to Python type""" - # If the type is already in Python format (from DLL introspector), don't convert it - if (csharp_type.startswith('Array[') or csharp_type.startswith('List[') or - csharp_type.startswith('Dict[') or csharp_type.startswith('Optional[') or - csharp_type.startswith('Iterable[') or csharp_type.startswith('KeyValuePair[') or - csharp_type.startswith('Collections.Generic.IReadOnlyCollection[') or - csharp_type.startswith('Collections.Generic.ICollection[')): - return csharp_type - - # Remove ref/out keywords and & or @ suffix (@ indicates reference parameters in XML) - csharp_type = re.sub(r'\b(ref|out)\s+', '', csharp_type) - csharp_type = csharp_type.rstrip('&@') - - # More robust assembly-qualified cleanup for deeply nested generic types - # Handle patterns like [[TypeName, Assembly, Version=...]] -> [TypeName] - def clean_assembly_qualified(text): - """Recursively clean assembly-qualified type names in nested generics""" - # First, handle double brackets [[Type, Assembly...]] -> [Type] - double_bracket_pattern = r'\[\[([^\[\],]+)(?:,\s*[^\[\]]*?)\]\]' - text = re.sub(double_bracket_pattern, r'[\1]', text) - - # Then handle single brackets [Type, Assembly...] -> [Type] but only if it contains assembly info - # Look for the pattern: [TypeName, something with Version or Culture or PublicKeyToken] - single_bracket_assembly_pattern = r'\[([^,\[\]]+),\s*[^\[\]]*?(?:Version|Culture|PublicKeyToken)[^\[\]]*?\]' - text = re.sub(single_bracket_assembly_pattern, r'[\1]', text) - - return text - - csharp_type = clean_assembly_qualified(csharp_type) - - # Handle assembly-qualified names - remove everything after the comma - # Example: String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 -> String - # But only do this AFTER cleaning nested brackets - if ', ' in csharp_type and 'Version=' in csharp_type: - csharp_type = csharp_type.split(', ')[0] - - # Handle curly braces in the entire string recursively - while '{' in csharp_type and '}' in csharp_type: - csharp_type = csharp_type.replace('{', '<').replace('}', '>') - - # Convert C# backtick generic syntax to angle bracket syntax for further processing - # Example: List`1[String] -> List - backtick_generic_pattern = r'([^`\[]+)`\d+\[([^\]]+)\]' - backtick_match = re.match(backtick_generic_pattern, csharp_type) - if backtick_match: - base_type = backtick_match.group(1) - args = backtick_match.group(2) - csharp_type = f'{base_type}<{args}>' - - # Handle .NET 2D array syntax like System.Single[0:,0:] -> System.Single with 2D array marker - # This pattern: Type[bounds] where bounds contains comma(s) indicates multidimensional array - array_bounds_match = re.match(r'([^[]+)\[([^\]]*:[^\]]*,.*?)\]', csharp_type) - if array_bounds_match: - base_type = array_bounds_match.group(1) - bounds = array_bounds_match.group(2) - # Count commas to determine dimensions (1 comma = 2D, 2 commas = 3D, etc.) - dimensions = bounds.count(',') + 1 - - # Convert the base type - python_base_type = self._convert_csharp_type_to_python(base_type, preserve_net_types=False) - - # .NET Array is already multidimensional, so Array[float] represents all dimensions - return f'Array[{python_base_type}]' - - # Handle C# generic type syntax with backticks - # The number after backtick indicates how many type parameters the generic type takes - - # Case 1: Backtick with square brackets (e.g., List`1[String] -> List) - if '`' in csharp_type and '[' in csharp_type and ']' in csharp_type: - # Convert backtick syntax to angle bracket syntax: List`1[String] -> List - backtick_match = re.match(r'([^`]+)`\d+(\[.+\])', csharp_type) - if backtick_match: - base_name = backtick_match.group(1) - type_args = backtick_match.group(2) # [String] or [String, Int32] - # Convert [String] to - angle_bracket_args = type_args.replace('[', '<').replace(']', '>') - csharp_type = f'{base_name}{angle_bracket_args}' - - # Case 2: Backtick without brackets (e.g., VRect`1 -> VRect[T]) - # Only match when backtick immediately follows the class name and there are no square brackets - elif '`' in csharp_type and '<' not in csharp_type and '[' not in csharp_type: - match = re.match(r'([^`]+)`(\d+)', csharp_type) - if match: - base_name = match.group(1).split('.')[-1] # Get just the class name - type_param_count = int(match.group(2)) - - # Generate generic type parameters - if type_param_count == 1: - return f'{base_name}[T]' - else: - type_params = [f'T{i+1}' for i in range(type_param_count)] - return f'{base_name}[{", ".join(type_params)}]' - - # Handle C# generic type parameter references like `0, `1, ``0, ``1, etc. - if re.match(r'^`+\d+$', csharp_type): - # Extract the number after all the backticks - param_num = int(re.search(r'\d+', csharp_type).group()) - if param_num == 0: - return 'T' - else: - return f'T{param_num + 1}' - - # Handle malformed generic types like VRect{`0} or VRect<`0> -> VRect[T] - malformed_generic = re.match(r'([^{<]+)[{<](`*\d+)[}>]', csharp_type) - if malformed_generic: - base_name = malformed_generic.group(1).split('.')[-1] - param_ref = malformed_generic.group(2) - param_num = int(re.search(r'\d+', param_ref).group()) - param_name = 'T' if param_num == 0 else f'T{param_num + 1}' - return f'{base_name}[{param_name}]' - - # Handle array types first (before generic handling) - if '[]' in csharp_type: - # Count array dimensions - array_count = csharp_type.count('[]') - base_type = csharp_type.replace('[]', '') - - # Convert the base type, preserving .NET types for arrays - python_base_type = self._convert_csharp_type_to_python(base_type, preserve_net_types=True) - - # Handle different array dimensions - if array_count == 1: - # Single-dimensional array: Type[] -> Array[Type] - return f'Array[{python_base_type}]' - elif array_count == 2: - # Jagged array: Type[][] -> Array[Array[Type]] - return f'Array[Array[{python_base_type}]]' - else: - # For higher dimensions, keep nesting Array types - result = python_base_type - for _ in range(array_count): - result = f'Array[{result}]' - return result - - # Handle generic types - if '<' in csharp_type and '>' in csharp_type: - # Extract generic base type and arguments - match = re.match(r'([^<]+)<(.+)>', csharp_type) - if match: - base_type = match.group(1) - generic_args = match.group(2) - - # Convert collection types to Python equivalents - # Handle specific collection types first (before generic handling) - if base_type in ['System.Collections.Generic.IReadOnlyCollection', 'Collections.Generic.IReadOnlyCollection']: - # Preserve IReadOnlyCollection as a more specific type with full namespace - arg_type = self._convert_csharp_type_to_python(generic_args, preserve_net_types) - # For VMS types, extract just the class name - if arg_type.startswith('VMS.TPS.Common.Model'): - arg_type = arg_type.split('.')[-1] - return f'Collections.Generic.IReadOnlyCollection[{arg_type}]' - elif base_type in ['System.Collections.Generic.ICollection', 'Collections.Generic.ICollection']: - # Preserve ICollection as a more specific type with full namespace - arg_type = self._convert_csharp_type_to_python(generic_args, preserve_net_types) - # For VMS types, extract just the class name - if arg_type.startswith('VMS.TPS.Common.Model'): - arg_type = arg_type.split('.')[-1] - return f'Collections.Generic.ICollection[{arg_type}]' - elif base_type in ['System.Collections.Generic.List', 'System.Collections.Generic.IList', - 'System.Collections.Generic.IEnumerable', - 'Collections.Generic.List', 'Collections.Generic.IList', - 'Collections.Generic.IEnumerable']: - arg_type = self._convert_csharp_type_to_python(generic_args, preserve_net_types) - # For VMS types, extract just the class name - if arg_type.startswith('VMS.TPS.Common.Model'): - arg_type = arg_type.split('.')[-1] - return f'List[{arg_type}]' - elif base_type in ['System.Collections.Generic.Dictionary', 'System.Collections.Generic.IDictionary', - 'Collections.Generic.Dictionary', 'Collections.Generic.IDictionary']: - # Handle Dictionary - args = self._parse_parameter_types(generic_args) - if len(args) >= 2: - key_type = self._convert_csharp_type_to_python(args[0], preserve_net_types) - value_type = self._convert_csharp_type_to_python(args[1], preserve_net_types) - return f'Dict[{key_type}, {value_type}]' - elif base_type == 'System.Nullable': - arg_type = self._convert_csharp_type_to_python(generic_args, preserve_net_types) - return f'Optional[{arg_type}]' - else: - # For other generic types, preserve the .NET type with Python syntax - # Convert the argument types recursively - args = self._parse_parameter_types(generic_args) - converted_args = [self._convert_csharp_type_to_python(arg, preserve_net_types) for arg in args] - # Extract just the class name from the base type - if '.' in base_type: - base_name = base_type.split('.')[-1] - else: - base_name = base_type - return f'{base_name}[{", ".join(converted_args)}]' - - # For array element types, preserve .NET type names - if preserve_net_types: - net_type_mappings = { - 'System.Double': 'Double', - 'Double': 'Double', - 'System.Single': 'Single', - 'Single': 'Single', - 'System.Int32': 'Int32', - 'Int32': 'Int32', - 'System.Boolean': 'Boolean', - 'Boolean': 'Boolean', - 'System.String': 'String', - 'String': 'String', - } - if csharp_type in net_type_mappings: - return net_type_mappings[csharp_type] - - # Direct type mappings - if csharp_type in TYPE_MAPPINGS: - return TYPE_MAPPINGS[csharp_type] - - # Handle VMS types - extract just the class name - if csharp_type.startswith('VMS.TPS.Common.Model'): - parts = csharp_type.split('.') - return parts[-1] # Return just the class name - - # Handle System types - if csharp_type.startswith('System.'): - system_type = csharp_type.replace('System.', '') - return TYPE_MAPPINGS.get(system_type, system_type) - - # For unknown types, extract the last part (class name) - if '.' in csharp_type: - parts = csharp_type.split('.') - return parts[-1] - - return csharp_type - - def get_qualified_name(self) -> str: - """Get the fully qualified name""" - if self.namespace: - return f"{self.namespace}.{self.class_name}.{self.name}" - else: - return f"{self.class_name}.{self.name}" - - def __repr__(self): - return f"XmlApiElement(name='{self.name}', type='{self.element_type}', class='{self.class_name}', namespace='{self.namespace}')" - -class XmlDocumentationParser: - """Parser for .NET XML documentation files""" - - def __init__(self, dll_paths: List[str] = None): - self.elements: List[XmlApiElement] = [] - self.types_by_namespace: Dict[str, List[XmlApiElement]] = defaultdict(list) - self.members_by_class: Dict[str, List[XmlApiElement]] = defaultdict(list) - self.dll_introspector = DllTypeIntrospector(dll_paths) if HAS_PYTHONNET else None - - def parse_xml_file(self, xml_file: str) -> List[XmlApiElement]: - """Parse XML documentation file and extract API elements""" - if not os.path.exists(xml_file): - print(f"XML file not found: {xml_file}") - return [] - - print(f"Parsing XML file: {xml_file}") - - try: - tree = ET.parse(xml_file) - root = tree.getroot() - - # Find the members section - members = root.find('members') - if members is None: - print("No members section found in XML") - return [] - - elements = [] - for member in members.findall('member'): - name = member.get('name', '') - if not name: - continue - - # Determine element type from prefix - element_type = name[0] if name else 'T' - - element = XmlApiElement(name, element_type) - - # Extract documentation - summary = member.find('summary') - if summary is not None: - element.summary = self._clean_text(summary.text or "") - - remarks = member.find('remarks') - if remarks is not None: - element.remarks = self._clean_text(remarks.text or "") - - # Extract parameters for methods - if element_type == 'M': - params = member.findall('param') - xml_param_info = {} - for param in params: - param_name = param.get('name', '') - param_desc = self._clean_text(param.text or "") - xml_param_info[param_name] = param_desc - - # Update parameter names and descriptions from XML if available - if xml_param_info and element.parameters: - for i, param in enumerate(element.parameters): - xml_name = list(xml_param_info.keys())[i] if i < len(xml_param_info) else None - if xml_name: - param['name'] = xml_name - param['description'] = xml_param_info[xml_name] - - # Store parameter info for methods without parsed parameters - element.param_descriptions = xml_param_info - - # Enhance with DLL introspection if available - if self.dll_introspector: - self._enhance_method_with_dll_info(element) - - # Enhance property types with DLL introspection - elif element_type == 'P' and self.dll_introspector: - self._enhance_property_with_dll_info(element) - - elements.append(element) - self.elements.append(element) - - print(f"Found {len(elements)} API elements") - self._organize_elements() - - return elements - - except ET.ParseError as e: - print(f"Error parsing XML file: {e}") - return [] - - def _enhance_method_with_dll_info(self, element: XmlApiElement): - """Enhance method element with DLL type information (only supplement missing types)""" - if not element.namespace or not element.class_name: - return - - class_full_name = f"{element.namespace}.{element.class_name}" - method_signature = self.dll_introspector.get_method_signature(class_full_name, element.name) - - if method_signature: - if element.name == '__init__' and 'constructors' in method_signature: - # Handle constructor overloads - constructors = method_signature['constructors'] - if constructors and len(constructors) > 0: - # Use the first constructor for now, could be enhanced to handle overloads - ctor_info = constructors[0] - if 'parameters' in ctor_info: - # Only update parameter types if they are "Any" (missing from XML) - for i, dll_param in enumerate(ctor_info['parameters']): - if i < len(element.parameters): - if element.parameters[i]['type'] == 'Any': - element.parameters[i]['type'] = dll_param['type'] - # Always update parameter names if DLL has better info - if dll_param['name'] and element.parameters[i]['name'].startswith('param'): - element.parameters[i]['name'] = dll_param['name'] - else: - # Regular method - if 'parameters' in method_signature: - # Only update parameter types if they are "Any" (missing from XML) - for i, dll_param in enumerate(method_signature['parameters']): - if i < len(element.parameters): - if element.parameters[i]['type'] == 'Any': - element.parameters[i]['type'] = dll_param['type'] - # Always update parameter names if DLL has better info - if dll_param['name'] and element.parameters[i]['name'].startswith('param'): - element.parameters[i]['name'] = dll_param['name'] - - # Always update return type if it's "Any" (missing from XML) - if 'return_type' in method_signature and element.return_type == 'Any': - raw_return_type = method_signature['return_type'] - # The DLL introspector already returns properly formatted Python types, - # so we don't need to convert them again - element.return_type = raw_return_type - - def _enhance_property_with_dll_info(self, element: XmlApiElement): - """Enhance property element with DLL type information (only supplement missing types)""" - if not element.namespace or not element.class_name: - return - - class_full_name = f"{element.namespace}.{element.class_name}" - prop_type = self.dll_introspector.get_property_type(class_full_name, element.name) - - # Only update property type if it's "Any" (missing from XML) - if prop_type and element.return_type == 'Any': - element.return_type = prop_type - - def _clean_text(self, text: str) -> str: - """Clean and format documentation text""" - if not text: - return "" - - # Remove extra whitespace and normalize - text = re.sub(r'\s+', ' ', text.strip()) - - # Remove XML comments and tags - text = re.sub(r'', '', text) - text = re.sub(r'', '', text) - text = re.sub(r'<[^>]+>', '', text) - - return text.strip() - - def _organize_elements(self): - """Organize elements by namespace and class for easier stub generation""" - for element in self.elements: - # Group by namespace - self.types_by_namespace[element.namespace].append(element) - - # Group members by their parent class - if element.element_type in ['P', 'M', 'F']: # Properties, Methods, Fields - class_key = f"{element.namespace}.{element.class_name}".strip('.') - self.members_by_class[class_key].append(element) - elif element.element_type == 'T' and '.' in element.name: - # Handle nested types like VVector.Component - parent_class = element.name.split('.')[0] - parent_key = f"{element.namespace}.{parent_class}".strip('.') - # Treat nested types as members of their parent class for now - # This could be improved to handle them as actual nested classes - element.element_type = 'NT' # Nested Type - self.members_by_class[parent_key].append(element) - -class XmlStubGenerator: - """Generates Python stub files from XML documentation""" - - def __init__(self, parser: XmlDocumentationParser): - self.parser = parser - - def generate_stubs(self, output_dir: str): - """Generate Python stub files organized by namespace""" - output_path = Path(output_dir) - output_path.mkdir(exist_ok=True) - - print(f"Generating stubs in {output_dir}") - - # Generate stubs for each namespace - for namespace, elements in self.parser.types_by_namespace.items(): - if not namespace: # Skip empty namespace - continue - - self._generate_namespace_stubs(namespace, elements, output_path) - - print(f"Stub generation complete!") - print(f"Namespaces generated: {len(self.parser.types_by_namespace)}") - print(f"Total elements: {len(self.parser.elements)}") - - def _generate_namespace_stubs(self, namespace: str, elements: List[XmlApiElement], base_path: Path): - """Generate stub files for a specific namespace""" - # Create directory structure - namespace_parts = namespace.split('.') - current_path = base_path - - for part in namespace_parts: - current_path = current_path / part - current_path.mkdir(exist_ok=True) - - # Create __init__.pyi - init_file = current_path / "__init__.pyi" - if not init_file.exists(): - init_file.write_text("") - - # Group elements by type - types = [e for e in elements if e.element_type == 'T'] - - if types: - # Generate main module file - module_file = current_path / f"{namespace_parts[-1]}.pyi" - self._write_module_stub(module_file, namespace, types) - - def _write_module_stub(self, file_path: Path, namespace: str, types: List[XmlApiElement]): - """Write a module stub file with classes and their members""" - with open(file_path, 'w', encoding='utf-8') as f: - # Write header - f.write('"""\n') - f.write(f'Type stubs for {namespace}\n') - f.write('Generated from .NET XML documentation\n') - f.write('"""\n\n') - - # Collect all type references used in this module - type_references = self._collect_type_references(types, namespace) - - # Check if we need TypeVar and Generic for generic classes - has_generics = any('`' in element.name for element in types) - - # Check if we need overload for classes with multiple constructors - has_overloads = self._has_constructor_overloads(types, namespace) - - # Write basic imports - imports = ["Any", "List", "Optional", "Union", "Dict", "Iterable"] - if has_generics: - imports.extend(["TypeVar", "Generic"]) - if has_overloads: - imports.append("overload") - - f.write(f"from typing import {', '.join(imports)}\n") - f.write("from datetime import datetime\n") - f.write("from System import Array, Double, Single, Int32, Boolean, String\n") - f.write("from System.Collections.Generic import KeyValuePair\n") - f.write("from System import Collections\n") - - # Write TypeVar declarations for generic classes - if has_generics: - f.write("\n# Generic type variables\n") - f.write("T = TypeVar('T')\n") - f.write("T1 = TypeVar('T1')\n") - f.write("T2 = TypeVar('T2')\n") - f.write("T3 = TypeVar('T3')\n") - - # Write type imports - if type_references: - f.write("\n# Type imports\n") - for import_line in sorted(type_references): - f.write(f"{import_line}\n") - - f.write("\n") - - # Write each type - for type_element in types: - self._write_type_stub(f, type_element) - f.write("\n") - - def _collect_type_references(self, types: List[XmlApiElement], current_namespace: str) -> set: - """Collect all type references that need to be imported""" - imports = set() - - # Get all members for types in this namespace - for type_element in types: - class_key = f"{type_element.namespace}.{type_element.name}".strip('.') - members = self.parser.members_by_class.get(class_key, []) - - # Check type references in method parameters - for member in members: - if member.element_type == 'M': # Methods - for param in member.parameters: - param_type = param.get('csharp_type', '') - import_stmt = self._get_import_for_type(param_type, current_namespace) - if import_stmt: - imports.add(import_stmt) - - # For properties, check for explicit type references in documentation - elif member.element_type == 'P': # Properties - # Look for type references in the summary - if member.summary: - # Look for explicit type references like "See " - type_matches = re.findall(r' bool: - """Check if any class in this module has multiple constructors requiring @overload""" - for type_element in types: - class_key = f"{type_element.namespace}.{type_element.name}".strip('.') - members = self.parser.members_by_class.get(class_key, []) - - # Count constructors for this class - constructors = [m for m in members if m.element_type == 'M' and m.name == '__init__'] - if len(constructors) > 1: - return True - - return False - - def _get_import_for_type(self, csharp_type: str, current_namespace: str) -> str: - """Generate import statement for a C# type if needed""" - if not csharp_type or csharp_type in ['System.String', 'System.Boolean', 'System.Int32', 'System.Double', 'System.Single', 'System.Void', 'System.Object']: - return None - - # Clean up curly braces first - clean_type = csharp_type.replace('{', '<').replace('}', '>') - - # Clean up the type name - remove generic parameters and array notation - clean_type = re.sub(r'<.*?>', '', clean_type) # Remove generics like List - clean_type = re.sub(r'\[\]', '', clean_type) # Remove array notation - clean_type = clean_type.strip() - - # Don't try to import array types or basic system types - if clean_type.endswith('[]') or clean_type.startswith('Array['): - return None - - # Handle VMS.TPS types - if clean_type.startswith('VMS.TPS.Common.Model'): - # Extract the namespace and class name - parts = clean_type.split('.') - if len(parts) < 2: - return None - - type_namespace = '.'.join(parts[:-1]) - class_name = parts[-1] - - # Don't import from the same namespace - if type_namespace == current_namespace: - return None - - # Convert namespace to import path - if type_namespace == 'VMS.TPS.Common.Model.Types': - if current_namespace == 'VMS.TPS.Common.Model.API': - return f"from ..Types.Types import {class_name}" - else: - return f"from .Types import {class_name}" - elif type_namespace == 'VMS.TPS.Common.Model.API': - if current_namespace == 'VMS.TPS.Common.Model.Types': - return f"from ..API.API import {class_name}" - else: - return f"from .API import {class_name}" - - return None - - def _write_type_stub(self, f, type_element: XmlApiElement): - """Write a stub for a single type (class/interface/enum)""" - # Convert the class name to handle generics - class_name = type_element._convert_csharp_type_to_python(type_element.name) - - # Write class definition - f.write(f"class {class_name}") - - # Handle inheritance - for generic classes, inherit from Generic - inheritance_list = [] - if '`' in type_element.name: - # This is a generic class, add Generic[T] to inheritance - if '[T]' in class_name: - inheritance_list.append("Generic[T]") - elif '[T1' in class_name: - # Multiple type parameters - type_params = [] - if 'T1' in class_name: - type_params.append('T1') - if 'T2' in class_name: - type_params.append('T2') - if 'T3' in class_name: - type_params.append('T3') - inheritance_list.append(f"Generic[{', '.join(type_params)}]") - - if type_element.inheritance: - inheritance_list.extend(type_element.inheritance) - - if inheritance_list: - f.write(f"({', '.join(inheritance_list)})") - f.write(":\n") - - # Get members for this class - class_key = f"{type_element.namespace}.{type_element.class_name}".strip('.') - members = self.parser.members_by_class.get(class_key, []) - - # Write class docstring with Google style format - if type_element.summary or members: - f.write(' """\n') - if type_element.summary: - f.write(f' {type_element.summary}\n') - - # Add attributes section for properties - properties = [m for m in members if m.element_type == 'P'] - if properties: - f.write('\n Attributes:\n') - for prop in properties: - # Use DLL-enhanced type if available, otherwise infer - if prop.return_type and prop.return_type != "Any": - prop_type = prop.return_type - else: - prop_type = self._infer_property_type(prop.name, prop.summary) - - if prop.summary: - f.write(f' {prop.name} ({prop_type}): {prop.summary}\n') - else: - f.write(f' {prop.name} ({prop_type}): Property value.\n') - - if type_element.remarks: - f.write(f'\n Note:\n {type_element.remarks}\n') - f.write(' """\n') - - if not members: - # Empty class - f.write(" def __init__(self) -> None: ...\n") - else: - # Write constructors first - constructors = [m for m in members if m.element_type == 'M' and m.name == '__init__'] - if constructors: - # Only add @overload decorator if there are multiple constructors - has_multiple_constructors = len(constructors) > 1 - for ctor in constructors: - self._write_method_stub(f, ctor, has_multiple_constructors) - f.write("\n") - else: - # No explicit constructors found, write default one - f.write(" def __init__(self) -> None: ...\n\n") - - # Write properties - properties = [m for m in members if m.element_type == 'P'] - for prop in properties: - self._write_property_stub(f, prop) - f.write("\n") - - # Write nested types - nested_types = [m for m in members if m.element_type == 'NT'] - for nested_type in nested_types: - self._write_nested_type_stub(f, nested_type) - f.write("\n") - - # Write methods (excluding constructors, getters, and setters) - methods = [m for m in members if m.element_type == 'M' and not m.name.startswith('get_') and not m.name.startswith('set_') and m.name != '__init__'] - for method in methods: - self._write_method_stub(f, method) - f.write("\n") - - def _write_property_stub(self, f, prop: XmlApiElement): - """Write a property stub""" - # Skip individual comments since they're now in the class docstring - - # Use DLL-enhanced type if available, otherwise infer from name/summary - if prop.return_type and prop.return_type != "Any": - prop_type = prop.return_type - else: - prop_type = self._infer_property_type(prop.name, prop.summary) - - f.write(f' {prop.name}: {prop_type}\n') - - def _infer_property_type(self, prop_name: str, summary: str) -> str: - """Infer property type from name and summary""" - prop_name_lower = prop_name.lower() - summary_lower = summary.lower() if summary else "" - - # Date/time properties - if any(word in prop_name_lower for word in ['date', 'time', 'datetime', 'created', 'modified']): - return 'datetime' - - # Boolean properties - if (prop_name_lower.startswith('is') or prop_name_lower.startswith('has') or - prop_name_lower.startswith('can') or prop_name_lower.startswith('should') or - any(word in summary_lower for word in ['true', 'false', 'boolean', 'whether'])): - return 'bool' - - # String properties - if (any(word in prop_name_lower for word in ['name', 'text', 'description', 'comment', 'note', 'id', 'uid']) or - any(word in summary_lower for word in ['string', 'text', 'name', 'identifier'])): - return 'str' - - # Numeric properties - if (any(word in prop_name_lower for word in ['count', 'number', 'size', 'length', 'width', 'height', 'dose', 'value']) or - any(word in summary_lower for word in ['number', 'count', 'value', 'dose', 'percentage'])): - if 'dose' in prop_name_lower or 'dose' in summary_lower: - return 'DoseValue' # Specific ESAPI type - return 'float' - - # Collection properties - if (prop_name.endswith('s') and not prop_name.endswith('Status') and - any(word in summary_lower for word in ['collection', 'list', 'array', 'enumerable'])): - return 'List[Any]' - - # Look for type references in summary (e.g., "See ") - type_match = re.search(r' None:\n') - else: - f.write(f' def {method.name}(self{param_str}) -> {return_type}:\n') - - # Add Google style docstring with parameter descriptions if available - param_docs = [] - if hasattr(method, 'param_descriptions') and method.param_descriptions: - for param in method.parameters: - param_name = param['name'] - if param_name in method.param_descriptions and method.param_descriptions[param_name]: - param_docs.append(f" {param_name}: {method.param_descriptions[param_name]}") - - if param_docs: - f.write(' """\n') - f.write(" Args:\n") - f.write('\n'.join(param_docs) + '\n') - f.write(' """\n') - f.write(" ...\n\n") - else: - f.write(" ...\n\n") - - def _write_nested_type_stub(self, f, nested_type: XmlApiElement): - """Write a nested type (like enum or inner class)""" - # Extract the nested type name (e.g., "Component" from "VVector.Component") - nested_name = nested_type.name.split('.')[-1] - - if nested_type.summary: - f.write(f' # {nested_type.summary}\n') - - f.write(f' class {nested_name}:\n') - if nested_type.summary: - f.write(' """\n') - f.write(f' {nested_type.summary}\n') - f.write(' """\n') - f.write(' pass\n') - - def _infer_type_from_summary(self, summary: str) -> str: - """Infer type from summary text""" - if not summary: - return "Any" - - summary_lower = summary.lower() - - # Common type patterns - if 'string' in summary_lower or 'text' in summary_lower: - return 'str' - elif 'number' in summary_lower or 'count' in summary_lower or 'size' in summary_lower: - return 'int' - elif 'date' in summary_lower or 'time' in summary_lower: - return 'datetime' - elif 'bool' in summary_lower or 'whether' in summary_lower or 'indicates' in summary_lower: - return 'bool' - elif 'list' in summary_lower or 'collection' in summary_lower or 'array' in summary_lower: - return 'List[Any]' - - return "Any" - - def _infer_return_type_from_summary(self, summary: str) -> str: - """Infer return type from method summary""" - if not summary: - return "Any" - - summary_lower = summary.lower() - - if 'returns' in summary_lower: - # Try to extract type info after "returns" - if 'string' in summary_lower: - return 'str' - elif 'bool' in summary_lower or 'whether' in summary_lower: - return 'bool' - elif 'number' in summary_lower or 'count' in summary_lower: - return 'int' - - # Method name patterns - if summary_lower.startswith('gets') or summary_lower.startswith('retrieves'): - return self._infer_type_from_summary(summary) - elif summary_lower.startswith('sets') or summary_lower.startswith('converts'): - return 'None' - - return "Any" - -def find_xml_files(library_folder: str) -> List[str]: - """Find all XML documentation files in the library folder""" - xml_files = [] - library_path = Path(library_folder) - - if not library_path.exists(): - print(f"Warning: Library folder does not exist: {library_folder}") - return xml_files - - # Search for .xml files in the specified folder only - for xml_file in library_path.glob("*.xml"): - xml_files.append(str(xml_file)) - - return xml_files - -def find_dll_files(library_folder: str) -> List[str]: - """Find all DLL files in the library folder""" - dll_files = [] - library_path = Path(library_folder) - - if not library_path.exists(): - print(f"Warning: Library folder does not exist: {library_folder}") - return dll_files - - # Search for .dll files in the specified folder only - for dll_file in library_path.glob("*.dll"): - dll_files.append(str(dll_file)) - - return dll_files - -def main(): - if len(sys.argv) < 2: - print("Usage: python dotnet_to_stubs.py [output_folder]") - print(" library_folder: Folder containing XML documentation and DLL files") - print(" output_folder: Output folder for generated stubs (default: stubs)") - print("Example: python dotnet_to_stubs.py C:/ARIA/bin stubs") - sys.exit(1) - - library_folder = sys.argv[1] - output_folder = sys.argv[2] if len(sys.argv) > 2 else "stubs" - - # Find XML and DLL files in the library folder - print(f"Scanning library folder: {library_folder}") - xml_files = find_xml_files(library_folder) - dll_files = find_dll_files(library_folder) - - if not xml_files: - print(f"No XML documentation files found in {library_folder}") - sys.exit(1) - - print(f"Found {len(xml_files)} XML file(s):") - for xml_file in xml_files: - print(f" - {xml_file}") - - print(f"Found {len(dll_files)} DLL file(s):") - for dll_file in dll_files: - print(f" - {dll_file}") - - # Process each XML file - all_elements = [] - parser = XmlDocumentationParser(dll_files) - - for xml_file in xml_files: - print(f"\nProcessing XML file: {xml_file}") - elements = parser.parse_xml_file(xml_file) - - if elements: - all_elements.extend(elements) - print(f" Found {len(elements)} API elements") - else: - print(f" No elements found in {xml_file}") - - if not all_elements: - print("No elements found in any XML files") - sys.exit(1) - - print(f"\nTotal elements found: {len(all_elements)}") - - # Generate stubs - generator = XmlStubGenerator(parser) - generator.generate_stubs(output_folder) - -if __name__ == "__main__": - main() From 87017d602ea26d1832ff500c69f2a952dc2a1915 Mon Sep 17 00:00:00 2001 From: Michael Folkerts Date: Sat, 26 Jul 2025 09:04:49 -0700 Subject: [PATCH 4/7] added generic type definitions, tying to get overloads working --- stubgen/dotnet_stubs.py | 60 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 58 insertions(+), 2 deletions(-) diff --git a/stubgen/dotnet_stubs.py b/stubgen/dotnet_stubs.py index a72fa64..06e1d63 100644 --- a/stubgen/dotnet_stubs.py +++ b/stubgen/dotnet_stubs.py @@ -854,11 +854,15 @@ def _should_include_method(self, method, type_info: TypeInfo, docs: Dict[str, Do if '.' in method_name and not method_name.startswith('op_'): return False + if method_name.startswith('op_'): + return True + # Since we're only getting public methods now, include all remaining methods - return True + return not method.IsSpecialName def _extract_methods(self, net_type, type_info: TypeInfo): """Extract method information""" + logger.debug(f"Considering method: {method.Name}, IsSpecialName: {method.IsSpecialName}, IsPublic: {method.IsPublic}, IsStatic: {method.IsStatic}") try: # Get all methods (public only, including inherited methods for complete API surface) binding_flags = BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static @@ -1211,10 +1215,15 @@ def add_type_reference(self, type_str: str, available_types: Dict[str, TypeInfo] return # Handle typing imports - if type_str in {'Any', 'List', 'Dict', 'Optional', 'Union', 'Generic', 'Callable', 'Tuple', 'Set'}: + if type_str in {'Any', 'List', 'Dict', 'Optional', 'Union', 'Generic', 'Callable', 'Tuple', 'Set', 'TypeVar'}: self.typing_imports.add(type_str) return + # Handle generic type parameters (T, T1, T2, etc.) + if re.match(r'^T\d*$', type_str): + self.typing_imports.add('TypeVar') + return + # Handle datetime imports if type_str in {'datetime', 'timedelta'}: self.datetime_imports.add(type_str) @@ -1321,6 +1330,30 @@ def generate_import_lines(self) -> List[str]: class PythonStubGenerator: """Generates Python stub files from type information""" + OPERATOR_TO_MAGIC_METHOD = { + 'op_Addition': '__add__', + 'op_Subtraction': '__sub__', + 'op_Multiply': '__mul__', + 'op_Division': '__truediv__', + 'op_Modulus': '__mod__', + 'op_Equality': '__eq__', + 'op_Inequality': '__ne__', + 'op_LessThan': '__lt__', + 'op_GreaterThan': '__gt__', + 'op_LessThanOrEqual': '__le__', + 'op_GreaterThanOrEqual': '__ge__', + 'op_BitwiseAnd': '__and__', + 'op_BitwiseOr': '__or__', + 'op_ExclusiveOr': '__xor__', + 'op_UnaryNegation': '__neg__', + 'op_UnaryPlus': '__pos__', + 'op_Increment': '__inc__', + 'op_Decrement': '__dec__', + 'op_LogicalNot': '__not__', + 'op_LeftShift': '__lshift__', + 'op_RightShift': '__rshift__', + } + def __init__(self, type_infos: Dict[str, TypeInfo], docs: Dict[str, DocumentationInfo]): self.type_infos = type_infos self.docs = docs @@ -1461,6 +1494,12 @@ def _generate_imports_for_namespace(self, namespace: str, types: List[TypeInfo]) # Comprehensive typing imports needed for stubs typing_imports = {'Any', 'List', 'Dict', 'Optional', 'Union', 'Generic', 'overload'} + + # Check if any types in this namespace are generic and need TypeVar + has_generic_types = any(type_info.is_generic and type_info.generic_parameters for type_info in types) + if has_generic_types: + typing_imports.add('TypeVar') + datetime_imports = {'datetime'} system_imports = {} # namespace -> set of types cross_namespace_imports = {} # namespace -> set of types @@ -1570,6 +1609,22 @@ def _generate_module_content(self, namespace: str, types: List[TypeInfo]) -> str lines.extend(import_lines) lines.append("") + # Collect all generic type parameters used in this module + type_vars_needed = set() + for type_info in types: + if type_info.is_generic and type_info.generic_parameters: + for i, param in enumerate(type_info.generic_parameters): + if i == 0: + type_vars_needed.add('T') + else: + type_vars_needed.add(f'T{i}') + + # Generate TypeVar declarations if needed + if type_vars_needed: + for type_var in sorted(type_vars_needed): + lines.append(f"{type_var} = TypeVar('{type_var}')") + lines.append("") + # Generate type stubs for type_info in sorted(types, key=lambda t: t.simple_name): if type_info.is_class: @@ -1779,6 +1834,7 @@ def _generate_method_stub(self, type_info: TypeInfo, method_info: MethodInfo, is lines.append(" @staticmethod") # Sanitize method name + method_name = self.OPERATOR_TO_MAGIC_METHOD.get(method_info.name, method_info.name) method_name = self._sanitize_identifier(method_info.name) # Build parameter list From 190b79b0a2e468b8acfe6ac5aa9d68cf2e4fb98d Mon Sep 17 00:00:00 2001 From: Michael Folkerts Date: Sat, 26 Jul 2025 12:37:58 -0700 Subject: [PATCH 5/7] added proper doc strings to field setters/getters etc. --- stubgen/dotnet_stubs.py | 90 ++++++++++++++++++++++++++++++++++++----- 1 file changed, 80 insertions(+), 10 deletions(-) diff --git a/stubgen/dotnet_stubs.py b/stubgen/dotnet_stubs.py index 06e1d63..bc41c02 100644 --- a/stubgen/dotnet_stubs.py +++ b/stubgen/dotnet_stubs.py @@ -20,10 +20,10 @@ - Preserve actual pythonnet runtime behavior in generated stubs Usage: - python dotnet_stubsv3.py [output_folder] + python dotnet_stubs.py [output_folder] Example: - python dotnet_stubsv3.py "C:\Program Files\Varian\RTM\18.0\esapi\API" stubs_v3 + python dotnet_stubs.py "C:\Program Files\Varian\RTM\18.0\esapi\API" stubs """ import sys @@ -99,6 +99,8 @@ class MethodInfo: is_constructor: bool = False is_generic: bool = False generic_parameters: List[str] = field(default_factory=list) + # Store original .NET parameter types for XML documentation lookup + original_parameter_types: List[str] = field(default_factory=list) @dataclass @@ -654,19 +656,38 @@ def _extract_assembly_types(self, assembly) -> Dict[str, TypeInfo]: try: # Get all types from assembly assembly_types = assembly.GetTypes() + logger.info(f"Found {len(assembly_types)} total types in assembly {assembly.GetName().Name}") + + public_count = 0 + skipped_count = 0 + extracted_count = 0 for net_type in assembly_types: try: + # Check if type is public + if hasattr(net_type, 'IsPublic') and not net_type.IsPublic: + continue + + public_count += 1 + # Skip compiler-generated and private types if self._should_skip_type(net_type): + skipped_count += 1 + logger.debug(f"Skipping type: {net_type.FullName}") continue type_info = self._extract_type_info(net_type) if type_info: types[type_info.full_name] = type_info + extracted_count += 1 + logger.debug(f"Extracted type: {type_info.full_name}") + else: + logger.debug(f"Failed to extract type info for: {net_type.FullName}") except Exception as e: logger.debug(f"Failed to extract type info for {net_type}: {e}") + + logger.info(f"Assembly {assembly.GetName().Name}: {public_count} public types, {skipped_count} skipped, {extracted_count} extracted") except Exception as e: logger.debug(f"Failed to get types from assembly {assembly}: {e}") @@ -747,6 +768,8 @@ def _extract_type_info(self, net_type) -> Optional[TypeInfo]: simple_name = net_type.Name namespace = net_type.Namespace or "" + logger.debug(f"Processing type: {full_name}") + # Handle nested types if '+' in full_name: full_name = full_name.replace('+', '.') @@ -761,6 +784,8 @@ def _extract_type_info(self, net_type) -> Optional[TypeInfo]: is_enum = hasattr(net_type, 'IsEnum') and net_type.IsEnum is_struct = hasattr(net_type, 'IsValueType') and net_type.IsValueType and not is_enum + logger.debug(f"Type {full_name}: class={is_class}, interface={is_interface}, enum={is_enum}, struct={is_struct}") + # Get base type base_type = None if hasattr(net_type, 'BaseType') and net_type.BaseType: @@ -799,10 +824,13 @@ def _extract_type_info(self, net_type) -> Optional[TypeInfo]: self._extract_fields(net_type, type_info) self._extract_constructors(net_type, type_info) + logger.debug(f"Successfully extracted type info for {full_name}") return type_info except Exception as e: - logger.debug(f"Failed to extract type info for {net_type}: {e}") + logger.warning(f"Failed to extract type info for {net_type}: {e}") + import traceback + logger.debug(traceback.format_exc()) return None def _extract_properties(self, net_type, type_info: TypeInfo): @@ -862,7 +890,6 @@ def _should_include_method(self, method, type_info: TypeInfo, docs: Dict[str, Do def _extract_methods(self, net_type, type_info: TypeInfo): """Extract method information""" - logger.debug(f"Considering method: {method.Name}, IsSpecialName: {method.IsSpecialName}, IsPublic: {method.IsPublic}, IsStatic: {method.IsStatic}") try: # Get all methods (public only, including inherited methods for complete API surface) binding_flags = BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static @@ -870,6 +897,8 @@ def _extract_methods(self, net_type, type_info: TypeInfo): for method in methods: try: + logger.debug(f"Considering method: {method.Name}, IsSpecialName: {method.IsSpecialName}, IsPublic: {method.IsPublic}, IsStatic: {method.IsStatic}") + # Use the filtering method to determine if this method should be included if not self._should_include_method(method, type_info, self.docs): continue @@ -886,6 +915,10 @@ def _extract_methods(self, net_type, type_info: TypeInfo): param_name = param.Name or f"param{param.Position}" param_type = NetTypeToPythonConverter.convert_type(param.ParameterType) + # Store original .NET type name for XML documentation lookup + original_type_name = param.ParameterType.FullName or str(param.ParameterType) + method_info.original_parameter_types.append(original_type_name) + param_info = ParameterInfo( name=self._sanitize_identifier(param_name), type_str=param_type, @@ -1701,7 +1734,7 @@ def _generate_class_stub(self, type_info: TypeInfo) -> List[str]: # Generate fields as class variables for field_name, field_info in sorted(type_info.fields.items()): - lines.extend(self._generate_field_stub(field_info)) + lines.extend(self._generate_field_stub(type_info, field_info)) # Ensure class has at least one member if len(lines) <= 3: # Just class def, docstring, and empty line @@ -1730,6 +1763,15 @@ def _generate_enum_stub(self, type_info: TypeInfo) -> List[str]: for field_name, field_info in sorted(type_info.fields.items()): if field_info.is_static: sanitized_field_name = self._sanitize_identifier(field_name) + + # Look up field documentation for enum values + field_doc_key = f"{type_info.full_name}.{field_info.name}" + doc_info = self.docs.get(field_doc_key) + + # Add documentation comment if available + if doc_info and doc_info.summary: + lines.append(f" # {doc_info.summary}") + lines.append(f" {sanitized_field_name}: {type_info.simple_name}") if not type_info.fields: @@ -1801,7 +1843,13 @@ def _generate_property_stub(self, type_info: TypeInfo, prop_info: PropertyInfo) lines.append(f" def {prop_name}(cls, value: {prop_info.type_str}) -> None:") else: lines.append(f" def {prop_name}(self, value: {prop_info.type_str}) -> None:") - lines.append(" \"\"\"Set property value.\"\"\"") + + # Use the same documentation for setter as getter, but modify it slightly + if doc_info and doc_info.summary: + setter_docstring = f'"""Set {prop_info.type_str}: {doc_info.summary}"""' + else: + setter_docstring = f'"""Set {prop_info.type_str}: Property setter."""' + lines.append(f" {setter_docstring}") lines.append(" ...") return lines @@ -1849,21 +1897,43 @@ def _generate_method_stub(self, type_info: TypeInfo, method_info: MethodInfo, is params_str = ", ".join(params) lines.append(f" def {method_name}({params_str}) -> {method_info.return_type_str}:") - # Method docstring - method_doc_key = f"{type_info.full_name}.{method_info.name}" + # Method docstring - build documentation key with parameter types for overload support + if method_info.original_parameter_types: + # Build full method signature for XML documentation lookup (like XML format) + param_types_str = ",".join(method_info.original_parameter_types) + method_doc_key = f"{type_info.full_name}.{method_info.name}({param_types_str})" + else: + # Fallback to simple key for parameterless methods + method_doc_key = f"{type_info.full_name}.{method_info.name}" + doc_info = self.docs.get(method_doc_key) + + # If no exact match found, try simple key as fallback + if not doc_info: + simple_key = f"{type_info.full_name}.{method_info.name}" + doc_info = self.docs.get(simple_key) + docstring = DocstringGenerator.generate_method_docstring(method_info, doc_info) lines.append(f" {docstring}") lines.append(" ...") return lines - def _generate_field_stub(self, field_info: FieldInfo) -> List[str]: - """Generate field stub as class variable""" + def _generate_field_stub(self, type_info: TypeInfo, field_info: FieldInfo) -> List[str]: + """Generate field stub as class variable with documentation""" lines = [] field_name = self._sanitize_identifier(field_info.name) + # Look up field documentation + field_doc_key = f"{type_info.full_name}.{field_info.name}" + doc_info = self.docs.get(field_doc_key) + + # Add documentation comment if available + if doc_info and doc_info.summary: + # Add docstring comment above the field annotation + lines.append(f" # {doc_info.summary}") + if field_info.is_static: lines.append(f" {field_name}: {field_info.type_str}") else: From 164fa935927551c793bb1767e8e778a3c1786b3a Mon Sep 17 00:00:00 2001 From: lcmoore Date: Sat, 2 Aug 2025 12:32:11 -0700 Subject: [PATCH 6/7] added intensity rescaling to image_to_nparray function and fast masks to __init__ --- pyesapi/__init__.py | 145 +++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 138 insertions(+), 7 deletions(-) diff --git a/pyesapi/__init__.py b/pyesapi/__init__.py index 55f9be7..0317179 100644 --- a/pyesapi/__init__.py +++ b/pyesapi/__init__.py @@ -57,15 +57,17 @@ from .stubs.VMS.TPS.Common.Model.API import * from .stubs import System - from .stubs.System import Array, Int32, Double + from .stubs.System.Collections.Generic import Dictionary # for numpy array interfacing - from .stubs.System.Runtime.InteropServices import GCHandle, GCHandleType + # from .stubs.System.Windows import Point + from .stubs.System import Array, Int32, Double + # from .stubs.System.Runtime.InteropServices import GCHandle, GCHandleType # TODO: these are missing from type stubs else: # enforce single thread apartment mode: pythoncom.CoInitialize() - + clr.AddReference('System.Windows') # clr.AddReference('System.Linq') # clr.AddReference('System.Collections') @@ -74,7 +76,7 @@ # the bad stuff import System - from System.Collections.Generic import Dictionary + from System.Collections.Generic import Dictionary # import System.Reflection # the good stuff @@ -138,6 +140,14 @@ def image_to_nparray(image_like): image_like.GetVoxels(z, _buffer) _array[:, :, z] = to_ndarray(_buffer, dtype=c_int32).reshape((image_like.XSize, image_like.YSize)) + # rescale the array data to the display value using slope and intercept + x1 = image_like.VoxelToDisplayValue(0) + x2 = image_like.VoxelToDisplayValue(1) + scale = x2 - x1 + slope = 1 / scale + intercept = -x1 / scale + _array = _array * slope + intercept + return _array @@ -166,7 +176,7 @@ def fill_in_profiles(dose_or_image, profile_fxn, row_buffer, dtype, pre_buffer=N for y in range(dose_or_image.YSize): # scan Y dimension stop = VVector.op_Addition(start_x, z_direction) - # get the profile along Z dimension + # get the profile along Z dimension if pre_buffer is None: profile_fxn(start_x, stop, row_buffer) else: @@ -203,7 +213,7 @@ def make_segment_mask_for_grid(structure, dose_or_image, sub_samples = None): mask_partials = np.zeros_like(mask, dtype=float) xRes, yRes, zRes = dose_or_image.XRes, dose_or_image.YRes, dose_or_image.ZRes - + for ix, iy, iz in zip(boundary_idx[0],boundary_idx[1],boundary_idx[2]): x = dose_or_image.Origin.x + ix * xRes @@ -295,6 +305,125 @@ def set_fluence_nparray(beam, shaped_fluence, beamlet_size_mm=2.5): fluence = Fluence(_buffer, x_origin, y_origin) beam.SetOptimalFluence(fluence) +def make_contour_mask_fast(structure_set, structure_obj, image_like, super_sample=8): + '''Generate a 3D mask from structure contours on an image-like object grid (e.g., Dose or Image). + This function uses OpenCV to efficiently create a mask from the contours of a structure set. + However, it does not exactly match the segment volume represented in Eclipse. For a more accurate representation, + use the `np_mask_like` method of the structure object. Built with the help of Google Gemini and Claude. + + Args: + structure_set (pyesapi.StructureSet): The structure set containing the contours. + structure_obj (pyesapi.Structure): The specific structure to create a mask for. + image_like (pyesapi.Image or pyesapi.Dose): The image-like object that defines the grid for the mask. + super_sample (int): The intermediate super-sampling factor to increase mask accuracy. Default is 8, where 1 means no super-sampling (but fastest). + Returns: + np.ndarray: A 3D boolean mask where True indicates the presence of the structure. + ''' + + # Import cv2 when needed for mask generation + try: + import cv2 + except ImportError: + raise ImportError("opencv-python is required for mask generation. Install with: pip install opencv-python") + + x_res = image_like.XRes + y_res = image_like.YRes + z_res = image_like.ZRes + + origin_x = image_like.Origin.x + origin_y = image_like.Origin.y + origin_z = image_like.Origin.z + + nx = image_like.XSize + ny = image_like.YSize + nz = image_like.ZSize + + total_volume_mm3 = 0 + mask_3d = np.zeros((nz, ny, nx), dtype=bool) + + all_contrours_per_source_slice = [] + + # The CT data (source) can be different from the requested mask geometry (sample), so we use the StructureSet's Image geo directly to extract contours + + # first loop over the Z slices of the structure set image and grab contours and signed areas + for source_z_idx in range(structure_set.Image.ZSize): + + contours_on_slice = structure_obj.GetContoursOnImagePlane(source_z_idx) + if len(contours_on_slice) == 0: + all_contrours_per_source_slice.append(None) # Append empty contours with zero area for each empty slice + continue + + # Calculate total SIGNED area for the current slice z to handle holes + total_signed_area_on_slice_mm2 = 0.0 + # For mask generation, collect all contour polygons on this slice + slice_polygons = [] + for contour_xyz in contours_on_slice: + if len(contour_xyz) < 3: + print(f"WARNING: Skipping contour with < 3 points on slice index {source_z_idx}") + continue + + # Extract X, Y coordinates + x = np.array([v[0] for v in contour_xyz]) + y = np.array([v[1] for v in contour_xyz]) + + # Calculate SIGNED area using Shoelace formula + signed_area = - 0.5 * (np.dot(x, np.roll(y, 1)) - np.dot(y, np.roll(x, 1))) # sign is flipped relative to this formulation (coordinate system?) + total_signed_area_on_slice_mm2 += signed_area + + # Store polygon for mask generation + slice_polygons.append((x, y, signed_area)) + + all_contrours_per_source_slice.append(slice_polygons) + + # Now, loop over the Z slices of the requested mask geometry + for sample_z_idx in range(nz): + + sample_z_position = sample_z_idx * z_res + origin_z - z_res / 2 # Center the sample slice position + + # Find the closest Z slice in the source image index space + source_z_idx = ((sample_z_position - structure_set.Image.Origin.z + structure_set.Image.ZRes/2)/structure_set.Image.ZRes + np.finfo(np.float64).tiny).astype(int) + + # Only process if this Z sample slice is within the source Z slices + if source_z_idx < structure_set.Image.ZSize and source_z_idx >= 0: + # Create mask for this slice + slice_mask = np.zeros((ny, nx), dtype=bool) + + slice_polygons_list = all_contrours_per_source_slice[source_z_idx] + if slice_polygons_list is not None: + for x, y, signed_area in slice_polygons_list: + if len(x) == 0: + continue + # Convert contour to pixel coordinates using non-isotropic resolution + contour_pixels = np.zeros((len(x), 2), dtype=np.int32) + + if super_sample > 1: + # Apply super-sampling to improve contour resolution + contour_pixels[:, 0] = np.round((x - origin_x + x_res/2) / x_res * super_sample) # x pixel coords + contour_pixels[:, 1] = np.round((y - origin_y + y_res/2) / y_res * super_sample) # y pixel coords + + # Create a temporary mask for this contour using cv2.fillPoly + temp_mask_hires = np.zeros((ny * super_sample, nx * super_sample), dtype=np.uint8) + cv2.fillPoly(temp_mask_hires, [contour_pixels], 1, lineType=cv2.LINE_8) + temp_mask = cv2.resize(temp_mask_hires, (nx, ny), interpolation=cv2.INTER_AREA) + temp_mask_bool = temp_mask.astype(bool) + else: + # Convert to pixel coordinates without super-sampling + contour_pixels[:, 0] = np.round((x - origin_x + x_res/2) / x_res).astype(np.int32) # x pixel coords + contour_pixels[:, 1] = np.round((y - origin_y + y_res/2) / y_res).astype(np.int32) # y pixel coords + # Create a temporary mask for this contour using cv2.fillPoly + temp_mask = np.zeros((ny, nx), dtype=np.uint8) + cv2.fillPoly(temp_mask, [contour_pixels], 1, lineType=cv2.LINE_8) + temp_mask_bool = temp_mask.astype(bool) + + # Add or subtract based on winding direction (signed area) + if signed_area > 0: # Positive area - add to mask + slice_mask |= temp_mask_bool + else: # Negative area - subtract from mask (hole) + slice_mask &= ~temp_mask_bool + + mask_3d[sample_z_idx] = slice_mask + + return mask_3d.T ## where the magic happens ## @@ -319,6 +448,8 @@ def set_fluence_nparray(beam, shaped_fluence, beamlet_size_mm=2.5): Beam.np_set_fluence = set_fluence_nparray +StructureSet.np_mask_for_structure_fast = make_contour_mask_fast + # fixing some pythonnet confusion def get_editable_IonBeamParameters(beam): for mi in beam.GetType().GetMethods(): @@ -354,4 +485,4 @@ def tester(pt): def check_arrays(a, b): '''array copy verification''' assert len(a) == len(b), "Arrays are different size!" - assert any(A == B for A, B in zip(a, b)), "Arrays have different values!" + assert any(A == B for A, B in zip(a, b)), "Arrays have different values!" \ No newline at end of file From 142cb642c92d5b4b88eebfb954ed78a6c660c150 Mon Sep 17 00:00:00 2001 From: lcmoore <72061542+lcmoore@users.noreply.github.com> Date: Sat, 2 Aug 2025 12:53:47 -0700 Subject: [PATCH 7/7] Fixed a reversed negative --- pyesapi/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyesapi/__init__.py b/pyesapi/__init__.py index 0317179..907a464 100644 --- a/pyesapi/__init__.py +++ b/pyesapi/__init__.py @@ -146,7 +146,7 @@ def image_to_nparray(image_like): scale = x2 - x1 slope = 1 / scale intercept = -x1 / scale - _array = _array * slope + intercept + _array = _array * slope - intercept return _array @@ -485,4 +485,4 @@ def tester(pt): def check_arrays(a, b): '''array copy verification''' assert len(a) == len(b), "Arrays are different size!" - assert any(A == B for A, B in zip(a, b)), "Arrays have different values!" \ No newline at end of file + assert any(A == B for A, B in zip(a, b)), "Arrays have different values!"